blob: 2785eace56312cb020ad92fdf7e577be4b422d31 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
4/* Copyright (C) 2018, ARM Limited, All Rights Reserved
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS (https://tls.mbed.org)
20 */
21
22#if !defined(MBEDTLS_CONFIG_FILE)
23#include "mbedtls/config.h"
24#else
25#include MBEDTLS_CONFIG_FILE
26#endif
27
28#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030029
itayzafrir7723ab12019-02-14 10:28:02 +020030#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031#include "psa/crypto.h"
32
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020036#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010038#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010039/* Include internal declarations that are useful for implementing persistently
40 * stored keys. */
41#include "psa_crypto_storage.h"
42
Gilles Peskineb46bef22019-07-30 21:32:04 +020043#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include <stdlib.h>
45#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010046#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020047#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#define mbedtls_calloc calloc
49#define mbedtls_free free
50#endif
51
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020053#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000054#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020055#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/blowfish.h"
57#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020058#include "mbedtls/chacha20.h"
59#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/cipher.h"
61#include "mbedtls/ccm.h"
62#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020065#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010067#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/error.h"
69#include "mbedtls/gcm.h"
70#include "mbedtls/md2.h"
71#include "mbedtls/md4.h"
72#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010073#include "mbedtls/md.h"
74#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010075#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010077#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000078#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010079#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010080#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010081#include "mbedtls/sha1.h"
82#include "mbedtls/sha256.h"
83#include "mbedtls/sha512.h"
84#include "mbedtls/xtea.h"
85
Gilles Peskine996deb12018-08-01 15:45:45 +020086#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
87
Gilles Peskine9ef733f2018-02-07 21:05:37 +010088/* constant-time buffer comparison */
89static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
90{
91 size_t i;
92 unsigned char diff = 0;
93
94 for( i = 0; i < n; i++ )
95 diff |= a[i] ^ b[i];
96
97 return( diff );
98}
99
100
101
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100102/****************************************************************/
103/* Global data, support functions and library management */
104/****************************************************************/
105
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200106static int key_type_is_raw_bytes( psa_key_type_t type )
107{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200108 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200109}
110
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100111/* Values for psa_global_data_t::rng_state */
112#define RNG_NOT_INITIALIZED 0
113#define RNG_INITIALIZED 1
114#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100115
Gilles Peskine2d277862018-06-18 15:41:12 +0200116typedef struct
117{
Gilles Peskine5e769522018-11-20 21:59:56 +0100118 void (* entropy_init )( mbedtls_entropy_context *ctx );
119 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120 mbedtls_entropy_context entropy;
121 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100122 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100123 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100124} psa_global_data_t;
125
126static psa_global_data_t global_data;
127
itayzafrir0adf0fc2018-09-06 16:24:41 +0300128#define GUARD_MODULE_INITIALIZED \
129 if( global_data.initialized == 0 ) \
130 return( PSA_ERROR_BAD_STATE );
131
Gilles Peskinee59236f2018-01-27 23:32:46 +0100132static psa_status_t mbedtls_to_psa_error( int ret )
133{
Gilles Peskinea5905292018-02-07 20:59:33 +0100134 /* If there's both a high-level code and low-level code, dispatch on
135 * the high-level code. */
136 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100137 {
138 case 0:
139 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100140
141 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
142 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
143 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
144 return( PSA_ERROR_NOT_SUPPORTED );
145 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
146 return( PSA_ERROR_HARDWARE_FAILURE );
147
148 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
149 return( PSA_ERROR_HARDWARE_FAILURE );
150
Gilles Peskine9a944802018-06-21 09:35:35 +0200151 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
152 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
153 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
154 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
155 case MBEDTLS_ERR_ASN1_INVALID_DATA:
156 return( PSA_ERROR_INVALID_ARGUMENT );
157 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
158 return( PSA_ERROR_INSUFFICIENT_MEMORY );
159 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
160 return( PSA_ERROR_BUFFER_TOO_SMALL );
161
Jaeden Amero93e21112019-02-20 13:57:28 +0000162#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000163 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000164#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
165 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
166#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
168 return( PSA_ERROR_NOT_SUPPORTED );
169 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
170 return( PSA_ERROR_HARDWARE_FAILURE );
171
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000173 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000174#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
175 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
178 return( PSA_ERROR_NOT_SUPPORTED );
179 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
180 return( PSA_ERROR_HARDWARE_FAILURE );
181
182 case MBEDTLS_ERR_CCM_BAD_INPUT:
183 return( PSA_ERROR_INVALID_ARGUMENT );
184 case MBEDTLS_ERR_CCM_AUTH_FAILED:
185 return( PSA_ERROR_INVALID_SIGNATURE );
186 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
187 return( PSA_ERROR_HARDWARE_FAILURE );
188
Gilles Peskine26869f22019-05-06 15:25:00 +0200189 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
190 return( PSA_ERROR_INVALID_ARGUMENT );
191
192 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
193 return( PSA_ERROR_BAD_STATE );
194 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
195 return( PSA_ERROR_INVALID_SIGNATURE );
196
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
198 return( PSA_ERROR_NOT_SUPPORTED );
199 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
200 return( PSA_ERROR_INVALID_ARGUMENT );
201 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
202 return( PSA_ERROR_INSUFFICIENT_MEMORY );
203 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
204 return( PSA_ERROR_INVALID_PADDING );
205 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
206 return( PSA_ERROR_BAD_STATE );
207 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
208 return( PSA_ERROR_INVALID_SIGNATURE );
209 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200210 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
212 return( PSA_ERROR_HARDWARE_FAILURE );
213
214 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
215 return( PSA_ERROR_HARDWARE_FAILURE );
216
217 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
218 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
219 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
220 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
223 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
224
225 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
226 return( PSA_ERROR_NOT_SUPPORTED );
227 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
228 return( PSA_ERROR_HARDWARE_FAILURE );
229
Gilles Peskinee59236f2018-01-27 23:32:46 +0100230 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
231 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
232 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
233 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100234
235 case MBEDTLS_ERR_GCM_AUTH_FAILED:
236 return( PSA_ERROR_INVALID_SIGNATURE );
237 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200238 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100239 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
240 return( PSA_ERROR_HARDWARE_FAILURE );
241
242 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
243 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
244 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
245 return( PSA_ERROR_HARDWARE_FAILURE );
246
247 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
248 return( PSA_ERROR_NOT_SUPPORTED );
249 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_MD_ALLOC_FAILED:
252 return( PSA_ERROR_INSUFFICIENT_MEMORY );
253 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
254 return( PSA_ERROR_STORAGE_FAILURE );
255 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
256 return( PSA_ERROR_HARDWARE_FAILURE );
257
Gilles Peskinef76aa772018-10-29 19:24:33 +0100258 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
259 return( PSA_ERROR_STORAGE_FAILURE );
260 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
261 return( PSA_ERROR_INVALID_ARGUMENT );
262 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
265 return( PSA_ERROR_BUFFER_TOO_SMALL );
266 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
269 return( PSA_ERROR_INVALID_ARGUMENT );
270 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
271 return( PSA_ERROR_INVALID_ARGUMENT );
272 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
274
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100275 case MBEDTLS_ERR_PK_ALLOC_FAILED:
276 return( PSA_ERROR_INSUFFICIENT_MEMORY );
277 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
278 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
279 return( PSA_ERROR_INVALID_ARGUMENT );
280 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100281 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100282 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
283 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
286 return( PSA_ERROR_NOT_SUPPORTED );
287 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
288 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
289 return( PSA_ERROR_NOT_PERMITTED );
290 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
291 return( PSA_ERROR_INVALID_ARGUMENT );
292 case MBEDTLS_ERR_PK_INVALID_ALG:
293 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
294 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
295 return( PSA_ERROR_NOT_SUPPORTED );
296 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
297 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100298 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
299 return( PSA_ERROR_HARDWARE_FAILURE );
300
Gilles Peskineff2d2002019-05-06 15:26:23 +0200301 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
302 return( PSA_ERROR_HARDWARE_FAILURE );
303 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
304 return( PSA_ERROR_NOT_SUPPORTED );
305
Gilles Peskinea5905292018-02-07 20:59:33 +0100306 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
307 return( PSA_ERROR_HARDWARE_FAILURE );
308
309 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
310 return( PSA_ERROR_INVALID_ARGUMENT );
311 case MBEDTLS_ERR_RSA_INVALID_PADDING:
312 return( PSA_ERROR_INVALID_PADDING );
313 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
314 return( PSA_ERROR_HARDWARE_FAILURE );
315 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
316 return( PSA_ERROR_INVALID_ARGUMENT );
317 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
318 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200319 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
321 return( PSA_ERROR_INVALID_SIGNATURE );
322 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
323 return( PSA_ERROR_BUFFER_TOO_SMALL );
324 case MBEDTLS_ERR_RSA_RNG_FAILED:
325 return( PSA_ERROR_INSUFFICIENT_MEMORY );
326 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
327 return( PSA_ERROR_NOT_SUPPORTED );
328 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
329 return( PSA_ERROR_HARDWARE_FAILURE );
330
331 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
332 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
333 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
334 return( PSA_ERROR_HARDWARE_FAILURE );
335
336 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
337 return( PSA_ERROR_INVALID_ARGUMENT );
338 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
339 return( PSA_ERROR_HARDWARE_FAILURE );
340
itayzafrir5c753392018-05-08 11:18:38 +0300341 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300342 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300343 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
345 return( PSA_ERROR_BUFFER_TOO_SMALL );
346 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
347 return( PSA_ERROR_NOT_SUPPORTED );
348 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
349 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
350 return( PSA_ERROR_INVALID_SIGNATURE );
351 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
352 return( PSA_ERROR_INSUFFICIENT_MEMORY );
353 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
354 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000355 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
356 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300357
Gilles Peskinee59236f2018-01-27 23:32:46 +0100358 default:
David Saadab4ecc272019-02-14 13:48:10 +0200359 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100360 }
361}
362
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200363
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200364
365
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100366/****************************************************************/
367/* Key management */
368/****************************************************************/
369
Gilles Peskine73167e12019-07-12 23:44:37 +0200370#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
371static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
372{
Gilles Peskine8e338702019-07-30 20:06:31 +0200373 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200374}
375#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
376
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100377#if defined(MBEDTLS_ECP_C)
Gilles Peskine34ef7f52018-06-18 20:47:51 +0200378static psa_ecc_curve_t mbedtls_ecc_group_to_psa( mbedtls_ecp_group_id grpid )
379{
380 switch( grpid )
381 {
382 case MBEDTLS_ECP_DP_SECP192R1:
383 return( PSA_ECC_CURVE_SECP192R1 );
384 case MBEDTLS_ECP_DP_SECP224R1:
385 return( PSA_ECC_CURVE_SECP224R1 );
386 case MBEDTLS_ECP_DP_SECP256R1:
387 return( PSA_ECC_CURVE_SECP256R1 );
388 case MBEDTLS_ECP_DP_SECP384R1:
389 return( PSA_ECC_CURVE_SECP384R1 );
390 case MBEDTLS_ECP_DP_SECP521R1:
391 return( PSA_ECC_CURVE_SECP521R1 );
392 case MBEDTLS_ECP_DP_BP256R1:
393 return( PSA_ECC_CURVE_BRAINPOOL_P256R1 );
394 case MBEDTLS_ECP_DP_BP384R1:
395 return( PSA_ECC_CURVE_BRAINPOOL_P384R1 );
396 case MBEDTLS_ECP_DP_BP512R1:
397 return( PSA_ECC_CURVE_BRAINPOOL_P512R1 );
398 case MBEDTLS_ECP_DP_CURVE25519:
399 return( PSA_ECC_CURVE_CURVE25519 );
400 case MBEDTLS_ECP_DP_SECP192K1:
401 return( PSA_ECC_CURVE_SECP192K1 );
402 case MBEDTLS_ECP_DP_SECP224K1:
403 return( PSA_ECC_CURVE_SECP224K1 );
404 case MBEDTLS_ECP_DP_SECP256K1:
405 return( PSA_ECC_CURVE_SECP256K1 );
406 case MBEDTLS_ECP_DP_CURVE448:
407 return( PSA_ECC_CURVE_CURVE448 );
408 default:
409 return( 0 );
410 }
411}
412
Gilles Peskine12313cd2018-06-20 00:20:32 +0200413static mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_curve_t curve )
414{
415 switch( curve )
416 {
417 case PSA_ECC_CURVE_SECP192R1:
418 return( MBEDTLS_ECP_DP_SECP192R1 );
419 case PSA_ECC_CURVE_SECP224R1:
420 return( MBEDTLS_ECP_DP_SECP224R1 );
421 case PSA_ECC_CURVE_SECP256R1:
422 return( MBEDTLS_ECP_DP_SECP256R1 );
423 case PSA_ECC_CURVE_SECP384R1:
424 return( MBEDTLS_ECP_DP_SECP384R1 );
425 case PSA_ECC_CURVE_SECP521R1:
426 return( MBEDTLS_ECP_DP_SECP521R1 );
427 case PSA_ECC_CURVE_BRAINPOOL_P256R1:
428 return( MBEDTLS_ECP_DP_BP256R1 );
429 case PSA_ECC_CURVE_BRAINPOOL_P384R1:
430 return( MBEDTLS_ECP_DP_BP384R1 );
431 case PSA_ECC_CURVE_BRAINPOOL_P512R1:
432 return( MBEDTLS_ECP_DP_BP512R1 );
433 case PSA_ECC_CURVE_CURVE25519:
434 return( MBEDTLS_ECP_DP_CURVE25519 );
435 case PSA_ECC_CURVE_SECP192K1:
436 return( MBEDTLS_ECP_DP_SECP192K1 );
437 case PSA_ECC_CURVE_SECP224K1:
438 return( MBEDTLS_ECP_DP_SECP224K1 );
439 case PSA_ECC_CURVE_SECP256K1:
440 return( MBEDTLS_ECP_DP_SECP256K1 );
441 case PSA_ECC_CURVE_CURVE448:
442 return( MBEDTLS_ECP_DP_CURVE448 );
443 default:
444 return( MBEDTLS_ECP_DP_NONE );
445 }
446}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100447#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200448
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200449static psa_status_t prepare_raw_data_slot( psa_key_type_t type,
450 size_t bits,
451 struct raw_data *raw )
452{
453 /* Check that the bit size is acceptable for the key type */
454 switch( type )
455 {
456 case PSA_KEY_TYPE_RAW_DATA:
457#if defined(MBEDTLS_MD_C)
458 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200459#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200460 case PSA_KEY_TYPE_DERIVE:
461 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200462#if defined(MBEDTLS_AES_C)
463 case PSA_KEY_TYPE_AES:
464 if( bits != 128 && bits != 192 && bits != 256 )
465 return( PSA_ERROR_INVALID_ARGUMENT );
466 break;
467#endif
468#if defined(MBEDTLS_CAMELLIA_C)
469 case PSA_KEY_TYPE_CAMELLIA:
470 if( bits != 128 && bits != 192 && bits != 256 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
472 break;
473#endif
474#if defined(MBEDTLS_DES_C)
475 case PSA_KEY_TYPE_DES:
476 if( bits != 64 && bits != 128 && bits != 192 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
478 break;
479#endif
480#if defined(MBEDTLS_ARC4_C)
481 case PSA_KEY_TYPE_ARC4:
482 if( bits < 8 || bits > 2048 )
483 return( PSA_ERROR_INVALID_ARGUMENT );
484 break;
485#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200486#if defined(MBEDTLS_CHACHA20_C)
487 case PSA_KEY_TYPE_CHACHA20:
488 if( bits != 256 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
490 break;
491#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200492 default:
493 return( PSA_ERROR_NOT_SUPPORTED );
494 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200495 if( bits % 8 != 0 )
496 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200497
498 /* Allocate memory for the key */
499 raw->bytes = PSA_BITS_TO_BYTES( bits );
500 raw->data = mbedtls_calloc( 1, raw->bytes );
501 if( raw->data == NULL )
502 {
503 raw->bytes = 0;
504 return( PSA_ERROR_INSUFFICIENT_MEMORY );
505 }
506 return( PSA_SUCCESS );
507}
508
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200509#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100510/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
511 * that are not a multiple of 8) well. For example, there is only
512 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
513 * way to return the exact bit size of a key.
514 * To keep things simple, reject non-byte-aligned key sizes. */
515static psa_status_t psa_check_rsa_key_byte_aligned(
516 const mbedtls_rsa_context *rsa )
517{
518 mbedtls_mpi n;
519 psa_status_t status;
520 mbedtls_mpi_init( &n );
521 status = mbedtls_to_psa_error(
522 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
523 if( status == PSA_SUCCESS )
524 {
525 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
526 status = PSA_ERROR_NOT_SUPPORTED;
527 }
528 mbedtls_mpi_free( &n );
529 return( status );
530}
531
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000532static psa_status_t psa_import_rsa_key( psa_key_type_t type,
533 const uint8_t *data,
534 size_t data_length,
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200535 mbedtls_rsa_context **p_rsa )
536{
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000537 psa_status_t status;
538 mbedtls_pk_context pk;
539 mbedtls_rsa_context *rsa;
540 size_t bits;
541
542 mbedtls_pk_init( &pk );
543
544 /* Parse the data. */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200545 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
547 mbedtls_pk_parse_key( &pk, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200548 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000549 status = mbedtls_to_psa_error(
550 mbedtls_pk_parse_public_key( &pk, data, data_length ) );
551 if( status != PSA_SUCCESS )
552 goto exit;
553
554 /* We have something that the pkparse module recognizes. If it is a
555 * valid RSA key, store it. */
556 if( mbedtls_pk_get_type( &pk ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558 status = PSA_ERROR_INVALID_ARGUMENT;
559 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200560 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000561
562 rsa = mbedtls_pk_rsa( pk );
563 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
564 * supports non-byte-aligned key sizes, but not well. For example,
565 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
566 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
567 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
568 {
569 status = PSA_ERROR_NOT_SUPPORTED;
570 goto exit;
571 }
572 status = psa_check_rsa_key_byte_aligned( rsa );
573
574exit:
575 /* Free the content of the pk object only on error. */
576 if( status != PSA_SUCCESS )
577 {
578 mbedtls_pk_free( &pk );
579 return( status );
580 }
581
582 /* On success, store the content of the object in the RSA context. */
583 *p_rsa = rsa;
584
585 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200586}
587#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
588
Jaeden Ameroccdce902019-01-10 11:42:27 +0000589#if defined(MBEDTLS_ECP_C)
Gilles Peskine4cd32772019-12-02 20:49:42 +0100590static psa_status_t psa_prepare_import_ec_key( psa_ecc_curve_t curve,
591 mbedtls_ecp_keypair **p_ecp )
592{
593 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
594 *p_ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
595 if( *p_ecp == NULL )
596 return( PSA_ERROR_INSUFFICIENT_MEMORY );
597 mbedtls_ecp_keypair_init( *p_ecp );
598
599 /* Load the group. */
600 grp_id = mbedtls_ecc_group_of_psa( curve );
601 return( mbedtls_to_psa_error(
602 mbedtls_ecp_group_load( &( *p_ecp )->grp, grp_id ) ) );
603}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000604
605/* Import a public key given as the uncompressed representation defined by SEC1
606 * 2.3.3 as the content of an ECPoint. */
607static psa_status_t psa_import_ec_public_key( psa_ecc_curve_t curve,
608 const uint8_t *data,
609 size_t data_length,
610 mbedtls_ecp_keypair **p_ecp )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200611{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000613 mbedtls_ecp_keypair *ecp = NULL;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000614
Gilles Peskine4cd32772019-12-02 20:49:42 +0100615 status = psa_prepare_import_ec_key( curve, &ecp );
Jaeden Ameroccdce902019-01-10 11:42:27 +0000616 if( status != PSA_SUCCESS )
617 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100618
Jaeden Ameroccdce902019-01-10 11:42:27 +0000619 /* Load the public value. */
620 status = mbedtls_to_psa_error(
621 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
622 data, data_length ) );
623 if( status != PSA_SUCCESS )
624 goto exit;
625
626 /* Check that the point is on the curve. */
627 status = mbedtls_to_psa_error(
628 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
629 if( status != PSA_SUCCESS )
630 goto exit;
631
632 *p_ecp = ecp;
633 return( PSA_SUCCESS );
634
635exit:
636 if( ecp != NULL )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200637 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000638 mbedtls_ecp_keypair_free( ecp );
639 mbedtls_free( ecp );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200640 }
Jaeden Ameroccdce902019-01-10 11:42:27 +0000641 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200642}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200643
Gilles Peskinef76aa772018-10-29 19:24:33 +0100644/* Import a private key given as a byte string which is the private value
645 * in big-endian order. */
646static psa_status_t psa_import_ec_private_key( psa_ecc_curve_t curve,
647 const uint8_t *data,
648 size_t data_length,
649 mbedtls_ecp_keypair **p_ecp )
650{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100652 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100653
Gilles Peskine2c86ebc2019-05-13 14:21:57 +0200654 if( PSA_BITS_TO_BYTES( PSA_ECC_CURVE_BITS( curve ) ) != data_length )
655 return( PSA_ERROR_INVALID_ARGUMENT );
656
Gilles Peskine4cd32772019-12-02 20:49:42 +0100657 status = psa_prepare_import_ec_key( curve, &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100658 if( status != PSA_SUCCESS )
659 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100660
Gilles Peskinef76aa772018-10-29 19:24:33 +0100661 /* Load the secret value. */
662 status = mbedtls_to_psa_error(
663 mbedtls_mpi_read_binary( &ecp->d, data, data_length ) );
664 if( status != PSA_SUCCESS )
665 goto exit;
666 /* Validate the private key. */
667 status = mbedtls_to_psa_error(
668 mbedtls_ecp_check_privkey( &ecp->grp, &ecp->d ) );
669 if( status != PSA_SUCCESS )
670 goto exit;
671 /* Calculate the public key from the private key. */
672 status = mbedtls_to_psa_error(
673 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
674 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
675 if( status != PSA_SUCCESS )
676 goto exit;
677
678 *p_ecp = ecp;
679 return( PSA_SUCCESS );
680
681exit:
682 if( ecp != NULL )
683 {
684 mbedtls_ecp_keypair_free( ecp );
685 mbedtls_free( ecp );
686 }
687 return( status );
688}
689#endif /* defined(MBEDTLS_ECP_C) */
690
Gilles Peskineb46bef22019-07-30 21:32:04 +0200691
692/** Return the size of the key in the given slot, in bits.
693 *
694 * \param[in] slot A key slot.
695 *
696 * \return The key size in bits, read from the metadata in the slot.
697 */
698static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
699{
700 return( slot->attr.bits );
701}
702
703/** Calculate the size of the key in the given slot, in bits.
704 *
705 * \param[in] slot A key slot containing a transparent key.
706 *
707 * \return The key size in bits, calculated from the key data.
708 */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200709static psa_key_bits_t psa_calculate_key_bits( const psa_key_slot_t *slot )
Gilles Peskineb46bef22019-07-30 21:32:04 +0200710{
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200711 size_t bits = 0; /* return 0 on an empty slot */
712
Gilles Peskineb46bef22019-07-30 21:32:04 +0200713 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200714 bits = PSA_BYTES_TO_BITS( slot->data.raw.bytes );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200715#if defined(MBEDTLS_RSA_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200716 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
717 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200718#endif /* defined(MBEDTLS_RSA_C) */
719#if defined(MBEDTLS_ECP_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200720 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
721 bits = slot->data.ecp->grp.pbits;
Gilles Peskineb46bef22019-07-30 21:32:04 +0200722#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200723
724 /* We know that the size fits in psa_key_bits_t thanks to checks
725 * when the key was created. */
726 return( (psa_key_bits_t) bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200727}
728
Gilles Peskine8e338702019-07-30 20:06:31 +0200729/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100730 * previously. This function assumes that the slot does not contain
731 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100732psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
733 const uint8_t *data,
734 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100735{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200736 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100737
Gilles Peskine8e338702019-07-30 20:06:31 +0200738 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100739 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200740 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200741 /* Ensure that the bytes-to-bit conversion didn't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100742 if( data_length > SIZE_MAX / 8 )
743 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200744 /* Enforce a size limit, and in particular ensure that the bit
745 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200746 if( bit_size > PSA_MAX_KEY_BITS )
747 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine8e338702019-07-30 20:06:31 +0200748 status = prepare_raw_data_slot( slot->attr.type, bit_size,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200749 &slot->data.raw );
750 if( status != PSA_SUCCESS )
751 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200752 if( data_length != 0 )
753 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100754 }
755 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100756#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200757 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100758 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200759 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100760 data, data_length,
761 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100762 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200763 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100764 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000765 status = psa_import_ec_public_key(
Gilles Peskine8e338702019-07-30 20:06:31 +0200766 PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Jaeden Ameroccdce902019-01-10 11:42:27 +0000767 data, data_length,
768 &slot->data.ecp );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100769 }
770 else
Gilles Peskine969ac722018-01-28 18:16:59 +0100771#endif /* MBEDTLS_ECP_C */
Jaeden Ameroccdce902019-01-10 11:42:27 +0000772#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200773 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100774 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200775 status = psa_import_rsa_key( slot->attr.type,
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000776 data, data_length,
777 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100778 }
779 else
Jaeden Ameroccdce902019-01-10 11:42:27 +0000780#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100781 {
782 return( PSA_ERROR_NOT_SUPPORTED );
783 }
Darryl Green940d72c2018-07-13 13:18:51 +0100784
Gilles Peskineb46bef22019-07-30 21:32:04 +0200785 if( status == PSA_SUCCESS )
786 {
787 /* Write the actual key size to the slot.
788 * psa_start_key_creation() wrote the size declared by the
789 * caller, which may be 0 (meaning unspecified) or wrong. */
790 slot->attr.bits = psa_calculate_key_bits( slot );
791 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100792 return( status );
793}
794
Gilles Peskinef603c712019-01-19 13:40:11 +0100795/** Calculate the intersection of two algorithm usage policies.
796 *
797 * Return 0 (which allows no operation) on incompatibility.
798 */
799static psa_algorithm_t psa_key_policy_algorithm_intersection(
800 psa_algorithm_t alg1,
801 psa_algorithm_t alg2 )
802{
Gilles Peskine549ea862019-05-22 11:45:59 +0200803 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100804 if( alg1 == alg2 )
805 return( alg1 );
806 /* If the policies are from the same hash-and-sign family, check
807 * if one is a wildcard. If so the other has the specific algorithm. */
808 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
809 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
810 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
811 {
812 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
813 return( alg2 );
814 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
815 return( alg1 );
816 }
817 /* If the policies are incompatible, allow nothing. */
818 return( 0 );
819}
820
Gilles Peskined6f371b2019-05-10 19:33:38 +0200821static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
822 psa_algorithm_t requested_alg )
823{
Gilles Peskine549ea862019-05-22 11:45:59 +0200824 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200825 if( requested_alg == policy_alg )
826 return( 1 );
827 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200828 * and requested_alg is the same hash-and-sign family with any hash,
829 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200830 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
831 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
832 {
833 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
834 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
835 }
836 /* If it isn't permitted, it's forbidden. */
837 return( 0 );
838}
839
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100840/** Test whether a policy permits an algorithm.
841 *
842 * The caller must test usage flags separately.
843 */
844static int psa_key_policy_permits( const psa_key_policy_t *policy,
845 psa_algorithm_t alg )
846{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200847 return( psa_key_algorithm_permits( policy->alg, alg ) ||
848 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100849}
850
Gilles Peskinef603c712019-01-19 13:40:11 +0100851/** Restrict a key policy based on a constraint.
852 *
853 * \param[in,out] policy The policy to restrict.
854 * \param[in] constraint The policy constraint to apply.
855 *
856 * \retval #PSA_SUCCESS
857 * \c *policy contains the intersection of the original value of
858 * \c *policy and \c *constraint.
859 * \retval #PSA_ERROR_INVALID_ARGUMENT
860 * \c *policy and \c *constraint are incompatible.
861 * \c *policy is unchanged.
862 */
863static psa_status_t psa_restrict_key_policy(
864 psa_key_policy_t *policy,
865 const psa_key_policy_t *constraint )
866{
867 psa_algorithm_t intersection_alg =
868 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200869 psa_algorithm_t intersection_alg2 =
870 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100871 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
872 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200873 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
874 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 policy->usage &= constraint->usage;
876 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200877 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100878 return( PSA_SUCCESS );
879}
880
Darryl Green06fd18d2018-07-16 11:21:11 +0100881/** Retrieve a slot which must contain a key. The key must have allow all the
882 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
883 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100884static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100885 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100886 psa_key_usage_t usage,
887 psa_algorithm_t alg )
888{
889 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100890 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100891
892 *p_slot = NULL;
893
Gilles Peskinec5487a82018-12-03 18:08:14 +0100894 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100895 if( status != PSA_SUCCESS )
896 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100897
898 /* Enforce that usage policy for the key slot contains all the flags
899 * required by the usage parameter. There is one exception: public
900 * keys can always be exported, so we treat public key objects as
901 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200902 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100903 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +0200904 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +0100905 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100906
907 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200908 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100909 return( PSA_ERROR_NOT_PERMITTED );
910
911 *p_slot = slot;
912 return( PSA_SUCCESS );
913}
Darryl Green940d72c2018-07-13 13:18:51 +0100914
Gilles Peskine28f8f302019-07-24 13:30:31 +0200915/** Retrieve a slot which must contain a transparent key.
916 *
917 * A transparent key is a key for which the key material is directly
918 * available, as opposed to a key in a secure element.
919 *
Gilles Peskine60450a42019-07-25 11:32:45 +0200920 * This is a temporary function to use instead of psa_get_key_from_slot()
921 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200922 */
923#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
924static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
925 psa_key_slot_t **p_slot,
926 psa_key_usage_t usage,
927 psa_algorithm_t alg )
928{
929 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
930 if( status != PSA_SUCCESS )
931 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +0200932 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200933 {
934 *p_slot = NULL;
935 return( PSA_ERROR_NOT_SUPPORTED );
936 }
937 return( PSA_SUCCESS );
938}
939#else /* MBEDTLS_PSA_CRYPTO_SE_C */
940/* With no secure element support, all keys are transparent. */
941#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
942 psa_get_key_from_slot( handle, p_slot, usage, alg )
943#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
944
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100945/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100946static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000947{
Gilles Peskine73167e12019-07-12 23:44:37 +0200948#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
949 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000950 {
951 /* No key material to clean. */
952 }
Gilles Peskine73167e12019-07-12 23:44:37 +0200953 else
954#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine8e338702019-07-30 20:06:31 +0200955 if( slot->attr.type == PSA_KEY_TYPE_NONE )
Darryl Green40225ba2018-11-15 14:48:15 +0000956 {
957 /* No key material to clean. */
958 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200959 else if( key_type_is_raw_bytes( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000960 {
961 mbedtls_free( slot->data.raw.data );
962 }
963 else
964#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200965 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000966 {
967 mbedtls_rsa_free( slot->data.rsa );
968 mbedtls_free( slot->data.rsa );
969 }
970 else
971#endif /* defined(MBEDTLS_RSA_C) */
972#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200973 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000974 {
975 mbedtls_ecp_keypair_free( slot->data.ecp );
976 mbedtls_free( slot->data.ecp );
977 }
978 else
979#endif /* defined(MBEDTLS_ECP_C) */
980 {
981 /* Shouldn't happen: the key type is not any type that we
982 * put in. */
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200983 return( PSA_ERROR_CORRUPTION_DETECTED );
Darryl Green40225ba2018-11-15 14:48:15 +0000984 }
985
986 return( PSA_SUCCESS );
987}
988
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100989/** Completely wipe a slot in memory, including its policy.
990 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100991psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100992{
993 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200994 /* Multipart operations may still be using the key. This is safe
995 * because all multipart operation objects are independent from
996 * the key slot: if they need to access the key after the setup
997 * phase, they have a copy of the key. Note that this means that
998 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100999 /* At this point, key material and other type-specific content has
1000 * been wiped. Clear remaining metadata. We can call memset and not
1001 * zeroize because the metadata is not particularly sensitive. */
1002 memset( slot, 0, sizeof( *slot ) );
1003 return( status );
1004}
1005
Gilles Peskinec5487a82018-12-03 18:08:14 +01001006psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001007{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001008 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001009 psa_status_t status; /* status of the last operation */
1010 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001011#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1012 psa_se_drv_table_entry_t *driver;
1013#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001014
Gilles Peskine1841cf42019-10-08 15:48:25 +02001015 if( handle == 0 )
1016 return( PSA_SUCCESS );
1017
Gilles Peskinec5487a82018-12-03 18:08:14 +01001018 status = psa_get_key_slot( handle, &slot );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001019 if( status != PSA_SUCCESS )
1020 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001021
1022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001023 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001024 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001025 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001026 /* For a key in a secure element, we need to do three things:
1027 * remove the key file in internal storage, destroy the
1028 * key inside the secure element, and update the driver's
1029 * persistent data. Start a transaction that will encompass these
1030 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001031 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001032 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001033 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001034 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001035 status = psa_crypto_save_transaction( );
1036 if( status != PSA_SUCCESS )
1037 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001038 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001039 /* We should still try to destroy the key in the secure
1040 * element and the key metadata in storage. This is especially
1041 * important if the error is that the storage is full.
1042 * But how to do it exactly without risking an inconsistent
1043 * state after a reset?
1044 * https://github.com/ARMmbed/mbed-crypto/issues/215
1045 */
1046 overall_status = status;
1047 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001048 }
1049
Gilles Peskine354f7672019-07-12 23:46:38 +02001050 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001051 if( overall_status == PSA_SUCCESS )
1052 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001053 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001054#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1055
Darryl Greend49a4992018-06-18 17:27:26 +01001056#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001057 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001058 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001059 status = psa_destroy_persistent_key( slot->attr.id );
1060 if( overall_status == PSA_SUCCESS )
1061 overall_status = status;
1062
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001063 /* TODO: other slots may have a copy of the same key. We should
1064 * invalidate them.
1065 * https://github.com/ARMmbed/mbed-crypto/issues/214
1066 */
Darryl Greend49a4992018-06-18 17:27:26 +01001067 }
1068#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001069
Gilles Peskinefc762652019-07-22 19:30:34 +02001070#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1071 if( driver != NULL )
1072 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001073 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001074 if( overall_status == PSA_SUCCESS )
1075 overall_status = status;
1076 status = psa_crypto_stop_transaction( );
1077 if( overall_status == PSA_SUCCESS )
1078 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001079 }
1080#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1081
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001082#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1083exit:
1084#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001085 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001086 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1087 if( overall_status == PSA_SUCCESS )
1088 overall_status = status;
1089 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001090}
1091
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001092void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001093{
Gilles Peskineb699f072019-04-26 16:06:02 +02001094 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001095 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001096}
1097
Gilles Peskineb699f072019-04-26 16:06:02 +02001098psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1099 psa_key_type_t type,
1100 const uint8_t *data,
1101 size_t data_length )
1102{
1103 uint8_t *copy = NULL;
1104
1105 if( data_length != 0 )
1106 {
1107 copy = mbedtls_calloc( 1, data_length );
1108 if( copy == NULL )
1109 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1110 memcpy( copy, data, data_length );
1111 }
1112 /* After this point, this function is guaranteed to succeed, so it
1113 * can start modifying `*attributes`. */
1114
1115 if( attributes->domain_parameters != NULL )
1116 {
1117 mbedtls_free( attributes->domain_parameters );
1118 attributes->domain_parameters = NULL;
1119 attributes->domain_parameters_size = 0;
1120 }
1121
1122 attributes->domain_parameters = copy;
1123 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001124 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001125 return( PSA_SUCCESS );
1126}
1127
1128psa_status_t psa_get_key_domain_parameters(
1129 const psa_key_attributes_t *attributes,
1130 uint8_t *data, size_t data_size, size_t *data_length )
1131{
1132 if( attributes->domain_parameters_size > data_size )
1133 return( PSA_ERROR_BUFFER_TOO_SMALL );
1134 *data_length = attributes->domain_parameters_size;
1135 if( attributes->domain_parameters_size != 0 )
1136 memcpy( data, attributes->domain_parameters,
1137 attributes->domain_parameters_size );
1138 return( PSA_SUCCESS );
1139}
1140
1141#if defined(MBEDTLS_RSA_C)
1142static psa_status_t psa_get_rsa_public_exponent(
1143 const mbedtls_rsa_context *rsa,
1144 psa_key_attributes_t *attributes )
1145{
1146 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001148 uint8_t *buffer = NULL;
1149 size_t buflen;
1150 mbedtls_mpi_init( &mpi );
1151
1152 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1153 if( ret != 0 )
1154 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001155 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1156 {
1157 /* It's the default value, which is reported as an empty string,
1158 * so there's nothing to do. */
1159 goto exit;
1160 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001161
1162 buflen = mbedtls_mpi_size( &mpi );
1163 buffer = mbedtls_calloc( 1, buflen );
1164 if( buffer == NULL )
1165 {
1166 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1167 goto exit;
1168 }
1169 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1170 if( ret != 0 )
1171 goto exit;
1172 attributes->domain_parameters = buffer;
1173 attributes->domain_parameters_size = buflen;
1174
1175exit:
1176 mbedtls_mpi_free( &mpi );
1177 if( ret != 0 )
1178 mbedtls_free( buffer );
1179 return( mbedtls_to_psa_error( ret ) );
1180}
1181#endif /* MBEDTLS_RSA_C */
1182
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001183/** Retrieve all the publicly-accessible attributes of a key.
1184 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001185psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1186 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001187{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001188 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001189 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001190
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001191 psa_reset_key_attributes( attributes );
1192
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001193 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001194 if( status != PSA_SUCCESS )
1195 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001196
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001197 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001198 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1199 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1200
1201#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1202 if( psa_key_slot_is_external( slot ) )
1203 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1204#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001205
Gilles Peskine8e338702019-07-30 20:06:31 +02001206 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001207 {
1208#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001209 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001210 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001211#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001212 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001213 * is not yet implemented.
1214 * https://github.com/ARMmbed/mbed-crypto/issues/216
1215 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001216 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001217 break;
1218#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001219 status = psa_get_rsa_public_exponent( slot->data.rsa, attributes );
1220 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001221#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001222 default:
1223 /* Nothing else to do. */
1224 break;
1225 }
1226
1227 if( status != PSA_SUCCESS )
1228 psa_reset_key_attributes( attributes );
1229 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001230}
1231
Gilles Peskinec8000c02019-08-02 20:15:51 +02001232#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1233psa_status_t psa_get_key_slot_number(
1234 const psa_key_attributes_t *attributes,
1235 psa_key_slot_number_t *slot_number )
1236{
1237 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1238 {
1239 *slot_number = attributes->slot_number;
1240 return( PSA_SUCCESS );
1241 }
1242 else
1243 return( PSA_ERROR_INVALID_ARGUMENT );
1244}
1245#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1246
Jaeden Ameroccdce902019-01-10 11:42:27 +00001247#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero25384a22019-01-10 10:23:21 +00001248static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1249 unsigned char *buf, size_t size )
1250{
Janos Follath24eed8d2019-11-22 13:21:35 +00001251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero25384a22019-01-10 10:23:21 +00001252 unsigned char *c;
1253 size_t len = 0;
1254
1255 c = buf + size;
1256
1257 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1258
1259 return( (int) len );
1260}
Jaeden Ameroccdce902019-01-10 11:42:27 +00001261#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero25384a22019-01-10 10:23:21 +00001262
Gilles Peskinef603c712019-01-19 13:40:11 +01001263static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1264 uint8_t *data,
1265 size_t data_size,
1266 size_t *data_length,
1267 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001268{
Gilles Peskine5d309672019-07-12 23:47:28 +02001269#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1270 const psa_drv_se_t *drv;
1271 psa_drv_se_context_t *drv_context;
1272#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1273
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001274 *data_length = 0;
1275
Gilles Peskine8e338702019-07-30 20:06:31 +02001276 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001277 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001278
Gilles Peskinef9168942019-09-12 19:20:29 +02001279 /* Reject a zero-length output buffer now, since this can never be a
1280 * valid key representation. This way we know that data must be a valid
1281 * pointer and we can do things like memset(data, ..., data_size). */
1282 if( data_size == 0 )
1283 return( PSA_ERROR_BUFFER_TOO_SMALL );
1284
Gilles Peskine5d309672019-07-12 23:47:28 +02001285#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001286 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001287 {
1288 psa_drv_se_export_key_t method;
1289 if( drv->key_management == NULL )
1290 return( PSA_ERROR_NOT_SUPPORTED );
1291 method = ( export_public_key ?
1292 drv->key_management->p_export_public :
1293 drv->key_management->p_export );
1294 if( method == NULL )
1295 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001296 return( method( drv_context,
1297 slot->data.se.slot_number,
1298 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001299 }
1300#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1301
Gilles Peskine8e338702019-07-30 20:06:31 +02001302 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001303 {
1304 if( slot->data.raw.bytes > data_size )
1305 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinef9168942019-09-12 19:20:29 +02001306 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
1307 memset( data + slot->data.raw.bytes, 0,
1308 data_size - slot->data.raw.bytes );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001309 *data_length = slot->data.raw.bytes;
1310 return( PSA_SUCCESS );
1311 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001312#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001313 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) && !export_public_key )
Gilles Peskine188c71e2018-10-29 19:26:02 +01001314 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001315 psa_status_t status;
1316
Gilles Peskineb46bef22019-07-30 21:32:04 +02001317 size_t bytes = PSA_BITS_TO_BYTES( slot->attr.bits );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001318 if( bytes > data_size )
1319 return( PSA_ERROR_BUFFER_TOO_SMALL );
1320 status = mbedtls_to_psa_error(
1321 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1322 if( status != PSA_SUCCESS )
1323 return( status );
1324 memset( data + bytes, 0, data_size - bytes );
1325 *data_length = bytes;
1326 return( PSA_SUCCESS );
1327 }
1328#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001329 else
Moran Peker17e36e12018-05-02 12:55:20 +03001330 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001331#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001332 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1333 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001334 {
Moran Pekera998bc62018-04-16 18:16:20 +03001335 mbedtls_pk_context pk;
Janos Follath24eed8d2019-11-22 13:21:35 +00001336 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine8e338702019-07-30 20:06:31 +02001337 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001338 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001339#if defined(MBEDTLS_RSA_C)
1340 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001341 pk.pk_info = &mbedtls_rsa_info;
1342 pk.pk_ctx = slot->data.rsa;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001343#else
1344 return( PSA_ERROR_NOT_SUPPORTED );
1345#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001346 }
1347 else
1348 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001349#if defined(MBEDTLS_ECP_C)
1350 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001351 pk.pk_info = &mbedtls_eckey_info;
1352 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001353#else
1354 return( PSA_ERROR_NOT_SUPPORTED );
1355#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001356 }
Gilles Peskine8e338702019-07-30 20:06:31 +02001357 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero25384a22019-01-10 10:23:21 +00001358 {
Jaeden Ameroccdce902019-01-10 11:42:27 +00001359 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001360 }
Moran Peker17e36e12018-05-02 12:55:20 +03001361 else
Jaeden Amero25384a22019-01-10 10:23:21 +00001362 {
Moran Peker17e36e12018-05-02 12:55:20 +03001363 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001364 }
Moran Peker60364322018-04-29 11:34:58 +03001365 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001366 {
Gilles Peskinef9168942019-09-12 19:20:29 +02001367 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001368 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001369 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001370 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1371 * Move the data to the beginning and erase remaining data
1372 * at the original location. */
1373 if( 2 * (size_t) ret <= data_size )
1374 {
1375 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001376 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001377 }
1378 else if( (size_t) ret < data_size )
1379 {
1380 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001381 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001382 }
Moran Pekera998bc62018-04-16 18:16:20 +03001383 *data_length = ret;
1384 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001385 }
1386 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001387#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001388 {
1389 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001390 it is valid for a special-purpose implementation to omit
1391 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001392 return( PSA_ERROR_NOT_SUPPORTED );
1393 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001394 }
1395}
1396
Gilles Peskinec5487a82018-12-03 18:08:14 +01001397psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001398 uint8_t *data,
1399 size_t data_size,
1400 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001401{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001402 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001403 psa_status_t status;
1404
1405 /* Set the key to empty now, so that even when there are errors, we always
1406 * set data_length to a value between 0 and data_size. On error, setting
1407 * the key to empty is a good choice because an empty key representation is
1408 * unlikely to be accepted anywhere. */
1409 *data_length = 0;
1410
1411 /* Export requires the EXPORT flag. There is an exception for public keys,
1412 * which don't require any flag, but psa_get_key_from_slot takes
1413 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001414 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001415 if( status != PSA_SUCCESS )
1416 return( status );
1417 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001418 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001419}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001420
Gilles Peskinec5487a82018-12-03 18:08:14 +01001421psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001422 uint8_t *data,
1423 size_t data_size,
1424 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001425{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001426 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001427 psa_status_t status;
1428
1429 /* Set the key to empty now, so that even when there are errors, we always
1430 * set data_length to a value between 0 and data_size. On error, setting
1431 * the key to empty is a good choice because an empty key representation is
1432 * unlikely to be accepted anywhere. */
1433 *data_length = 0;
1434
1435 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001436 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001437 if( status != PSA_SUCCESS )
1438 return( status );
1439 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001440 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001441}
1442
Gilles Peskine91e8c332019-08-02 19:19:39 +02001443#if defined(static_assert)
1444static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1445 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001446static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001447 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001448static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001449 "One or more key attribute flag is listed as both internal-only and external-only" );
1450#endif
1451
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001452/** Validate that a key policy is internally well-formed.
1453 *
1454 * This function only rejects invalid policies. It does not validate the
1455 * consistency of the policy with respect to other attributes of the key
1456 * such as the key type.
1457 */
1458static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001459{
1460 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001461 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001462 PSA_KEY_USAGE_ENCRYPT |
1463 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001464 PSA_KEY_USAGE_SIGN_HASH |
1465 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001466 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1467 return( PSA_ERROR_INVALID_ARGUMENT );
1468
Gilles Peskine4747d192019-04-17 15:05:45 +02001469 return( PSA_SUCCESS );
1470}
1471
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001472/** Validate the internal consistency of key attributes.
1473 *
1474 * This function only rejects invalid attribute values. If does not
1475 * validate the consistency of the attributes with any key data that may
1476 * be involved in the creation of the key.
1477 *
1478 * Call this function early in the key creation process.
1479 *
1480 * \param[in] attributes Key attributes for the new key.
1481 * \param[out] p_drv On any return, the driver for the key, if any.
1482 * NULL for a transparent key.
1483 *
1484 */
1485static psa_status_t psa_validate_key_attributes(
1486 const psa_key_attributes_t *attributes,
1487 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001488{
1489 psa_status_t status;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001490
1491 if( attributes->core.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Green0c6575a2018-11-07 16:05:30 +00001492 {
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001493 status = psa_validate_persistent_key_parameters(
1494 attributes->core.lifetime, attributes->core.id,
1495 p_drv, 1 );
1496 if( status != PSA_SUCCESS )
1497 return( status );
Darryl Green0c6575a2018-11-07 16:05:30 +00001498 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001499
1500 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001501 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001502 return( status );
1503
1504 /* Refuse to create overly large keys.
1505 * Note that this doesn't trigger on import if the attributes don't
1506 * explicitly specify a size (so psa_get_key_bits returns 0), so
1507 * psa_import_key() needs its own checks. */
1508 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1509 return( PSA_ERROR_NOT_SUPPORTED );
1510
Gilles Peskine91e8c332019-08-02 19:19:39 +02001511 /* Reject invalid flags. These should not be reachable through the API. */
1512 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1513 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1514 return( PSA_ERROR_INVALID_ARGUMENT );
1515
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001516 return( PSA_SUCCESS );
1517}
1518
Gilles Peskine4747d192019-04-17 15:05:45 +02001519/** Prepare a key slot to receive key material.
1520 *
1521 * This function allocates a key slot and sets its metadata.
1522 *
1523 * If this function fails, call psa_fail_key_creation().
1524 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001525 * This function is intended to be used as follows:
1526 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1527 * it with the specified attributes, and assign it a handle.
1528 * -# Populate the slot with the key material.
1529 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1530 * In case of failure at any step, stop the sequence and call
1531 * psa_fail_key_creation().
1532 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001533 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001534 * \param[in] attributes Key attributes for the new key.
1535 * \param[out] handle On success, a handle for the allocated slot.
1536 * \param[out] p_slot On success, a pointer to the prepared slot.
1537 * \param[out] p_drv On any return, the driver for the key, if any.
1538 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001539 *
1540 * \retval #PSA_SUCCESS
1541 * The key slot is ready to receive key material.
1542 * \return If this function fails, the key slot is an invalid state.
1543 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001544 */
1545static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001546 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001547 const psa_key_attributes_t *attributes,
1548 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001549 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001550 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001551{
1552 psa_status_t status;
1553 psa_key_slot_t *slot;
1554
Gilles Peskinedf179142019-07-15 22:02:14 +02001555 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001556 *p_drv = NULL;
1557
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001558 status = psa_validate_key_attributes( attributes, p_drv );
1559 if( status != PSA_SUCCESS )
1560 return( status );
1561
Gilles Peskineedbed562019-08-07 18:19:59 +02001562 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001563 if( status != PSA_SUCCESS )
1564 return( status );
1565 slot = *p_slot;
1566
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001567 /* We're storing the declared bit-size of the key. It's up to each
1568 * creation mechanism to verify that this information is correct.
1569 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001570 * an input (generate, device) but not for those where the bit-size
1571 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001572
1573 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001574
Gilles Peskine91e8c332019-08-02 19:19:39 +02001575 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001576 * external-only flags, query `attributes`. Thanks to the check
1577 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001578 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001579 * may have set. */
1580 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001581
Gilles Peskinecbaff462019-07-12 23:46:04 +02001582#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001583 /* For a key in a secure element, we need to do three things
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001584 * when creating or registering a key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001585 * create the key file in internal storage, create the
1586 * key inside the secure element, and update the driver's
1587 * persistent data. Start a transaction that will encompass these
1588 * three actions. */
1589 /* The first thing to do is to find a slot number for the new key.
1590 * We save the slot number in persistent storage as part of the
1591 * transaction data. It will be needed to recover if the power
1592 * fails during the key creation process, to clean up on the secure
1593 * element side after restarting. Obtaining a slot number from the
1594 * secure element driver updates its persistent state, but we do not yet
1595 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001596 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001597 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001598 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001599 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001600 &slot->data.se.slot_number );
1601 if( status != PSA_SUCCESS )
1602 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001603 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001604 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001605 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001606 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001607 status = psa_crypto_save_transaction( );
1608 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001609 {
1610 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001611 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001612 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001613 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001614
1615 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1616 {
1617 /* Key registration only makes sense with a secure element. */
1618 return( PSA_ERROR_INVALID_ARGUMENT );
1619 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001620#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1621
Darryl Green0c6575a2018-11-07 16:05:30 +00001622 return( status );
1623}
Gilles Peskine4747d192019-04-17 15:05:45 +02001624
1625/** Finalize the creation of a key once its key material has been set.
1626 *
1627 * This entails writing the key to persistent storage.
1628 *
1629 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001630 * See the documentation of psa_start_key_creation() for the intended use
1631 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001632 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001633 * \param[in,out] slot Pointer to the slot with key material.
1634 * \param[in] driver The secure element driver for the key,
1635 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001636 *
1637 * \retval #PSA_SUCCESS
1638 * The key was successfully created. The handle is now valid.
1639 * \return If this function fails, the key slot is an invalid state.
1640 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001641 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001642static psa_status_t psa_finish_key_creation(
1643 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001644 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001645{
1646 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001647 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001648 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001649
1650#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001651 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001652 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001653#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1654 if( driver != NULL )
1655 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001656 psa_se_key_data_storage_t data;
1657#if defined(static_assert)
1658 static_assert( sizeof( slot->data.se.slot_number ) ==
1659 sizeof( data.slot_number ),
1660 "Slot number size does not match psa_se_key_data_storage_t" );
1661 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1662 "Bit-size size does not match psa_se_key_data_storage_t" );
1663#endif
1664 memcpy( &data.slot_number, &slot->data.se.slot_number,
1665 sizeof( slot->data.se.slot_number ) );
1666 memcpy( &data.bits, &slot->attr.bits,
1667 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001668 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001669 (uint8_t*) &data,
1670 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001671 }
1672 else
1673#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1674 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001675 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001676 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001677 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001678 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1679 size_t length = 0;
Gilles Peskinef9168942019-09-12 19:20:29 +02001680 if( buffer == NULL )
Gilles Peskine1df83d42019-07-23 16:13:14 +02001681 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1682 status = psa_internal_export_key( slot,
1683 buffer, buffer_size, &length,
1684 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001685 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001686 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001687 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001688
Gilles Peskinef9168942019-09-12 19:20:29 +02001689 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001690 mbedtls_free( buffer );
1691 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001692 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001693#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1694
Gilles Peskinecbaff462019-07-12 23:46:04 +02001695#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001696 /* Finish the transaction for a key creation. This does not
1697 * happen when registering an existing key. Detect this case
1698 * by checking whether a transaction is in progress (actual
1699 * creation of a key in a secure element requires a transaction,
1700 * but registration doesn't use one). */
1701 if( driver != NULL &&
1702 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001703 {
1704 status = psa_save_se_persistent_data( driver );
1705 if( status != PSA_SUCCESS )
1706 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001707 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001708 return( status );
1709 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001710 status = psa_crypto_stop_transaction( );
1711 if( status != PSA_SUCCESS )
1712 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001713 }
1714#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1715
Gilles Peskine4747d192019-04-17 15:05:45 +02001716 return( status );
1717}
1718
1719/** Abort the creation of a key.
1720 *
1721 * You may call this function after calling psa_start_key_creation(),
1722 * or after psa_finish_key_creation() fails. In other circumstances, this
1723 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001724 * See the documentation of psa_start_key_creation() for the intended use
1725 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001727 * \param[in,out] slot Pointer to the slot with key material.
1728 * \param[in] driver The secure element driver for the key,
1729 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001730 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001731static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001732 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001733{
Gilles Peskine011e4282019-06-26 18:34:38 +02001734 (void) driver;
1735
Gilles Peskine4747d192019-04-17 15:05:45 +02001736 if( slot == NULL )
1737 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001738
1739#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001740 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001741 * element, and the failure happened later (when saving metadata
1742 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001743 * element.
1744 * https://github.com/ARMmbed/mbed-crypto/issues/217
1745 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001746
Gilles Peskined7729582019-08-05 15:55:54 +02001747 /* Abort the ongoing transaction if any (there may not be one if
1748 * the creation process failed before starting one, or if the
1749 * key creation is a registration of a key in a secure element).
1750 * Earlier functions must already have done what it takes to undo any
1751 * partial creation. All that's left is to update the transaction data
1752 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001753 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001754#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1755
Gilles Peskine4747d192019-04-17 15:05:45 +02001756 psa_wipe_key_slot( slot );
1757}
1758
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001759/** Validate optional attributes during key creation.
1760 *
1761 * Some key attributes are optional during key creation. If they are
1762 * specified in the attributes structure, check that they are consistent
1763 * with the data in the slot.
1764 *
1765 * This function should be called near the end of key creation, after
1766 * the slot in memory is fully populated but before saving persistent data.
1767 */
1768static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001769 const psa_key_slot_t *slot,
1770 const psa_key_attributes_t *attributes )
1771{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001772 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001773 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001774 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001775 return( PSA_ERROR_INVALID_ARGUMENT );
1776 }
1777
1778 if( attributes->domain_parameters_size != 0 )
1779 {
1780#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001781 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001782 {
1783 mbedtls_mpi actual, required;
Janos Follath24eed8d2019-11-22 13:21:35 +00001784 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001785 mbedtls_mpi_init( &actual );
1786 mbedtls_mpi_init( &required );
1787 ret = mbedtls_rsa_export( slot->data.rsa,
1788 NULL, NULL, NULL, NULL, &actual );
1789 if( ret != 0 )
1790 goto rsa_exit;
1791 ret = mbedtls_mpi_read_binary( &required,
1792 attributes->domain_parameters,
1793 attributes->domain_parameters_size );
1794 if( ret != 0 )
1795 goto rsa_exit;
1796 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1797 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1798 rsa_exit:
1799 mbedtls_mpi_free( &actual );
1800 mbedtls_mpi_free( &required );
1801 if( ret != 0)
1802 return( mbedtls_to_psa_error( ret ) );
1803 }
1804 else
1805#endif
1806 {
1807 return( PSA_ERROR_INVALID_ARGUMENT );
1808 }
1809 }
1810
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001811 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001812 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001813 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001814 return( PSA_ERROR_INVALID_ARGUMENT );
1815 }
1816
1817 return( PSA_SUCCESS );
1818}
1819
Gilles Peskine4747d192019-04-17 15:05:45 +02001820psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001822 size_t data_length,
1823 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001824{
1825 psa_status_t status;
1826 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001827 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001828
Gilles Peskine0f84d622019-09-12 19:03:13 +02001829 /* Reject zero-length symmetric keys (including raw data key objects).
1830 * This also rejects any key which might be encoded as an empty string,
1831 * which is never valid. */
1832 if( data_length == 0 )
1833 return( PSA_ERROR_INVALID_ARGUMENT );
1834
Gilles Peskinedf179142019-07-15 22:02:14 +02001835 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
1836 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001837 if( status != PSA_SUCCESS )
1838 goto exit;
1839
Gilles Peskine5d309672019-07-12 23:47:28 +02001840#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1841 if( driver != NULL )
1842 {
1843 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001844 /* The driver should set the number of key bits, however in
1845 * case it doesn't, we initialize bits to an invalid value. */
1846 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001847 if( drv->key_management == NULL ||
1848 drv->key_management->p_import == NULL )
1849 {
1850 status = PSA_ERROR_NOT_SUPPORTED;
1851 goto exit;
1852 }
1853 status = drv->key_management->p_import(
1854 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02001855 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001856 &bits );
1857 if( status != PSA_SUCCESS )
1858 goto exit;
1859 if( bits > PSA_MAX_KEY_BITS )
1860 {
1861 status = PSA_ERROR_NOT_SUPPORTED;
1862 goto exit;
1863 }
1864 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001865 }
1866 else
1867#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1868 {
1869 status = psa_import_key_into_slot( slot, data, data_length );
1870 if( status != PSA_SUCCESS )
1871 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001872 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001873 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001874 if( status != PSA_SUCCESS )
1875 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001876
Gilles Peskine011e4282019-06-26 18:34:38 +02001877 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001878exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001879 if( status != PSA_SUCCESS )
1880 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001882 *handle = 0;
1883 }
1884 return( status );
1885}
1886
Gilles Peskined7729582019-08-05 15:55:54 +02001887#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1888psa_status_t mbedtls_psa_register_se_key(
1889 const psa_key_attributes_t *attributes )
1890{
1891 psa_status_t status;
1892 psa_key_slot_t *slot = NULL;
1893 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02001894 psa_key_handle_t handle = 0;
1895
1896 /* Leaving attributes unspecified is not currently supported.
1897 * It could make sense to query the key type and size from the
1898 * secure element, but not all secure elements support this
1899 * and the driver HAL doesn't currently support it. */
1900 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1901 return( PSA_ERROR_NOT_SUPPORTED );
1902 if( psa_get_key_bits( attributes ) == 0 )
1903 return( PSA_ERROR_NOT_SUPPORTED );
1904
1905 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
1906 &handle, &slot, &driver );
1907 if( status != PSA_SUCCESS )
1908 goto exit;
1909
Gilles Peskined7729582019-08-05 15:55:54 +02001910 status = psa_finish_key_creation( slot, driver );
1911
1912exit:
1913 if( status != PSA_SUCCESS )
1914 {
1915 psa_fail_key_creation( slot, driver );
1916 }
1917 /* Registration doesn't keep the key in RAM. */
1918 psa_close_key( handle );
1919 return( status );
1920}
1921#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1922
Gilles Peskinef603c712019-01-19 13:40:11 +01001923static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001924 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001925{
1926 psa_status_t status;
1927 uint8_t *buffer = NULL;
1928 size_t buffer_size = 0;
1929 size_t length;
1930
Gilles Peskine8e338702019-07-30 20:06:31 +02001931 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001932 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01001933 buffer = mbedtls_calloc( 1, buffer_size );
Gilles Peskinef9168942019-09-12 19:20:29 +02001934 if( buffer == NULL )
Gilles Peskine122d0022019-01-23 10:55:43 +01001935 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01001936 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1937 if( status != PSA_SUCCESS )
1938 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001939 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001940 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01001941
1942exit:
Gilles Peskinef9168942019-09-12 19:20:29 +02001943 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001944 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01001945 return( status );
1946}
1947
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001948psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1949 const psa_key_attributes_t *specified_attributes,
1950 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01001951{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001952 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01001953 psa_key_slot_t *source_slot = NULL;
1954 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001955 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001956 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001957
Gilles Peskine28f8f302019-07-24 13:30:31 +02001958 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001959 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001960 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001961 goto exit;
1962
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001963 status = psa_validate_optional_attributes( source_slot,
1964 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001965 if( status != PSA_SUCCESS )
1966 goto exit;
1967
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001968 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001969 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001970 if( status != PSA_SUCCESS )
1971 goto exit;
1972
Gilles Peskinedf179142019-07-15 22:02:14 +02001973 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
1974 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001975 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001976 if( status != PSA_SUCCESS )
1977 goto exit;
1978
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001979#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1980 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01001981 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001982 /* Copying to a secure element is not implemented yet. */
1983 status = PSA_ERROR_NOT_SUPPORTED;
1984 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001985 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001986#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01001987
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001988 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01001989 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001990 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001991
Gilles Peskine011e4282019-06-26 18:34:38 +02001992 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001993exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001994 if( status != PSA_SUCCESS )
1995 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001996 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001997 *target_handle = 0;
1998 }
1999 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002000}
2001
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002002
2003
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002004/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002005/* Message digests */
2006/****************************************************************/
2007
Gilles Peskineb16841e2019-10-10 20:36:12 +02002008#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002009static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002010{
2011 switch( alg )
2012 {
2013#if defined(MBEDTLS_MD2_C)
2014 case PSA_ALG_MD2:
2015 return( &mbedtls_md2_info );
2016#endif
2017#if defined(MBEDTLS_MD4_C)
2018 case PSA_ALG_MD4:
2019 return( &mbedtls_md4_info );
2020#endif
2021#if defined(MBEDTLS_MD5_C)
2022 case PSA_ALG_MD5:
2023 return( &mbedtls_md5_info );
2024#endif
2025#if defined(MBEDTLS_RIPEMD160_C)
2026 case PSA_ALG_RIPEMD160:
2027 return( &mbedtls_ripemd160_info );
2028#endif
2029#if defined(MBEDTLS_SHA1_C)
2030 case PSA_ALG_SHA_1:
2031 return( &mbedtls_sha1_info );
2032#endif
2033#if defined(MBEDTLS_SHA256_C)
2034 case PSA_ALG_SHA_224:
2035 return( &mbedtls_sha224_info );
2036 case PSA_ALG_SHA_256:
2037 return( &mbedtls_sha256_info );
2038#endif
2039#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002040#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002041 case PSA_ALG_SHA_384:
2042 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002043#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002044 case PSA_ALG_SHA_512:
2045 return( &mbedtls_sha512_info );
2046#endif
2047 default:
2048 return( NULL );
2049 }
2050}
Gilles Peskineb16841e2019-10-10 20:36:12 +02002051#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002052
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002053psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2054{
2055 switch( operation->alg )
2056 {
Gilles Peskine81736312018-06-26 15:04:31 +02002057 case 0:
2058 /* The object has (apparently) been initialized but it is not
2059 * in use. It's ok to call abort on such an object, and there's
2060 * nothing to do. */
2061 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002062#if defined(MBEDTLS_MD2_C)
2063 case PSA_ALG_MD2:
2064 mbedtls_md2_free( &operation->ctx.md2 );
2065 break;
2066#endif
2067#if defined(MBEDTLS_MD4_C)
2068 case PSA_ALG_MD4:
2069 mbedtls_md4_free( &operation->ctx.md4 );
2070 break;
2071#endif
2072#if defined(MBEDTLS_MD5_C)
2073 case PSA_ALG_MD5:
2074 mbedtls_md5_free( &operation->ctx.md5 );
2075 break;
2076#endif
2077#if defined(MBEDTLS_RIPEMD160_C)
2078 case PSA_ALG_RIPEMD160:
2079 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2080 break;
2081#endif
2082#if defined(MBEDTLS_SHA1_C)
2083 case PSA_ALG_SHA_1:
2084 mbedtls_sha1_free( &operation->ctx.sha1 );
2085 break;
2086#endif
2087#if defined(MBEDTLS_SHA256_C)
2088 case PSA_ALG_SHA_224:
2089 case PSA_ALG_SHA_256:
2090 mbedtls_sha256_free( &operation->ctx.sha256 );
2091 break;
2092#endif
2093#if defined(MBEDTLS_SHA512_C)
2094 case PSA_ALG_SHA_384:
2095 case PSA_ALG_SHA_512:
2096 mbedtls_sha512_free( &operation->ctx.sha512 );
2097 break;
2098#endif
2099 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002100 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002101 }
2102 operation->alg = 0;
2103 return( PSA_SUCCESS );
2104}
2105
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002106psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002107 psa_algorithm_t alg )
2108{
Janos Follath24eed8d2019-11-22 13:21:35 +00002109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002110
2111 /* A context must be freshly initialized before it can be set up. */
2112 if( operation->alg != 0 )
2113 {
2114 return( PSA_ERROR_BAD_STATE );
2115 }
2116
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002117 switch( alg )
2118 {
2119#if defined(MBEDTLS_MD2_C)
2120 case PSA_ALG_MD2:
2121 mbedtls_md2_init( &operation->ctx.md2 );
2122 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2123 break;
2124#endif
2125#if defined(MBEDTLS_MD4_C)
2126 case PSA_ALG_MD4:
2127 mbedtls_md4_init( &operation->ctx.md4 );
2128 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2129 break;
2130#endif
2131#if defined(MBEDTLS_MD5_C)
2132 case PSA_ALG_MD5:
2133 mbedtls_md5_init( &operation->ctx.md5 );
2134 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2135 break;
2136#endif
2137#if defined(MBEDTLS_RIPEMD160_C)
2138 case PSA_ALG_RIPEMD160:
2139 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2140 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2141 break;
2142#endif
2143#if defined(MBEDTLS_SHA1_C)
2144 case PSA_ALG_SHA_1:
2145 mbedtls_sha1_init( &operation->ctx.sha1 );
2146 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2147 break;
2148#endif
2149#if defined(MBEDTLS_SHA256_C)
2150 case PSA_ALG_SHA_224:
2151 mbedtls_sha256_init( &operation->ctx.sha256 );
2152 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2153 break;
2154 case PSA_ALG_SHA_256:
2155 mbedtls_sha256_init( &operation->ctx.sha256 );
2156 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2157 break;
2158#endif
2159#if defined(MBEDTLS_SHA512_C)
2160 case PSA_ALG_SHA_384:
2161 mbedtls_sha512_init( &operation->ctx.sha512 );
2162 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2163 break;
2164 case PSA_ALG_SHA_512:
2165 mbedtls_sha512_init( &operation->ctx.sha512 );
2166 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2167 break;
2168#endif
2169 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002170 return( PSA_ALG_IS_HASH( alg ) ?
2171 PSA_ERROR_NOT_SUPPORTED :
2172 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002173 }
2174 if( ret == 0 )
2175 operation->alg = alg;
2176 else
2177 psa_hash_abort( operation );
2178 return( mbedtls_to_psa_error( ret ) );
2179}
2180
2181psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2182 const uint8_t *input,
2183 size_t input_length )
2184{
Janos Follath24eed8d2019-11-22 13:21:35 +00002185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002186
2187 /* Don't require hash implementations to behave correctly on a
2188 * zero-length input, which may have an invalid pointer. */
2189 if( input_length == 0 )
2190 return( PSA_SUCCESS );
2191
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192 switch( operation->alg )
2193 {
2194#if defined(MBEDTLS_MD2_C)
2195 case PSA_ALG_MD2:
2196 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2197 input, input_length );
2198 break;
2199#endif
2200#if defined(MBEDTLS_MD4_C)
2201 case PSA_ALG_MD4:
2202 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2203 input, input_length );
2204 break;
2205#endif
2206#if defined(MBEDTLS_MD5_C)
2207 case PSA_ALG_MD5:
2208 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2209 input, input_length );
2210 break;
2211#endif
2212#if defined(MBEDTLS_RIPEMD160_C)
2213 case PSA_ALG_RIPEMD160:
2214 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2215 input, input_length );
2216 break;
2217#endif
2218#if defined(MBEDTLS_SHA1_C)
2219 case PSA_ALG_SHA_1:
2220 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2221 input, input_length );
2222 break;
2223#endif
2224#if defined(MBEDTLS_SHA256_C)
2225 case PSA_ALG_SHA_224:
2226 case PSA_ALG_SHA_256:
2227 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2228 input, input_length );
2229 break;
2230#endif
2231#if defined(MBEDTLS_SHA512_C)
2232 case PSA_ALG_SHA_384:
2233 case PSA_ALG_SHA_512:
2234 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2235 input, input_length );
2236 break;
2237#endif
2238 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002239 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002241
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002242 if( ret != 0 )
2243 psa_hash_abort( operation );
2244 return( mbedtls_to_psa_error( ret ) );
2245}
2246
2247psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2248 uint8_t *hash,
2249 size_t hash_size,
2250 size_t *hash_length )
2251{
itayzafrir40835d42018-08-02 13:14:17 +03002252 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002254 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255
2256 /* Fill the output buffer with something that isn't a valid hash
2257 * (barring an attack on the hash and deliberately-crafted input),
2258 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002259 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002260 /* If hash_size is 0 then hash may be NULL and then the
2261 * call to memset would have undefined behavior. */
2262 if( hash_size != 0 )
2263 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002264
2265 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002266 {
2267 status = PSA_ERROR_BUFFER_TOO_SMALL;
2268 goto exit;
2269 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270
2271 switch( operation->alg )
2272 {
2273#if defined(MBEDTLS_MD2_C)
2274 case PSA_ALG_MD2:
2275 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2276 break;
2277#endif
2278#if defined(MBEDTLS_MD4_C)
2279 case PSA_ALG_MD4:
2280 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2281 break;
2282#endif
2283#if defined(MBEDTLS_MD5_C)
2284 case PSA_ALG_MD5:
2285 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2286 break;
2287#endif
2288#if defined(MBEDTLS_RIPEMD160_C)
2289 case PSA_ALG_RIPEMD160:
2290 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2291 break;
2292#endif
2293#if defined(MBEDTLS_SHA1_C)
2294 case PSA_ALG_SHA_1:
2295 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2296 break;
2297#endif
2298#if defined(MBEDTLS_SHA256_C)
2299 case PSA_ALG_SHA_224:
2300 case PSA_ALG_SHA_256:
2301 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2302 break;
2303#endif
2304#if defined(MBEDTLS_SHA512_C)
2305 case PSA_ALG_SHA_384:
2306 case PSA_ALG_SHA_512:
2307 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2308 break;
2309#endif
2310 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002311 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002312 }
itayzafrir40835d42018-08-02 13:14:17 +03002313 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002314
itayzafrir40835d42018-08-02 13:14:17 +03002315exit:
2316 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002317 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002318 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002319 return( psa_hash_abort( operation ) );
2320 }
2321 else
2322 {
2323 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002324 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325 }
2326}
2327
Gilles Peskine2d277862018-06-18 15:41:12 +02002328psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2329 const uint8_t *hash,
2330 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002331{
2332 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2333 size_t actual_hash_length;
2334 psa_status_t status = psa_hash_finish( operation,
2335 actual_hash, sizeof( actual_hash ),
2336 &actual_hash_length );
2337 if( status != PSA_SUCCESS )
2338 return( status );
2339 if( actual_hash_length != hash_length )
2340 return( PSA_ERROR_INVALID_SIGNATURE );
2341 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2342 return( PSA_ERROR_INVALID_SIGNATURE );
2343 return( PSA_SUCCESS );
2344}
2345
Gilles Peskineeb35d782019-01-22 17:56:16 +01002346psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2347 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002348{
2349 if( target_operation->alg != 0 )
2350 return( PSA_ERROR_BAD_STATE );
2351
2352 switch( source_operation->alg )
2353 {
2354 case 0:
2355 return( PSA_ERROR_BAD_STATE );
2356#if defined(MBEDTLS_MD2_C)
2357 case PSA_ALG_MD2:
2358 mbedtls_md2_clone( &target_operation->ctx.md2,
2359 &source_operation->ctx.md2 );
2360 break;
2361#endif
2362#if defined(MBEDTLS_MD4_C)
2363 case PSA_ALG_MD4:
2364 mbedtls_md4_clone( &target_operation->ctx.md4,
2365 &source_operation->ctx.md4 );
2366 break;
2367#endif
2368#if defined(MBEDTLS_MD5_C)
2369 case PSA_ALG_MD5:
2370 mbedtls_md5_clone( &target_operation->ctx.md5,
2371 &source_operation->ctx.md5 );
2372 break;
2373#endif
2374#if defined(MBEDTLS_RIPEMD160_C)
2375 case PSA_ALG_RIPEMD160:
2376 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2377 &source_operation->ctx.ripemd160 );
2378 break;
2379#endif
2380#if defined(MBEDTLS_SHA1_C)
2381 case PSA_ALG_SHA_1:
2382 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2383 &source_operation->ctx.sha1 );
2384 break;
2385#endif
2386#if defined(MBEDTLS_SHA256_C)
2387 case PSA_ALG_SHA_224:
2388 case PSA_ALG_SHA_256:
2389 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2390 &source_operation->ctx.sha256 );
2391 break;
2392#endif
2393#if defined(MBEDTLS_SHA512_C)
2394 case PSA_ALG_SHA_384:
2395 case PSA_ALG_SHA_512:
2396 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2397 &source_operation->ctx.sha512 );
2398 break;
2399#endif
2400 default:
2401 return( PSA_ERROR_NOT_SUPPORTED );
2402 }
2403
2404 target_operation->alg = source_operation->alg;
2405 return( PSA_SUCCESS );
2406}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002407
2408
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410/* MAC */
2411/****************************************************************/
2412
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002413static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414 psa_algorithm_t alg,
2415 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002416 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002417 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002418{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002420 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002421
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002422 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002423 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002424
Gilles Peskine8c9def32018-02-08 10:02:12 +01002425 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2426 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002427 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002428 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002429 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002430 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431 mode = MBEDTLS_MODE_STREAM;
2432 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002433 case PSA_ALG_CTR:
2434 mode = MBEDTLS_MODE_CTR;
2435 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002436 case PSA_ALG_CFB:
2437 mode = MBEDTLS_MODE_CFB;
2438 break;
2439 case PSA_ALG_OFB:
2440 mode = MBEDTLS_MODE_OFB;
2441 break;
2442 case PSA_ALG_CBC_NO_PADDING:
2443 mode = MBEDTLS_MODE_CBC;
2444 break;
2445 case PSA_ALG_CBC_PKCS7:
2446 mode = MBEDTLS_MODE_CBC;
2447 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002448 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002449 mode = MBEDTLS_MODE_CCM;
2450 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002451 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002452 mode = MBEDTLS_MODE_GCM;
2453 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002454 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2455 mode = MBEDTLS_MODE_CHACHAPOLY;
2456 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002457 default:
2458 return( NULL );
2459 }
2460 }
2461 else if( alg == PSA_ALG_CMAC )
2462 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002463 else
2464 return( NULL );
2465
2466 switch( key_type )
2467 {
2468 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002469 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002470 break;
2471 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002472 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2473 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002474 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002475 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002476 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002477 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002478 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2479 * but two-key Triple-DES is functionally three-key Triple-DES
2480 * with K1=K3, so that's how we present it to mbedtls. */
2481 if( key_bits == 128 )
2482 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002483 break;
2484 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002485 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002486 break;
2487 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002488 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002489 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002490 case PSA_KEY_TYPE_CHACHA20:
2491 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2492 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002493 default:
2494 return( NULL );
2495 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002496 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002497 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002498
Jaeden Amero23bbb752018-06-26 14:16:54 +01002499 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2500 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002501}
2502
Gilles Peskinea05219c2018-11-16 16:02:56 +01002503#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002504static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002505{
Gilles Peskine2d277862018-06-18 15:41:12 +02002506 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002507 {
2508 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002509 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002510 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002511 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002512 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002513 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002514 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002515 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002516 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002517 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002518 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002519 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002520 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002521 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002522 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002523 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002524 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002525 return( 128 );
2526 default:
2527 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002528 }
2529}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002530#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002531
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002532/* Initialize the MAC operation structure. Once this function has been
2533 * called, psa_mac_abort can run and will do the right thing. */
2534static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2535 psa_algorithm_t alg )
2536{
2537 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2538
2539 operation->alg = alg;
2540 operation->key_set = 0;
2541 operation->iv_set = 0;
2542 operation->iv_required = 0;
2543 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002544 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002545
2546#if defined(MBEDTLS_CMAC_C)
2547 if( alg == PSA_ALG_CMAC )
2548 {
2549 operation->iv_required = 0;
2550 mbedtls_cipher_init( &operation->ctx.cmac );
2551 status = PSA_SUCCESS;
2552 }
2553 else
2554#endif /* MBEDTLS_CMAC_C */
2555#if defined(MBEDTLS_MD_C)
2556 if( PSA_ALG_IS_HMAC( operation->alg ) )
2557 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002558 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2559 operation->ctx.hmac.hash_ctx.alg = 0;
2560 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002561 }
2562 else
2563#endif /* MBEDTLS_MD_C */
2564 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002565 if( ! PSA_ALG_IS_MAC( alg ) )
2566 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002567 }
2568
2569 if( status != PSA_SUCCESS )
2570 memset( operation, 0, sizeof( *operation ) );
2571 return( status );
2572}
2573
Gilles Peskine01126fa2018-07-12 17:04:55 +02002574#if defined(MBEDTLS_MD_C)
2575static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2576{
Gilles Peskine3f108122018-12-07 18:14:53 +01002577 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002578 return( psa_hash_abort( &hmac->hash_ctx ) );
2579}
2580#endif /* MBEDTLS_MD_C */
2581
Gilles Peskine8c9def32018-02-08 10:02:12 +01002582psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2583{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002584 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002585 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002586 /* The object has (apparently) been initialized but it is not
2587 * in use. It's ok to call abort on such an object, and there's
2588 * nothing to do. */
2589 return( PSA_SUCCESS );
2590 }
2591 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002592#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002593 if( operation->alg == PSA_ALG_CMAC )
2594 {
2595 mbedtls_cipher_free( &operation->ctx.cmac );
2596 }
2597 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002598#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002599#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002600 if( PSA_ALG_IS_HMAC( operation->alg ) )
2601 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002602 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002603 }
2604 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002606 {
2607 /* Sanity check (shouldn't happen: operation->alg should
2608 * always have been initialized to a valid value). */
2609 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002610 }
Moran Peker41deec42018-04-04 15:43:05 +03002611
Gilles Peskine8c9def32018-02-08 10:02:12 +01002612 operation->alg = 0;
2613 operation->key_set = 0;
2614 operation->iv_set = 0;
2615 operation->iv_required = 0;
2616 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002617 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002618
Gilles Peskine8c9def32018-02-08 10:02:12 +01002619 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002620
2621bad_state:
2622 /* If abort is called on an uninitialized object, we can't trust
2623 * anything. Wipe the object in case it contains confidential data.
2624 * This may result in a memory leak if a pointer gets overwritten,
2625 * but it's too late to do anything about this. */
2626 memset( operation, 0, sizeof( *operation ) );
2627 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628}
2629
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002630#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002631static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002632 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002633 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002634 const mbedtls_cipher_info_t *cipher_info )
2635{
Janos Follath24eed8d2019-11-22 13:21:35 +00002636 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002637
2638 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002639
2640 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2641 if( ret != 0 )
2642 return( ret );
2643
2644 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2645 slot->data.raw.data,
2646 key_bits );
2647 return( ret );
2648}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002649#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002650
Gilles Peskine248051a2018-06-20 16:09:38 +02002651#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002652static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2653 const uint8_t *key,
2654 size_t key_length,
2655 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002656{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002657 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002658 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002659 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002660 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002661 psa_status_t status;
2662
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002663 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2664 * overflow below. This should never trigger if the hash algorithm
2665 * is implemented correctly. */
2666 /* The size checks against the ipad and opad buffers cannot be written
2667 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2668 * because that triggers -Wlogical-op on GCC 7.3. */
2669 if( block_size > sizeof( ipad ) )
2670 return( PSA_ERROR_NOT_SUPPORTED );
2671 if( block_size > sizeof( hmac->opad ) )
2672 return( PSA_ERROR_NOT_SUPPORTED );
2673 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002674 return( PSA_ERROR_NOT_SUPPORTED );
2675
Gilles Peskined223b522018-06-11 18:12:58 +02002676 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002677 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002678 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002679 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002680 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002681 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002682 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002683 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002684 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002685 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002686 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002687 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002688 }
Gilles Peskine96889972018-07-12 17:07:03 +02002689 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2690 * but it is permitted. It is common when HMAC is used in HKDF, for
2691 * example. Don't call `memcpy` in the 0-length because `key` could be
2692 * an invalid pointer which would make the behavior undefined. */
2693 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002694 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002695
Gilles Peskined223b522018-06-11 18:12:58 +02002696 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2697 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002698 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002699 ipad[i] ^= 0x36;
2700 memset( ipad + key_length, 0x36, block_size - key_length );
2701
2702 /* Copy the key material from ipad to opad, flipping the requisite bits,
2703 * and filling the rest of opad with the requisite constant. */
2704 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002705 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2706 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002707
Gilles Peskine01126fa2018-07-12 17:04:55 +02002708 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002709 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002710 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002711
Gilles Peskine01126fa2018-07-12 17:04:55 +02002712 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002713
2714cleanup:
Ron Eldor296eca62019-09-10 15:21:37 +03002715 mbedtls_platform_zeroize( ipad, sizeof(ipad) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002716
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002717 return( status );
2718}
Gilles Peskine248051a2018-06-20 16:09:38 +02002719#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002720
Gilles Peskine89167cb2018-07-08 20:12:23 +02002721static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002722 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002723 psa_algorithm_t alg,
2724 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002725{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002726 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002727 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002729 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002730 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002731 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002732 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002734 /* A context must be freshly initialized before it can be set up. */
2735 if( operation->alg != 0 )
2736 {
2737 return( PSA_ERROR_BAD_STATE );
2738 }
2739
Gilles Peskined911eb72018-08-14 15:18:45 +02002740 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002741 if( status != PSA_SUCCESS )
2742 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002743 if( is_sign )
2744 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002745
Gilles Peskine28f8f302019-07-24 13:30:31 +02002746 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002747 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002748 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002749 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002750
Gilles Peskine8c9def32018-02-08 10:02:12 +01002751#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002752 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002753 {
2754 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002755 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002756 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002757 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002758 if( cipher_info == NULL )
2759 {
2760 status = PSA_ERROR_NOT_SUPPORTED;
2761 goto exit;
2762 }
2763 operation->mac_size = cipher_info->block_size;
2764 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2765 status = mbedtls_to_psa_error( ret );
2766 }
2767 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002768#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002769#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002770 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002771 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002772 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002773 if( hash_alg == 0 )
2774 {
2775 status = PSA_ERROR_NOT_SUPPORTED;
2776 goto exit;
2777 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002778
2779 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2780 /* Sanity check. This shouldn't fail on a valid configuration. */
2781 if( operation->mac_size == 0 ||
2782 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2783 {
2784 status = PSA_ERROR_NOT_SUPPORTED;
2785 goto exit;
2786 }
2787
Gilles Peskine8e338702019-07-30 20:06:31 +02002788 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002789 {
2790 status = PSA_ERROR_INVALID_ARGUMENT;
2791 goto exit;
2792 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002793
Gilles Peskine01126fa2018-07-12 17:04:55 +02002794 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2795 slot->data.raw.data,
2796 slot->data.raw.bytes,
2797 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002798 }
2799 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002800#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002801 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002802 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002803 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002804 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002805
Gilles Peskined911eb72018-08-14 15:18:45 +02002806 if( truncated == 0 )
2807 {
2808 /* The "normal" case: untruncated algorithm. Nothing to do. */
2809 }
2810 else if( truncated < 4 )
2811 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002812 /* A very short MAC is too short for security since it can be
2813 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2814 * so we make this our minimum, even though 32 bits is still
2815 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002816 status = PSA_ERROR_NOT_SUPPORTED;
2817 }
2818 else if( truncated > operation->mac_size )
2819 {
2820 /* It's impossible to "truncate" to a larger length. */
2821 status = PSA_ERROR_INVALID_ARGUMENT;
2822 }
2823 else
2824 operation->mac_size = truncated;
2825
Gilles Peskinefbfac682018-07-08 20:51:54 +02002826exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002827 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002828 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002829 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002830 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002831 else
2832 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002833 operation->key_set = 1;
2834 }
2835 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002836}
2837
Gilles Peskine89167cb2018-07-08 20:12:23 +02002838psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002839 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002840 psa_algorithm_t alg )
2841{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002842 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002843}
2844
2845psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002846 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002847 psa_algorithm_t alg )
2848{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002849 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002850}
2851
Gilles Peskine8c9def32018-02-08 10:02:12 +01002852psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2853 const uint8_t *input,
2854 size_t input_length )
2855{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002856 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002857 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002858 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002859 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002860 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002861 operation->has_input = 1;
2862
Gilles Peskine8c9def32018-02-08 10:02:12 +01002863#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002864 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002865 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002866 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2867 input, input_length );
2868 status = mbedtls_to_psa_error( ret );
2869 }
2870 else
2871#endif /* MBEDTLS_CMAC_C */
2872#if defined(MBEDTLS_MD_C)
2873 if( PSA_ALG_IS_HMAC( operation->alg ) )
2874 {
2875 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2876 input_length );
2877 }
2878 else
2879#endif /* MBEDTLS_MD_C */
2880 {
2881 /* This shouldn't happen if `operation` was initialized by
2882 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002883 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002884 }
2885
Gilles Peskinefbfac682018-07-08 20:51:54 +02002886 if( status != PSA_SUCCESS )
2887 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002888 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002889}
2890
Gilles Peskine01126fa2018-07-12 17:04:55 +02002891#if defined(MBEDTLS_MD_C)
2892static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2893 uint8_t *mac,
2894 size_t mac_size )
2895{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002896 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002897 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2898 size_t hash_size = 0;
2899 size_t block_size = psa_get_hash_block_size( hash_alg );
2900 psa_status_t status;
2901
Gilles Peskine01126fa2018-07-12 17:04:55 +02002902 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2903 if( status != PSA_SUCCESS )
2904 return( status );
2905 /* From here on, tmp needs to be wiped. */
2906
2907 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2908 if( status != PSA_SUCCESS )
2909 goto exit;
2910
2911 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2912 if( status != PSA_SUCCESS )
2913 goto exit;
2914
2915 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2916 if( status != PSA_SUCCESS )
2917 goto exit;
2918
Gilles Peskined911eb72018-08-14 15:18:45 +02002919 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2920 if( status != PSA_SUCCESS )
2921 goto exit;
2922
2923 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002924
2925exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002926 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002927 return( status );
2928}
2929#endif /* MBEDTLS_MD_C */
2930
mohammad16036df908f2018-04-02 08:34:15 -07002931static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002932 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002933 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002934{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002935 if( ! operation->key_set )
2936 return( PSA_ERROR_BAD_STATE );
2937 if( operation->iv_required && ! operation->iv_set )
2938 return( PSA_ERROR_BAD_STATE );
2939
Gilles Peskine8c9def32018-02-08 10:02:12 +01002940 if( mac_size < operation->mac_size )
2941 return( PSA_ERROR_BUFFER_TOO_SMALL );
2942
Gilles Peskine8c9def32018-02-08 10:02:12 +01002943#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002944 if( operation->alg == PSA_ALG_CMAC )
2945 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002946 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2947 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2948 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002949 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002950 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002951 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002952 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002953 else
2954#endif /* MBEDTLS_CMAC_C */
2955#if defined(MBEDTLS_MD_C)
2956 if( PSA_ALG_IS_HMAC( operation->alg ) )
2957 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002958 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002959 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002960 }
2961 else
2962#endif /* MBEDTLS_MD_C */
2963 {
2964 /* This shouldn't happen if `operation` was initialized by
2965 * a setup function. */
2966 return( PSA_ERROR_BAD_STATE );
2967 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002968}
2969
Gilles Peskineacd4be32018-07-08 19:56:25 +02002970psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2971 uint8_t *mac,
2972 size_t mac_size,
2973 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002974{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002975 psa_status_t status;
2976
Jaeden Amero252ef282019-02-15 14:05:35 +00002977 if( operation->alg == 0 )
2978 {
2979 return( PSA_ERROR_BAD_STATE );
2980 }
2981
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002982 /* Fill the output buffer with something that isn't a valid mac
2983 * (barring an attack on the mac and deliberately-crafted input),
2984 * in case the caller doesn't check the return status properly. */
2985 *mac_length = mac_size;
2986 /* If mac_size is 0 then mac may be NULL and then the
2987 * call to memset would have undefined behavior. */
2988 if( mac_size != 0 )
2989 memset( mac, '!', mac_size );
2990
Gilles Peskine89167cb2018-07-08 20:12:23 +02002991 if( ! operation->is_sign )
2992 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002993 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002994 }
mohammad16036df908f2018-04-02 08:34:15 -07002995
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002996 status = psa_mac_finish_internal( operation, mac, mac_size );
2997
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002998 if( status == PSA_SUCCESS )
2999 {
3000 status = psa_mac_abort( operation );
3001 if( status == PSA_SUCCESS )
3002 *mac_length = operation->mac_size;
3003 else
3004 memset( mac, '!', mac_size );
3005 }
3006 else
3007 psa_mac_abort( operation );
3008 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003009}
3010
Gilles Peskineacd4be32018-07-08 19:56:25 +02003011psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3012 const uint8_t *mac,
3013 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003014{
Gilles Peskine828ed142018-06-18 23:25:51 +02003015 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003016 psa_status_t status;
3017
Jaeden Amero252ef282019-02-15 14:05:35 +00003018 if( operation->alg == 0 )
3019 {
3020 return( PSA_ERROR_BAD_STATE );
3021 }
3022
Gilles Peskine89167cb2018-07-08 20:12:23 +02003023 if( operation->is_sign )
3024 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003025 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003026 }
3027 if( operation->mac_size != mac_length )
3028 {
3029 status = PSA_ERROR_INVALID_SIGNATURE;
3030 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003031 }
mohammad16036df908f2018-04-02 08:34:15 -07003032
3033 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003034 actual_mac, sizeof( actual_mac ) );
3035
3036 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3037 status = PSA_ERROR_INVALID_SIGNATURE;
3038
3039cleanup:
3040 if( status == PSA_SUCCESS )
3041 status = psa_mac_abort( operation );
3042 else
3043 psa_mac_abort( operation );
3044
Gilles Peskine3f108122018-12-07 18:14:53 +01003045 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003046
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003047 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003048}
3049
3050
Gilles Peskine20035e32018-02-03 22:44:14 +01003051
Gilles Peskine20035e32018-02-03 22:44:14 +01003052/****************************************************************/
3053/* Asymmetric cryptography */
3054/****************************************************************/
3055
Gilles Peskine2b450e32018-06-27 15:42:46 +02003056#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003057/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003058 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003059static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3060 size_t hash_length,
3061 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003062{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003063 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003064 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003065 *md_alg = mbedtls_md_get_type( md_info );
3066
3067 /* The Mbed TLS RSA module uses an unsigned int for hash length
3068 * parameters. Validate that it fits so that we don't risk an
3069 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003070#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003071 if( hash_length > UINT_MAX )
3072 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003073#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003074
3075#if defined(MBEDTLS_PKCS1_V15)
3076 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3077 * must be correct. */
3078 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3079 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003080 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003081 if( md_info == NULL )
3082 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003083 if( mbedtls_md_get_size( md_info ) != hash_length )
3084 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003085 }
3086#endif /* MBEDTLS_PKCS1_V15 */
3087
3088#if defined(MBEDTLS_PKCS1_V21)
3089 /* PSS requires a hash internally. */
3090 if( PSA_ALG_IS_RSA_PSS( alg ) )
3091 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003092 if( md_info == NULL )
3093 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003094 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003095#endif /* MBEDTLS_PKCS1_V21 */
3096
Gilles Peskine61b91d42018-06-08 16:09:36 +02003097 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003098}
3099
Gilles Peskine2b450e32018-06-27 15:42:46 +02003100static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3101 psa_algorithm_t alg,
3102 const uint8_t *hash,
3103 size_t hash_length,
3104 uint8_t *signature,
3105 size_t signature_size,
3106 size_t *signature_length )
3107{
3108 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003110 mbedtls_md_type_t md_alg;
3111
3112 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3113 if( status != PSA_SUCCESS )
3114 return( status );
3115
Gilles Peskine630a18a2018-06-29 17:49:35 +02003116 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003117 return( PSA_ERROR_BUFFER_TOO_SMALL );
3118
3119#if defined(MBEDTLS_PKCS1_V15)
3120 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3121 {
3122 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3123 MBEDTLS_MD_NONE );
3124 ret = mbedtls_rsa_pkcs1_sign( rsa,
3125 mbedtls_ctr_drbg_random,
3126 &global_data.ctr_drbg,
3127 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003128 md_alg,
3129 (unsigned int) hash_length,
3130 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003131 signature );
3132 }
3133 else
3134#endif /* MBEDTLS_PKCS1_V15 */
3135#if defined(MBEDTLS_PKCS1_V21)
3136 if( PSA_ALG_IS_RSA_PSS( alg ) )
3137 {
3138 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3139 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3140 mbedtls_ctr_drbg_random,
3141 &global_data.ctr_drbg,
3142 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003143 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003144 (unsigned int) hash_length,
3145 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003146 signature );
3147 }
3148 else
3149#endif /* MBEDTLS_PKCS1_V21 */
3150 {
3151 return( PSA_ERROR_INVALID_ARGUMENT );
3152 }
3153
3154 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003155 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003156 return( mbedtls_to_psa_error( ret ) );
3157}
3158
3159static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3160 psa_algorithm_t alg,
3161 const uint8_t *hash,
3162 size_t hash_length,
3163 const uint8_t *signature,
3164 size_t signature_length )
3165{
3166 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003168 mbedtls_md_type_t md_alg;
3169
3170 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3171 if( status != PSA_SUCCESS )
3172 return( status );
3173
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003174 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3175 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003176
3177#if defined(MBEDTLS_PKCS1_V15)
3178 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3179 {
3180 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3181 MBEDTLS_MD_NONE );
3182 ret = mbedtls_rsa_pkcs1_verify( rsa,
3183 mbedtls_ctr_drbg_random,
3184 &global_data.ctr_drbg,
3185 MBEDTLS_RSA_PUBLIC,
3186 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003187 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003188 hash,
3189 signature );
3190 }
3191 else
3192#endif /* MBEDTLS_PKCS1_V15 */
3193#if defined(MBEDTLS_PKCS1_V21)
3194 if( PSA_ALG_IS_RSA_PSS( alg ) )
3195 {
3196 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3197 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3198 mbedtls_ctr_drbg_random,
3199 &global_data.ctr_drbg,
3200 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003201 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003202 (unsigned int) hash_length,
3203 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003204 signature );
3205 }
3206 else
3207#endif /* MBEDTLS_PKCS1_V21 */
3208 {
3209 return( PSA_ERROR_INVALID_ARGUMENT );
3210 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003211
3212 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3213 * the rest of the signature is invalid". This has little use in
3214 * practice and PSA doesn't report this distinction. */
3215 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3216 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003217 return( mbedtls_to_psa_error( ret ) );
3218}
3219#endif /* MBEDTLS_RSA_C */
3220
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003221#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003222/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3223 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3224 * (even though these functions don't modify it). */
3225static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3226 psa_algorithm_t alg,
3227 const uint8_t *hash,
3228 size_t hash_length,
3229 uint8_t *signature,
3230 size_t signature_size,
3231 size_t *signature_length )
3232{
Janos Follath24eed8d2019-11-22 13:21:35 +00003233 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003234 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003235 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003236 mbedtls_mpi_init( &r );
3237 mbedtls_mpi_init( &s );
3238
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003239 if( signature_size < 2 * curve_bytes )
3240 {
3241 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3242 goto cleanup;
3243 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003244
Gilles Peskinea05219c2018-11-16 16:02:56 +01003245#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003246 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3247 {
3248 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3249 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3250 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003251 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3252 &ecp->d, hash,
3253 hash_length, md_alg,
3254 mbedtls_ctr_drbg_random,
3255 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003256 }
3257 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003258#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003259 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003260 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003261 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3262 hash, hash_length,
3263 mbedtls_ctr_drbg_random,
3264 &global_data.ctr_drbg ) );
3265 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003266
3267 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3268 signature,
3269 curve_bytes ) );
3270 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3271 signature + curve_bytes,
3272 curve_bytes ) );
3273
3274cleanup:
3275 mbedtls_mpi_free( &r );
3276 mbedtls_mpi_free( &s );
3277 if( ret == 0 )
3278 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003279 return( mbedtls_to_psa_error( ret ) );
3280}
3281
3282static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3283 const uint8_t *hash,
3284 size_t hash_length,
3285 const uint8_t *signature,
3286 size_t signature_length )
3287{
Janos Follath24eed8d2019-11-22 13:21:35 +00003288 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003289 mbedtls_mpi r, s;
3290 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3291 mbedtls_mpi_init( &r );
3292 mbedtls_mpi_init( &s );
3293
3294 if( signature_length != 2 * curve_bytes )
3295 return( PSA_ERROR_INVALID_SIGNATURE );
3296
3297 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3298 signature,
3299 curve_bytes ) );
3300 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3301 signature + curve_bytes,
3302 curve_bytes ) );
3303
3304 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3305 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003306
3307cleanup:
3308 mbedtls_mpi_free( &r );
3309 mbedtls_mpi_free( &s );
3310 return( mbedtls_to_psa_error( ret ) );
3311}
3312#endif /* MBEDTLS_ECDSA_C */
3313
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003314psa_status_t psa_sign_hash( psa_key_handle_t handle,
3315 psa_algorithm_t alg,
3316 const uint8_t *hash,
3317 size_t hash_length,
3318 uint8_t *signature,
3319 size_t signature_size,
3320 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003321{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003322 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003323 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003324#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3325 const psa_drv_se_t *drv;
3326 psa_drv_se_context_t *drv_context;
3327#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003328
3329 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003330 /* Immediately reject a zero-length signature buffer. This guarantees
3331 * that signature must be a valid pointer. (On the other hand, the hash
3332 * buffer can in principle be empty since it doesn't actually have
3333 * to be a hash.) */
3334 if( signature_size == 0 )
3335 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003336
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003337 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003338 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003339 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003340 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003341 {
3342 status = PSA_ERROR_INVALID_ARGUMENT;
3343 goto exit;
3344 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003345
Gilles Peskineedc64242019-08-07 21:05:07 +02003346#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3347 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3348 {
3349 if( drv->asymmetric == NULL ||
3350 drv->asymmetric->p_sign == NULL )
3351 {
3352 status = PSA_ERROR_NOT_SUPPORTED;
3353 goto exit;
3354 }
3355 status = drv->asymmetric->p_sign( drv_context,
3356 slot->data.se.slot_number,
3357 alg,
3358 hash, hash_length,
3359 signature, signature_size,
3360 signature_length );
3361 }
3362 else
3363#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine20035e32018-02-03 22:44:14 +01003364#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003365 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003366 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003367 status = psa_rsa_sign( slot->data.rsa,
3368 alg,
3369 hash, hash_length,
3370 signature, signature_size,
3371 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003372 }
3373 else
3374#endif /* defined(MBEDTLS_RSA_C) */
3375#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003376 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003377 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003378#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003379 if(
3380#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3381 PSA_ALG_IS_ECDSA( alg )
3382#else
3383 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3384#endif
3385 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003386 status = psa_ecdsa_sign( slot->data.ecp,
3387 alg,
3388 hash, hash_length,
3389 signature, signature_size,
3390 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003391 else
3392#endif /* defined(MBEDTLS_ECDSA_C) */
3393 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003394 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003395 }
itayzafrir5c753392018-05-08 11:18:38 +03003396 }
3397 else
3398#endif /* defined(MBEDTLS_ECP_C) */
3399 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003400 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003401 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003402
3403exit:
3404 /* Fill the unused part of the output buffer (the whole buffer on error,
3405 * the trailing part on success) with something that isn't a valid mac
3406 * (barring an attack on the mac and deliberately-crafted input),
3407 * in case the caller doesn't check the return status properly. */
3408 if( status == PSA_SUCCESS )
3409 memset( signature + *signature_length, '!',
3410 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003411 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003412 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003413 /* If signature_size is 0 then we have nothing to do. We must not call
3414 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003415 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003416}
3417
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003418psa_status_t psa_verify_hash( psa_key_handle_t handle,
3419 psa_algorithm_t alg,
3420 const uint8_t *hash,
3421 size_t hash_length,
3422 const uint8_t *signature,
3423 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003424{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003425 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003426 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003427#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3428 const psa_drv_se_t *drv;
3429 psa_drv_se_context_t *drv_context;
3430#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003431
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003432 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003433 if( status != PSA_SUCCESS )
3434 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003435
Gilles Peskineedc64242019-08-07 21:05:07 +02003436#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3437 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3438 {
3439 if( drv->asymmetric == NULL ||
3440 drv->asymmetric->p_verify == NULL )
3441 return( PSA_ERROR_NOT_SUPPORTED );
3442 return( drv->asymmetric->p_verify( drv_context,
3443 slot->data.se.slot_number,
3444 alg,
3445 hash, hash_length,
3446 signature, signature_length ) );
3447 }
3448 else
3449#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine61b91d42018-06-08 16:09:36 +02003450#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003451 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003452 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003453 return( psa_rsa_verify( slot->data.rsa,
3454 alg,
3455 hash, hash_length,
3456 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003457 }
3458 else
3459#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003460#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003461 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003462 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003463#if defined(MBEDTLS_ECDSA_C)
3464 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003465 return( psa_ecdsa_verify( slot->data.ecp,
3466 hash, hash_length,
3467 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003468 else
3469#endif /* defined(MBEDTLS_ECDSA_C) */
3470 {
3471 return( PSA_ERROR_INVALID_ARGUMENT );
3472 }
itayzafrir5c753392018-05-08 11:18:38 +03003473 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003474 else
3475#endif /* defined(MBEDTLS_ECP_C) */
3476 {
3477 return( PSA_ERROR_NOT_SUPPORTED );
3478 }
3479}
3480
Gilles Peskine072ac562018-06-30 00:21:29 +02003481#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3482static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3483 mbedtls_rsa_context *rsa )
3484{
3485 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3486 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3487 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3488 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3489}
3490#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3491
Gilles Peskinec5487a82018-12-03 18:08:14 +01003492psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003493 psa_algorithm_t alg,
3494 const uint8_t *input,
3495 size_t input_length,
3496 const uint8_t *salt,
3497 size_t salt_length,
3498 uint8_t *output,
3499 size_t output_size,
3500 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003501{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003502 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003503 psa_status_t status;
3504
Darryl Green5cc689a2018-07-24 15:34:10 +01003505 (void) input;
3506 (void) input_length;
3507 (void) salt;
3508 (void) output;
3509 (void) output_size;
3510
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003511 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003512
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003513 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3514 return( PSA_ERROR_INVALID_ARGUMENT );
3515
Gilles Peskine28f8f302019-07-24 13:30:31 +02003516 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003517 if( status != PSA_SUCCESS )
3518 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003519 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3520 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003521 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003522
3523#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003524 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003525 {
3526 mbedtls_rsa_context *rsa = slot->data.rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00003527 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003528 if( output_size < mbedtls_rsa_get_len( rsa ) )
Vikas Katariya21599b62019-08-02 12:26:29 +01003529 return( PSA_ERROR_BUFFER_TOO_SMALL );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003530#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003531 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003532 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003533 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3534 mbedtls_ctr_drbg_random,
3535 &global_data.ctr_drbg,
3536 MBEDTLS_RSA_PUBLIC,
3537 input_length,
3538 input,
3539 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003540 }
3541 else
3542#endif /* MBEDTLS_PKCS1_V15 */
3543#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003544 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003545 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003546 psa_rsa_oaep_set_padding_mode( alg, rsa );
3547 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3548 mbedtls_ctr_drbg_random,
3549 &global_data.ctr_drbg,
3550 MBEDTLS_RSA_PUBLIC,
3551 salt, salt_length,
3552 input_length,
3553 input,
3554 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003555 }
3556 else
3557#endif /* MBEDTLS_PKCS1_V21 */
3558 {
3559 return( PSA_ERROR_INVALID_ARGUMENT );
3560 }
3561 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003562 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003563 return( mbedtls_to_psa_error( ret ) );
3564 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003565 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003566#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003567 {
3568 return( PSA_ERROR_NOT_SUPPORTED );
3569 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003570}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003571
Gilles Peskinec5487a82018-12-03 18:08:14 +01003572psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003573 psa_algorithm_t alg,
3574 const uint8_t *input,
3575 size_t input_length,
3576 const uint8_t *salt,
3577 size_t salt_length,
3578 uint8_t *output,
3579 size_t output_size,
3580 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003581{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003582 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003583 psa_status_t status;
3584
Darryl Green5cc689a2018-07-24 15:34:10 +01003585 (void) input;
3586 (void) input_length;
3587 (void) salt;
3588 (void) output;
3589 (void) output_size;
3590
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003591 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003592
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003593 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3594 return( PSA_ERROR_INVALID_ARGUMENT );
3595
Gilles Peskine28f8f302019-07-24 13:30:31 +02003596 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003597 if( status != PSA_SUCCESS )
3598 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003599 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003600 return( PSA_ERROR_INVALID_ARGUMENT );
3601
3602#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003603 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003604 {
3605 mbedtls_rsa_context *rsa = slot->data.rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00003606 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003607
Gilles Peskine630a18a2018-06-29 17:49:35 +02003608 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003609 return( PSA_ERROR_INVALID_ARGUMENT );
3610
3611#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003612 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003613 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003614 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3615 mbedtls_ctr_drbg_random,
3616 &global_data.ctr_drbg,
3617 MBEDTLS_RSA_PRIVATE,
3618 output_length,
3619 input,
3620 output,
3621 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003622 }
3623 else
3624#endif /* MBEDTLS_PKCS1_V15 */
3625#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003626 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003627 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003628 psa_rsa_oaep_set_padding_mode( alg, rsa );
3629 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3630 mbedtls_ctr_drbg_random,
3631 &global_data.ctr_drbg,
3632 MBEDTLS_RSA_PRIVATE,
3633 salt, salt_length,
3634 output_length,
3635 input,
3636 output,
3637 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003638 }
3639 else
3640#endif /* MBEDTLS_PKCS1_V21 */
3641 {
3642 return( PSA_ERROR_INVALID_ARGUMENT );
3643 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003644
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003645 return( mbedtls_to_psa_error( ret ) );
3646 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003647 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003648#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003649 {
3650 return( PSA_ERROR_NOT_SUPPORTED );
3651 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003652}
Gilles Peskine20035e32018-02-03 22:44:14 +01003653
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003654
3655
mohammad1603503973b2018-03-12 15:59:30 +02003656/****************************************************************/
3657/* Symmetric cryptography */
3658/****************************************************************/
3659
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003660/* Initialize the cipher operation structure. Once this function has been
3661 * called, psa_cipher_abort can run and will do the right thing. */
3662static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3663 psa_algorithm_t alg )
3664{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003665 if( ! PSA_ALG_IS_CIPHER( alg ) )
3666 {
3667 memset( operation, 0, sizeof( *operation ) );
3668 return( PSA_ERROR_INVALID_ARGUMENT );
3669 }
3670
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003671 operation->alg = alg;
3672 operation->key_set = 0;
3673 operation->iv_set = 0;
3674 operation->iv_required = 1;
3675 operation->iv_size = 0;
3676 operation->block_size = 0;
3677 mbedtls_cipher_init( &operation->ctx.cipher );
3678 return( PSA_SUCCESS );
3679}
3680
Gilles Peskinee553c652018-06-04 16:22:46 +02003681static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003682 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003683 psa_algorithm_t alg,
3684 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003685{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003686 int ret = 0;
3687 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003688 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003689 size_t key_bits;
3690 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003691 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3692 PSA_KEY_USAGE_ENCRYPT :
3693 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003694
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003695 /* A context must be freshly initialized before it can be set up. */
3696 if( operation->alg != 0 )
3697 {
3698 return( PSA_ERROR_BAD_STATE );
3699 }
3700
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003701 status = psa_cipher_init( operation, alg );
3702 if( status != PSA_SUCCESS )
3703 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003704
Gilles Peskine28f8f302019-07-24 13:30:31 +02003705 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003706 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003707 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003708 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003709
Gilles Peskine8e338702019-07-30 20:06:31 +02003710 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003711 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003712 {
3713 status = PSA_ERROR_NOT_SUPPORTED;
3714 goto exit;
3715 }
mohammad1603503973b2018-03-12 15:59:30 +02003716
mohammad1603503973b2018-03-12 15:59:30 +02003717 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003718 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003719 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003720
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003721#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003722 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003723 {
3724 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003725 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003726 memcpy( keys, slot->data.raw.data, 16 );
3727 memcpy( keys + 16, slot->data.raw.data, 8 );
3728 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3729 keys,
3730 192, cipher_operation );
3731 }
3732 else
3733#endif
3734 {
3735 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3736 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003737 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003738 }
Moran Peker41deec42018-04-04 15:43:05 +03003739 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003740 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003741
mohammad16038481e742018-03-18 13:57:31 +02003742#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003743 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003744 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003745 case PSA_ALG_CBC_NO_PADDING:
3746 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3747 MBEDTLS_PADDING_NONE );
3748 break;
3749 case PSA_ALG_CBC_PKCS7:
3750 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3751 MBEDTLS_PADDING_PKCS7 );
3752 break;
3753 default:
3754 /* The algorithm doesn't involve padding. */
3755 ret = 0;
3756 break;
3757 }
3758 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003759 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003760#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3761
mohammad1603503973b2018-03-12 15:59:30 +02003762 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003763 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003764 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003765 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003766 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003767 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003768 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003769#if defined(MBEDTLS_CHACHA20_C)
3770 else
3771 if( alg == PSA_ALG_CHACHA20 )
3772 operation->iv_size = 12;
3773#endif
mohammad1603503973b2018-03-12 15:59:30 +02003774
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003775exit:
3776 if( status == 0 )
3777 status = mbedtls_to_psa_error( ret );
3778 if( status != 0 )
3779 psa_cipher_abort( operation );
3780 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003781}
3782
Gilles Peskinefe119512018-07-08 21:39:34 +02003783psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003784 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003785 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003786{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003787 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003788}
3789
Gilles Peskinefe119512018-07-08 21:39:34 +02003790psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003791 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003792 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003793{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003794 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003795}
3796
Gilles Peskinefe119512018-07-08 21:39:34 +02003797psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003798 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003799 size_t iv_size,
3800 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003801{
itayzafrir534bd7c2018-08-02 13:56:32 +03003802 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003803 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003804 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003805 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003806 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003807 }
Moran Peker41deec42018-04-04 15:43:05 +03003808 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003809 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003810 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003811 goto exit;
3812 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003813 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3814 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003815 if( ret != 0 )
3816 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003817 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003818 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003819 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003820
mohammad16038481e742018-03-18 13:57:31 +02003821 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003822 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003823
Moran Peker395db872018-05-31 14:07:14 +03003824exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003825 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003826 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003827 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003828}
3829
Gilles Peskinefe119512018-07-08 21:39:34 +02003830psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003831 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003832 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003833{
itayzafrir534bd7c2018-08-02 13:56:32 +03003834 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003836 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003837 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003838 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003839 }
Moran Pekera28258c2018-05-29 16:25:04 +03003840 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003841 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003842 status = PSA_ERROR_INVALID_ARGUMENT;
3843 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003844 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003845 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3846 status = mbedtls_to_psa_error( ret );
3847exit:
3848 if( status == PSA_SUCCESS )
3849 operation->iv_set = 1;
3850 else
mohammad1603503973b2018-03-12 15:59:30 +02003851 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003852 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003853}
3854
Gilles Peskinee553c652018-06-04 16:22:46 +02003855psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3856 const uint8_t *input,
3857 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003858 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003859 size_t output_size,
3860 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003861{
itayzafrir534bd7c2018-08-02 13:56:32 +03003862 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003864 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003865
3866 if( operation->alg == 0 )
3867 {
3868 return( PSA_ERROR_BAD_STATE );
3869 }
3870
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003871 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003872 {
3873 /* Take the unprocessed partial block left over from previous
3874 * update calls, if any, plus the input to this call. Remove
3875 * the last partial block, if any. You get the data that will be
3876 * output in this call. */
3877 expected_output_size =
3878 ( operation->ctx.cipher.unprocessed_len + input_length )
3879 / operation->block_size * operation->block_size;
3880 }
3881 else
3882 {
3883 expected_output_size = input_length;
3884 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003885
Gilles Peskine89d789c2018-06-04 17:17:16 +02003886 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003887 {
3888 status = PSA_ERROR_BUFFER_TOO_SMALL;
3889 goto exit;
3890 }
mohammad160382759612018-03-12 18:16:40 +02003891
mohammad1603503973b2018-03-12 15:59:30 +02003892 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003893 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003894 status = mbedtls_to_psa_error( ret );
3895exit:
3896 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003897 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003898 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003899}
3900
Gilles Peskinee553c652018-06-04 16:22:46 +02003901psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3902 uint8_t *output,
3903 size_t output_size,
3904 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003905{
David Saadab4ecc272019-02-14 13:48:10 +02003906 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003907 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003908 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003909
mohammad1603503973b2018-03-12 15:59:30 +02003910 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003911 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003912 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003913 }
3914 if( operation->iv_required && ! operation->iv_set )
3915 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003916 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003917 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003918
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003919 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003920 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3921 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003922 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003923 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003924 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003925 }
3926
Janos Follath315b51c2018-07-09 16:04:51 +01003927 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3928 temp_output_buffer,
3929 output_length );
3930 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003931 {
Janos Follath315b51c2018-07-09 16:04:51 +01003932 status = mbedtls_to_psa_error( cipher_ret );
3933 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003934 }
Janos Follath315b51c2018-07-09 16:04:51 +01003935
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003936 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003937 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003938 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003939 memcpy( output, temp_output_buffer, *output_length );
3940 else
3941 {
Janos Follath315b51c2018-07-09 16:04:51 +01003942 status = PSA_ERROR_BUFFER_TOO_SMALL;
3943 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003944 }
mohammad1603503973b2018-03-12 15:59:30 +02003945
Gilles Peskine3f108122018-12-07 18:14:53 +01003946 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003947 status = psa_cipher_abort( operation );
3948
3949 return( status );
3950
3951error:
3952
3953 *output_length = 0;
3954
Gilles Peskine3f108122018-12-07 18:14:53 +01003955 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003956 (void) psa_cipher_abort( operation );
3957
3958 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003959}
3960
Gilles Peskinee553c652018-06-04 16:22:46 +02003961psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3962{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003963 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003964 {
3965 /* The object has (apparently) been initialized but it is not
3966 * in use. It's ok to call abort on such an object, and there's
3967 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003968 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003969 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003970
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003971 /* Sanity check (shouldn't happen: operation->alg should
3972 * always have been initialized to a valid value). */
3973 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3974 return( PSA_ERROR_BAD_STATE );
3975
mohammad1603503973b2018-03-12 15:59:30 +02003976 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003977
Moran Peker41deec42018-04-04 15:43:05 +03003978 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003979 operation->key_set = 0;
3980 operation->iv_set = 0;
3981 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003982 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003983 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003984
Moran Peker395db872018-05-31 14:07:14 +03003985 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003986}
3987
Gilles Peskinea0655c32018-04-30 17:06:50 +02003988
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003989
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003990
mohammad16035955c982018-04-26 00:53:03 +03003991/****************************************************************/
3992/* AEAD */
3993/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003994
Gilles Peskineedf9a652018-08-17 18:11:56 +02003995typedef struct
3996{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003997 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003998 const mbedtls_cipher_info_t *cipher_info;
3999 union
4000 {
4001#if defined(MBEDTLS_CCM_C)
4002 mbedtls_ccm_context ccm;
4003#endif /* MBEDTLS_CCM_C */
4004#if defined(MBEDTLS_GCM_C)
4005 mbedtls_gcm_context gcm;
4006#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004007#if defined(MBEDTLS_CHACHAPOLY_C)
4008 mbedtls_chachapoly_context chachapoly;
4009#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004010 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004011 psa_algorithm_t core_alg;
4012 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004013 uint8_t tag_length;
4014} aead_operation_t;
4015
Gilles Peskine30a9e412019-01-14 18:36:12 +01004016static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004017{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004018 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004019 {
4020#if defined(MBEDTLS_CCM_C)
4021 case PSA_ALG_CCM:
4022 mbedtls_ccm_free( &operation->ctx.ccm );
4023 break;
4024#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004025#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004026 case PSA_ALG_GCM:
4027 mbedtls_gcm_free( &operation->ctx.gcm );
4028 break;
4029#endif /* MBEDTLS_GCM_C */
4030 }
4031}
4032
4033static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004034 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004035 psa_key_usage_t usage,
4036 psa_algorithm_t alg )
4037{
4038 psa_status_t status;
4039 size_t key_bits;
4040 mbedtls_cipher_id_t cipher_id;
4041
Gilles Peskine28f8f302019-07-24 13:30:31 +02004042 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004043 if( status != PSA_SUCCESS )
4044 return( status );
4045
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004046 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004047
4048 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004049 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004050 &cipher_id );
4051 if( operation->cipher_info == NULL )
4052 return( PSA_ERROR_NOT_SUPPORTED );
4053
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004054 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004055 {
4056#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004057 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4058 operation->core_alg = PSA_ALG_CCM;
4059 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004060 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4061 * The call to mbedtls_ccm_encrypt_and_tag or
4062 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004063 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004064 return( PSA_ERROR_INVALID_ARGUMENT );
4065 mbedtls_ccm_init( &operation->ctx.ccm );
4066 status = mbedtls_to_psa_error(
4067 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
4068 operation->slot->data.raw.data,
4069 (unsigned int) key_bits ) );
4070 if( status != 0 )
4071 goto cleanup;
4072 break;
4073#endif /* MBEDTLS_CCM_C */
4074
4075#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004076 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4077 operation->core_alg = PSA_ALG_GCM;
4078 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004079 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4080 * The call to mbedtls_gcm_crypt_and_tag or
4081 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004082 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004083 return( PSA_ERROR_INVALID_ARGUMENT );
4084 mbedtls_gcm_init( &operation->ctx.gcm );
4085 status = mbedtls_to_psa_error(
4086 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
4087 operation->slot->data.raw.data,
4088 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004089 if( status != 0 )
4090 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004091 break;
4092#endif /* MBEDTLS_GCM_C */
4093
Gilles Peskine26869f22019-05-06 15:25:00 +02004094#if defined(MBEDTLS_CHACHAPOLY_C)
4095 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4096 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4097 operation->full_tag_length = 16;
4098 /* We only support the default tag length. */
4099 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4100 return( PSA_ERROR_NOT_SUPPORTED );
4101 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4102 status = mbedtls_to_psa_error(
4103 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
4104 operation->slot->data.raw.data ) );
4105 if( status != 0 )
4106 goto cleanup;
4107 break;
4108#endif /* MBEDTLS_CHACHAPOLY_C */
4109
Gilles Peskineedf9a652018-08-17 18:11:56 +02004110 default:
4111 return( PSA_ERROR_NOT_SUPPORTED );
4112 }
4113
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004114 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4115 {
4116 status = PSA_ERROR_INVALID_ARGUMENT;
4117 goto cleanup;
4118 }
4119 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004120
Gilles Peskineedf9a652018-08-17 18:11:56 +02004121 return( PSA_SUCCESS );
4122
4123cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004124 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004125 return( status );
4126}
4127
Gilles Peskinec5487a82018-12-03 18:08:14 +01004128psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004129 psa_algorithm_t alg,
4130 const uint8_t *nonce,
4131 size_t nonce_length,
4132 const uint8_t *additional_data,
4133 size_t additional_data_length,
4134 const uint8_t *plaintext,
4135 size_t plaintext_length,
4136 uint8_t *ciphertext,
4137 size_t ciphertext_size,
4138 size_t *ciphertext_length )
4139{
mohammad16035955c982018-04-26 00:53:03 +03004140 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004141 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004142 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004143
mohammad1603f08a5502018-06-03 15:05:47 +03004144 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004145
Gilles Peskinec5487a82018-12-03 18:08:14 +01004146 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004147 if( status != PSA_SUCCESS )
4148 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004149
Gilles Peskineedf9a652018-08-17 18:11:56 +02004150 /* For all currently supported modes, the tag is at the end of the
4151 * ciphertext. */
4152 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4153 {
4154 status = PSA_ERROR_BUFFER_TOO_SMALL;
4155 goto exit;
4156 }
4157 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004158
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004159#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004160 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004161 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004162 status = mbedtls_to_psa_error(
4163 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4164 MBEDTLS_GCM_ENCRYPT,
4165 plaintext_length,
4166 nonce, nonce_length,
4167 additional_data, additional_data_length,
4168 plaintext, ciphertext,
4169 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004170 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004171 else
4172#endif /* MBEDTLS_GCM_C */
4173#if defined(MBEDTLS_CCM_C)
4174 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004175 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004176 status = mbedtls_to_psa_error(
4177 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4178 plaintext_length,
4179 nonce, nonce_length,
4180 additional_data,
4181 additional_data_length,
4182 plaintext, ciphertext,
4183 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004184 }
mohammad16035c8845f2018-05-09 05:40:09 -07004185 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004186#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004187#if defined(MBEDTLS_CHACHAPOLY_C)
4188 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4189 {
4190 if( nonce_length != 12 || operation.tag_length != 16 )
4191 {
4192 status = PSA_ERROR_NOT_SUPPORTED;
4193 goto exit;
4194 }
4195 status = mbedtls_to_psa_error(
4196 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4197 plaintext_length,
4198 nonce,
4199 additional_data,
4200 additional_data_length,
4201 plaintext,
4202 ciphertext,
4203 tag ) );
4204 }
4205 else
4206#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004207 {
mohammad1603554faad2018-06-03 15:07:38 +03004208 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004209 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004210
Gilles Peskineedf9a652018-08-17 18:11:56 +02004211 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4212 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004213
Gilles Peskineedf9a652018-08-17 18:11:56 +02004214exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004215 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004216 if( status == PSA_SUCCESS )
4217 *ciphertext_length = plaintext_length + operation.tag_length;
4218 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004219}
4220
Gilles Peskineee652a32018-06-01 19:23:52 +02004221/* Locate the tag in a ciphertext buffer containing the encrypted data
4222 * followed by the tag. Return the length of the part preceding the tag in
4223 * *plaintext_length. This is the size of the plaintext in modes where
4224 * the encrypted data has the same size as the plaintext, such as
4225 * CCM and GCM. */
4226static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4227 const uint8_t *ciphertext,
4228 size_t ciphertext_length,
4229 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004230 const uint8_t **p_tag )
4231{
4232 size_t payload_length;
4233 if( tag_length > ciphertext_length )
4234 return( PSA_ERROR_INVALID_ARGUMENT );
4235 payload_length = ciphertext_length - tag_length;
4236 if( payload_length > plaintext_size )
4237 return( PSA_ERROR_BUFFER_TOO_SMALL );
4238 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004239 return( PSA_SUCCESS );
4240}
4241
Gilles Peskinec5487a82018-12-03 18:08:14 +01004242psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004243 psa_algorithm_t alg,
4244 const uint8_t *nonce,
4245 size_t nonce_length,
4246 const uint8_t *additional_data,
4247 size_t additional_data_length,
4248 const uint8_t *ciphertext,
4249 size_t ciphertext_length,
4250 uint8_t *plaintext,
4251 size_t plaintext_size,
4252 size_t *plaintext_length )
4253{
mohammad16035955c982018-04-26 00:53:03 +03004254 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004255 aead_operation_t operation;
4256 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004257
Gilles Peskineee652a32018-06-01 19:23:52 +02004258 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004259
Gilles Peskinec5487a82018-12-03 18:08:14 +01004260 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004261 if( status != PSA_SUCCESS )
4262 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004263
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004264 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4265 ciphertext, ciphertext_length,
4266 plaintext_size, &tag );
4267 if( status != PSA_SUCCESS )
4268 goto exit;
4269
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004270#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004271 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004272 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004273 status = mbedtls_to_psa_error(
4274 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4275 ciphertext_length - operation.tag_length,
4276 nonce, nonce_length,
4277 additional_data,
4278 additional_data_length,
4279 tag, operation.tag_length,
4280 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004281 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004282 else
4283#endif /* MBEDTLS_GCM_C */
4284#if defined(MBEDTLS_CCM_C)
4285 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004286 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004287 status = mbedtls_to_psa_error(
4288 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4289 ciphertext_length - operation.tag_length,
4290 nonce, nonce_length,
4291 additional_data,
4292 additional_data_length,
4293 ciphertext, plaintext,
4294 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004295 }
mohammad160339574652018-06-01 04:39:53 -07004296 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004297#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004298#if defined(MBEDTLS_CHACHAPOLY_C)
4299 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4300 {
4301 if( nonce_length != 12 || operation.tag_length != 16 )
4302 {
4303 status = PSA_ERROR_NOT_SUPPORTED;
4304 goto exit;
4305 }
4306 status = mbedtls_to_psa_error(
4307 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4308 ciphertext_length - operation.tag_length,
4309 nonce,
4310 additional_data,
4311 additional_data_length,
4312 tag,
4313 ciphertext,
4314 plaintext ) );
4315 }
4316 else
4317#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004318 {
mohammad1603554faad2018-06-03 15:07:38 +03004319 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004320 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004321
Gilles Peskineedf9a652018-08-17 18:11:56 +02004322 if( status != PSA_SUCCESS && plaintext_size != 0 )
4323 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004324
Gilles Peskineedf9a652018-08-17 18:11:56 +02004325exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004326 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004327 if( status == PSA_SUCCESS )
4328 *plaintext_length = ciphertext_length - operation.tag_length;
4329 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004330}
4331
Gilles Peskinea0655c32018-04-30 17:06:50 +02004332
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004333
Gilles Peskine20035e32018-02-03 22:44:14 +01004334/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004335/* Generators */
4336/****************************************************************/
4337
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004338#define HKDF_STATE_INIT 0 /* no input yet */
4339#define HKDF_STATE_STARTED 1 /* got salt */
4340#define HKDF_STATE_KEYED 2 /* got key */
4341#define HKDF_STATE_OUTPUT 3 /* output started */
4342
Gilles Peskinecbe66502019-05-16 16:59:18 +02004343static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004344 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004345{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004346 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4347 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004348 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004349 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004350}
4351
4352
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004353psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004354{
4355 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004356 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004357 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +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. */
4362 }
4363 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004364#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004365 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004366 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004367 mbedtls_free( operation->ctx.hkdf.info );
4368 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004369 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004370 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004371 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004372 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004373 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004374 if( operation->ctx.tls12_prf.seed != NULL )
4375 {
4376 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4377 operation->ctx.tls12_prf.seed_length );
4378 mbedtls_free( operation->ctx.tls12_prf.seed );
4379 }
4380
4381 if( operation->ctx.tls12_prf.label != NULL )
4382 {
4383 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4384 operation->ctx.tls12_prf.label_length );
4385 mbedtls_free( operation->ctx.tls12_prf.label );
4386 }
4387
4388 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4389
4390 /* We leave the fields Ai and output_block to be erased safely by the
4391 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004392 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004393 else
4394#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004395 {
4396 status = PSA_ERROR_BAD_STATE;
4397 }
Janos Follath083036a2019-06-11 10:22:26 +01004398 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004399 return( status );
4400}
4401
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004402psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004403 size_t *capacity)
4404{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004405 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004406 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004407 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004408 return PSA_ERROR_BAD_STATE;
4409 }
4410
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004411 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004412 return( PSA_SUCCESS );
4413}
4414
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004415psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004416 size_t capacity )
4417{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004418 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004419 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004420 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004421 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004422 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004423 return( PSA_SUCCESS );
4424}
4425
Gilles Peskinebef7f142018-07-12 17:22:21 +02004426#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004427/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004428 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004429static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004430 psa_algorithm_t hash_alg,
4431 uint8_t *output,
4432 size_t output_length )
4433{
4434 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4435 psa_status_t status;
4436
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004437 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4438 return( PSA_ERROR_BAD_STATE );
4439 hkdf->state = HKDF_STATE_OUTPUT;
4440
Gilles Peskinebef7f142018-07-12 17:22:21 +02004441 while( output_length != 0 )
4442 {
4443 /* Copy what remains of the current block */
4444 uint8_t n = hash_length - hkdf->offset_in_block;
4445 if( n > output_length )
4446 n = (uint8_t) output_length;
4447 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4448 output += n;
4449 output_length -= n;
4450 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004451 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004452 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004453 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004454 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004455 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004456 * object was corrupted or if this function is called directly
4457 * inside the library. */
4458 if( hkdf->block_number == 0xff )
4459 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004460
4461 /* We need a new block */
4462 ++hkdf->block_number;
4463 hkdf->offset_in_block = 0;
4464 status = psa_hmac_setup_internal( &hkdf->hmac,
4465 hkdf->prk, hash_length,
4466 hash_alg );
4467 if( status != PSA_SUCCESS )
4468 return( status );
4469 if( hkdf->block_number != 1 )
4470 {
4471 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4472 hkdf->output_block,
4473 hash_length );
4474 if( status != PSA_SUCCESS )
4475 return( status );
4476 }
4477 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4478 hkdf->info,
4479 hkdf->info_length );
4480 if( status != PSA_SUCCESS )
4481 return( status );
4482 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4483 &hkdf->block_number, 1 );
4484 if( status != PSA_SUCCESS )
4485 return( status );
4486 status = psa_hmac_finish_internal( &hkdf->hmac,
4487 hkdf->output_block,
4488 sizeof( hkdf->output_block ) );
4489 if( status != PSA_SUCCESS )
4490 return( status );
4491 }
4492
4493 return( PSA_SUCCESS );
4494}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004495
Janos Follath7742fee2019-06-17 12:58:10 +01004496static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4497 psa_tls12_prf_key_derivation_t *tls12_prf,
4498 psa_algorithm_t alg )
4499{
4500 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4501 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004502 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4503 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004504
Janos Follath7742fee2019-06-17 12:58:10 +01004505 /* We can't be wanting more output after block 0xff, otherwise
4506 * the capacity check in psa_key_derivation_output_bytes() would have
4507 * prevented this call. It could happen only if the operation
4508 * object was corrupted or if this function is called directly
4509 * inside the library. */
4510 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004511 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004512
4513 /* We need a new block */
4514 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004515 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004516
4517 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4518 *
4519 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4520 *
4521 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4522 * HMAC_hash(secret, A(2) + seed) +
4523 * HMAC_hash(secret, A(3) + seed) + ...
4524 *
4525 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004526 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004527 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004528 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004529 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004530 * is currently extracted as `output_block` and where i is
4531 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004532 */
4533
Janos Follathea29bfb2019-06-19 12:21:20 +01004534 /* Save the hash context before using it, to preserve the hash state with
4535 * only the inner padding in it. We need this, because inner padding depends
4536 * on the key (secret in the RFC's terminology). */
4537 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4538 if( status != PSA_SUCCESS )
4539 goto cleanup;
4540
4541 /* Calculate A(i) where i = tls12_prf->block_number. */
4542 if( tls12_prf->block_number == 1 )
4543 {
4544 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4545 * the variable seed and in this instance means it in the context of the
4546 * P_hash function, where seed = label + seed.) */
4547 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4548 tls12_prf->label, tls12_prf->label_length );
4549 if( status != PSA_SUCCESS )
4550 goto cleanup;
4551 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4552 tls12_prf->seed, tls12_prf->seed_length );
4553 if( status != PSA_SUCCESS )
4554 goto cleanup;
4555 }
4556 else
4557 {
4558 /* A(i) = HMAC_hash(secret, A(i-1)) */
4559 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4560 tls12_prf->Ai, hash_length );
4561 if( status != PSA_SUCCESS )
4562 goto cleanup;
4563 }
4564
4565 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4566 tls12_prf->Ai, hash_length );
4567 if( status != PSA_SUCCESS )
4568 goto cleanup;
4569 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4570 if( status != PSA_SUCCESS )
4571 goto cleanup;
4572
4573 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4574 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4575 tls12_prf->Ai, hash_length );
4576 if( status != PSA_SUCCESS )
4577 goto cleanup;
4578 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4579 tls12_prf->label, tls12_prf->label_length );
4580 if( status != PSA_SUCCESS )
4581 goto cleanup;
4582 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4583 tls12_prf->seed, tls12_prf->seed_length );
4584 if( status != PSA_SUCCESS )
4585 goto cleanup;
4586 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4587 tls12_prf->output_block, hash_length );
4588 if( status != PSA_SUCCESS )
4589 goto cleanup;
4590 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4591 if( status != PSA_SUCCESS )
4592 goto cleanup;
4593
Janos Follath7742fee2019-06-17 12:58:10 +01004594
4595cleanup:
4596
Janos Follathea29bfb2019-06-19 12:21:20 +01004597 cleanup_status = psa_hash_abort( &backup );
4598 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4599 status = cleanup_status;
4600
4601 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004602}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004603
Janos Follath844eb0e2019-06-19 12:10:49 +01004604static psa_status_t psa_key_derivation_tls12_prf_read(
4605 psa_tls12_prf_key_derivation_t *tls12_prf,
4606 psa_algorithm_t alg,
4607 uint8_t *output,
4608 size_t output_length )
4609{
4610 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4611 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4612 psa_status_t status;
4613 uint8_t offset, length;
4614
4615 while( output_length != 0 )
4616 {
4617 /* Check if we have fully processed the current block. */
4618 if( tls12_prf->left_in_block == 0 )
4619 {
4620 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4621 alg );
4622 if( status != PSA_SUCCESS )
4623 return( status );
4624
4625 continue;
4626 }
4627
4628 if( tls12_prf->left_in_block > output_length )
4629 length = (uint8_t) output_length;
4630 else
4631 length = tls12_prf->left_in_block;
4632
4633 offset = hash_length - tls12_prf->left_in_block;
4634 memcpy( output, tls12_prf->output_block + offset, length );
4635 output += length;
4636 output_length -= length;
4637 tls12_prf->left_in_block -= length;
4638 }
4639
4640 return( PSA_SUCCESS );
4641}
Gilles Peskinebef7f142018-07-12 17:22:21 +02004642#endif /* MBEDTLS_MD_C */
4643
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004644psa_status_t psa_key_derivation_output_bytes(
4645 psa_key_derivation_operation_t *operation,
4646 uint8_t *output,
4647 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004648{
4649 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004650 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004651
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004652 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004653 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004654 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004655 return PSA_ERROR_BAD_STATE;
4656 }
4657
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004658 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004659 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004660 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004661 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004662 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004663 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004664 goto exit;
4665 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004666 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004667 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004668 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004669 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004670 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4671 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004672 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004673 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004674 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004675 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004676 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004677
Gilles Peskinebef7f142018-07-12 17:22:21 +02004678#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004679 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004680 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004681 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004682 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004683 output, output_length );
4684 }
Janos Follathadbec812019-06-14 11:05:39 +01004685 else
Janos Follathadbec812019-06-14 11:05:39 +01004686 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004687 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004688 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004689 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004690 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004691 output_length );
4692 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004693 else
4694#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004695 {
4696 return( PSA_ERROR_BAD_STATE );
4697 }
4698
4699exit:
4700 if( status != PSA_SUCCESS )
4701 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004702 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004703 * This allows us to differentiate between exhausted operations and
4704 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4705 * operations. */
4706 psa_algorithm_t alg = operation->alg;
4707 psa_key_derivation_abort( operation );
4708 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004709 memset( output, '!', output_length );
4710 }
4711 return( status );
4712}
4713
Gilles Peskine08542d82018-07-19 17:05:42 +02004714#if defined(MBEDTLS_DES_C)
4715static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4716{
4717 if( data_size >= 8 )
4718 mbedtls_des_key_set_parity( data );
4719 if( data_size >= 16 )
4720 mbedtls_des_key_set_parity( data + 8 );
4721 if( data_size >= 24 )
4722 mbedtls_des_key_set_parity( data + 16 );
4723}
4724#endif /* MBEDTLS_DES_C */
4725
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004726static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004727 psa_key_slot_t *slot,
4728 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004729 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004730{
4731 uint8_t *data = NULL;
4732 size_t bytes = PSA_BITS_TO_BYTES( bits );
4733 psa_status_t status;
4734
Gilles Peskine8e338702019-07-30 20:06:31 +02004735 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004736 return( PSA_ERROR_INVALID_ARGUMENT );
4737 if( bits % 8 != 0 )
4738 return( PSA_ERROR_INVALID_ARGUMENT );
4739 data = mbedtls_calloc( 1, bytes );
4740 if( data == NULL )
4741 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4742
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004743 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004744 if( status != PSA_SUCCESS )
4745 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02004746#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004747 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004748 psa_des_set_key_parity( data, bytes );
4749#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004750 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004751
4752exit:
4753 mbedtls_free( data );
4754 return( status );
4755}
4756
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004757psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004758 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004759 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004760{
4761 psa_status_t status;
4762 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004763 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004764
4765 /* Reject any attempt to create a zero-length key so that we don't
4766 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4767 if( psa_get_key_bits( attributes ) == 0 )
4768 return( PSA_ERROR_INVALID_ARGUMENT );
4769
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004770 if( ! operation->can_output_key )
4771 return( PSA_ERROR_NOT_PERMITTED );
4772
Gilles Peskinedf179142019-07-15 22:02:14 +02004773 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
4774 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004775#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4776 if( driver != NULL )
4777 {
4778 /* Deriving a key in a secure element is not implemented yet. */
4779 status = PSA_ERROR_NOT_SUPPORTED;
4780 }
4781#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004782 if( status == PSA_SUCCESS )
4783 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004784 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004785 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004786 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004787 }
4788 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004789 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004790 if( status != PSA_SUCCESS )
4791 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004792 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004793 *handle = 0;
4794 }
4795 return( status );
4796}
4797
Gilles Peskineeab56e42018-07-12 17:12:33 +02004798
4799
4800/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004801/* Key derivation */
4802/****************************************************************/
4803
Gilles Peskine969c5d62019-01-16 15:53:06 +01004804static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004805 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004806 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004807{
Janos Follath5fe19732019-06-20 15:09:30 +01004808 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4809 * initialisers for this union leave some bytes unspecified.) */
4810 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4811
Gilles Peskine969c5d62019-01-16 15:53:06 +01004812 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004813#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004814 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
4815 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4816 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004817 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004818 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004819 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4820 if( hash_size == 0 )
4821 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004822 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4823 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004824 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004825 {
4826 return( PSA_ERROR_NOT_SUPPORTED );
4827 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004828 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004829 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004830 }
4831#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004832 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004833 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004834}
4835
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004836psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004837 psa_algorithm_t alg )
4838{
4839 psa_status_t status;
4840
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004841 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004842 return( PSA_ERROR_BAD_STATE );
4843
Gilles Peskine6843c292019-01-18 16:44:49 +01004844 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4845 return( PSA_ERROR_INVALID_ARGUMENT );
4846 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004847 {
4848 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004849 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004850 }
4851 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4852 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004853 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004854 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004855 else
4856 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004857
4858 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004859 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004860 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004861}
4862
4863#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004864static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004865 psa_algorithm_t hash_alg,
4866 psa_key_derivation_step_t step,
4867 const uint8_t *data,
4868 size_t data_length )
4869{
4870 psa_status_t status;
4871 switch( step )
4872 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004873 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004874 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004875 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004876 status = psa_hmac_setup_internal( &hkdf->hmac,
4877 data, data_length,
4878 hash_alg );
4879 if( status != PSA_SUCCESS )
4880 return( status );
4881 hkdf->state = HKDF_STATE_STARTED;
4882 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004883 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004884 /* If no salt was provided, use an empty salt. */
4885 if( hkdf->state == HKDF_STATE_INIT )
4886 {
4887 status = psa_hmac_setup_internal( &hkdf->hmac,
4888 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004889 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004890 if( status != PSA_SUCCESS )
4891 return( status );
4892 hkdf->state = HKDF_STATE_STARTED;
4893 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004894 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004895 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004896 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4897 data, data_length );
4898 if( status != PSA_SUCCESS )
4899 return( status );
4900 status = psa_hmac_finish_internal( &hkdf->hmac,
4901 hkdf->prk,
4902 sizeof( hkdf->prk ) );
4903 if( status != PSA_SUCCESS )
4904 return( status );
4905 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4906 hkdf->block_number = 0;
4907 hkdf->state = HKDF_STATE_KEYED;
4908 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004909 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004910 if( hkdf->state == HKDF_STATE_OUTPUT )
4911 return( PSA_ERROR_BAD_STATE );
4912 if( hkdf->info_set )
4913 return( PSA_ERROR_BAD_STATE );
4914 hkdf->info_length = data_length;
4915 if( data_length != 0 )
4916 {
4917 hkdf->info = mbedtls_calloc( 1, data_length );
4918 if( hkdf->info == NULL )
4919 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4920 memcpy( hkdf->info, data, data_length );
4921 }
4922 hkdf->info_set = 1;
4923 return( PSA_SUCCESS );
4924 default:
4925 return( PSA_ERROR_INVALID_ARGUMENT );
4926 }
4927}
Janos Follathb03233e2019-06-11 15:30:30 +01004928
Janos Follathf08e2652019-06-13 09:05:41 +01004929static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4930 const uint8_t *data,
4931 size_t data_length )
4932{
4933 if( prf->state != TLS12_PRF_STATE_INIT )
4934 return( PSA_ERROR_BAD_STATE );
4935
Janos Follathd6dce9f2019-07-04 09:11:38 +01004936 if( data_length != 0 )
4937 {
4938 prf->seed = mbedtls_calloc( 1, data_length );
4939 if( prf->seed == NULL )
4940 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004941
Janos Follathd6dce9f2019-07-04 09:11:38 +01004942 memcpy( prf->seed, data, data_length );
4943 prf->seed_length = data_length;
4944 }
Janos Follathf08e2652019-06-13 09:05:41 +01004945
4946 prf->state = TLS12_PRF_STATE_SEED_SET;
4947
4948 return( PSA_SUCCESS );
4949}
4950
Janos Follath81550542019-06-13 14:26:34 +01004951static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4952 psa_algorithm_t hash_alg,
4953 const uint8_t *data,
4954 size_t data_length )
4955{
4956 psa_status_t status;
4957 if( prf->state != TLS12_PRF_STATE_SEED_SET )
4958 return( PSA_ERROR_BAD_STATE );
4959
4960 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4961 if( status != PSA_SUCCESS )
4962 return( status );
4963
4964 prf->state = TLS12_PRF_STATE_KEY_SET;
4965
4966 return( PSA_SUCCESS );
4967}
4968
Janos Follath6660f0e2019-06-17 08:44:03 +01004969static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4970 psa_tls12_prf_key_derivation_t *prf,
4971 psa_algorithm_t hash_alg,
4972 const uint8_t *data,
4973 size_t data_length )
4974{
4975 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004976 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
4977 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01004978
4979 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4980 return( PSA_ERROR_INVALID_ARGUMENT );
4981
4982 /* Quoting RFC 4279, Section 2:
4983 *
4984 * The premaster secret is formed as follows: if the PSK is N octets
4985 * long, concatenate a uint16 with the value N, N zero octets, a second
4986 * uint16 with the value N, and the PSK itself.
4987 */
4988
Janos Follath40e13932019-06-26 13:22:29 +01004989 *cur++ = ( data_length >> 8 ) & 0xff;
4990 *cur++ = ( data_length >> 0 ) & 0xff;
4991 memset( cur, 0, data_length );
4992 cur += data_length;
4993 *cur++ = pms[0];
4994 *cur++ = pms[1];
4995 memcpy( cur, data, data_length );
4996 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01004997
Janos Follath40e13932019-06-26 13:22:29 +01004998 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01004999
5000 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5001 return( status );
5002}
5003
Janos Follath63028dd2019-06-13 09:15:47 +01005004static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5005 const uint8_t *data,
5006 size_t data_length )
5007{
5008 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5009 return( PSA_ERROR_BAD_STATE );
5010
Janos Follathd6dce9f2019-07-04 09:11:38 +01005011 if( data_length != 0 )
5012 {
5013 prf->label = mbedtls_calloc( 1, data_length );
5014 if( prf->label == NULL )
5015 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005016
Janos Follathd6dce9f2019-07-04 09:11:38 +01005017 memcpy( prf->label, data, data_length );
5018 prf->label_length = data_length;
5019 }
Janos Follath63028dd2019-06-13 09:15:47 +01005020
5021 prf->state = TLS12_PRF_STATE_LABEL_SET;
5022
5023 return( PSA_SUCCESS );
5024}
5025
Janos Follathb03233e2019-06-11 15:30:30 +01005026static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5027 psa_algorithm_t hash_alg,
5028 psa_key_derivation_step_t step,
5029 const uint8_t *data,
5030 size_t data_length )
5031{
Janos Follathb03233e2019-06-11 15:30:30 +01005032 switch( step )
5033 {
Janos Follathf08e2652019-06-13 09:05:41 +01005034 case PSA_KEY_DERIVATION_INPUT_SEED:
5035 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005036 case PSA_KEY_DERIVATION_INPUT_SECRET:
5037 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005038 case PSA_KEY_DERIVATION_INPUT_LABEL:
5039 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005040 default:
5041 return( PSA_ERROR_INVALID_ARGUMENT );
5042 }
5043}
Janos Follath6660f0e2019-06-17 08:44:03 +01005044
5045static psa_status_t psa_tls12_prf_psk_to_ms_input(
5046 psa_tls12_prf_key_derivation_t *prf,
5047 psa_algorithm_t hash_alg,
5048 psa_key_derivation_step_t step,
5049 const uint8_t *data,
5050 size_t data_length )
5051{
5052 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005053 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005054 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5055 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005056 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005057
5058 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5059}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005060#endif /* MBEDTLS_MD_C */
5061
Gilles Peskineb8965192019-09-24 16:21:10 +02005062/** Check whether the given key type is acceptable for the given
5063 * input step of a key derivation.
5064 *
5065 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5066 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5067 * Both secret and non-secret inputs can alternatively have the type
5068 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5069 * that the input was passed as a buffer rather than via a key object.
5070 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005071static int psa_key_derivation_check_input_type(
5072 psa_key_derivation_step_t step,
5073 psa_key_type_t key_type )
5074{
5075 switch( step )
5076 {
5077 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005078 if( key_type == PSA_KEY_TYPE_DERIVE )
5079 return( PSA_SUCCESS );
5080 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005081 return( PSA_SUCCESS );
5082 break;
5083 case PSA_KEY_DERIVATION_INPUT_LABEL:
5084 case PSA_KEY_DERIVATION_INPUT_SALT:
5085 case PSA_KEY_DERIVATION_INPUT_INFO:
5086 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005087 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5088 return( PSA_SUCCESS );
5089 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005090 return( PSA_SUCCESS );
5091 break;
5092 }
5093 return( PSA_ERROR_INVALID_ARGUMENT );
5094}
5095
Janos Follathb80a94e2019-06-12 15:54:46 +01005096static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005097 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005098 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005099 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005100 const uint8_t *data,
5101 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005102{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005103 psa_status_t status;
5104 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5105
5106 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005107 if( status != PSA_SUCCESS )
5108 goto exit;
5109
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005110#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005111 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005112 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005113 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005114 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005115 step, data, data_length );
5116 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005117 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005118 {
Janos Follathb03233e2019-06-11 15:30:30 +01005119 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5120 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5121 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005122 }
5123 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5124 {
5125 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5126 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5127 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005128 }
5129 else
5130#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005131 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005132 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005133 return( PSA_ERROR_BAD_STATE );
5134 }
5135
Gilles Peskine224b0d62019-09-23 18:13:17 +02005136exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005137 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005138 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005139 return( status );
5140}
5141
Janos Follath51f4a0f2019-06-14 11:35:55 +01005142psa_status_t psa_key_derivation_input_bytes(
5143 psa_key_derivation_operation_t *operation,
5144 psa_key_derivation_step_t step,
5145 const uint8_t *data,
5146 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005147{
Gilles Peskineb8965192019-09-24 16:21:10 +02005148 return( psa_key_derivation_input_internal( operation, step,
5149 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005150 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005151}
5152
Janos Follath51f4a0f2019-06-14 11:35:55 +01005153psa_status_t psa_key_derivation_input_key(
5154 psa_key_derivation_operation_t *operation,
5155 psa_key_derivation_step_t step,
5156 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005157{
5158 psa_key_slot_t *slot;
5159 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005160
Gilles Peskine28f8f302019-07-24 13:30:31 +02005161 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005162 PSA_KEY_USAGE_DERIVE,
5163 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005164 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005165 {
5166 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005167 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005168 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005169
5170 /* Passing a key object as a SECRET input unlocks the permission
5171 * to output to a key object. */
5172 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5173 operation->can_output_key = 1;
5174
Janos Follathb80a94e2019-06-12 15:54:46 +01005175 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005176 step, slot->attr.type,
Janos Follathb80a94e2019-06-12 15:54:46 +01005177 slot->data.raw.data,
5178 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005179}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005180
5181
5182
5183/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005184/* Key agreement */
5185/****************************************************************/
5186
Gilles Peskinea05219c2018-11-16 16:02:56 +01005187#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005188static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5189 size_t peer_key_length,
5190 const mbedtls_ecp_keypair *our_key,
5191 uint8_t *shared_secret,
5192 size_t shared_secret_size,
5193 size_t *shared_secret_length )
5194{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005195 mbedtls_ecp_keypair *their_key = NULL;
5196 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005197 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005198 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005199
Jaeden Ameroccdce902019-01-10 11:42:27 +00005200 status = psa_import_ec_public_key(
5201 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5202 peer_key, peer_key_length,
5203 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005204 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005205 goto exit;
5206
Jaeden Amero97271b32019-01-10 19:38:51 +00005207 status = mbedtls_to_psa_error(
5208 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5209 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005210 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005211 status = mbedtls_to_psa_error(
5212 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5213 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005214 goto exit;
5215
Jaeden Amero97271b32019-01-10 19:38:51 +00005216 status = mbedtls_to_psa_error(
5217 mbedtls_ecdh_calc_secret( &ecdh,
5218 shared_secret_length,
5219 shared_secret, shared_secret_size,
5220 mbedtls_ctr_drbg_random,
5221 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005222
5223exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005224 mbedtls_ecdh_free( &ecdh );
Jaeden Ameroccdce902019-01-10 11:42:27 +00005225 mbedtls_ecp_keypair_free( their_key );
5226 mbedtls_free( their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005227 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005228}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005229#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005230
Gilles Peskine01d718c2018-09-18 12:01:02 +02005231#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5232
Gilles Peskine0216fe12019-04-11 21:23:21 +02005233static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5234 psa_key_slot_t *private_key,
5235 const uint8_t *peer_key,
5236 size_t peer_key_length,
5237 uint8_t *shared_secret,
5238 size_t shared_secret_size,
5239 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005240{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005241 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005242 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005243#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005244 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005245 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005246 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005247 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5248 private_key->data.ecp,
5249 shared_secret, shared_secret_size,
5250 shared_secret_length ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005251#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005252 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005253 (void) private_key;
5254 (void) peer_key;
5255 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005256 (void) shared_secret;
5257 (void) shared_secret_size;
5258 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005259 return( PSA_ERROR_NOT_SUPPORTED );
5260 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005261}
5262
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005263/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005264 * to potentially free embedded data structures and wipe confidential data.
5265 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005266static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005267 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005268 psa_key_slot_t *private_key,
5269 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005270 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005271{
5272 psa_status_t status;
5273 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5274 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005275 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005276
5277 /* Step 1: run the secret agreement algorithm to generate the shared
5278 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005279 status = psa_key_agreement_raw_internal( ka_alg,
5280 private_key,
5281 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005282 shared_secret,
5283 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005284 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005285 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005286 goto exit;
5287
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005288 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005289 * the shared secret. A shared secret is permitted wherever a key
5290 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005291 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005292 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005293 shared_secret,
5294 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005295
Gilles Peskine12313cd2018-06-20 00:20:32 +02005296exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005297 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005298 return( status );
5299}
5300
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005301psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005302 psa_key_derivation_step_t step,
5303 psa_key_handle_t private_key,
5304 const uint8_t *peer_key,
5305 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005306{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005307 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005308 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005309 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005310 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005311 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005312 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005313 if( status != PSA_SUCCESS )
5314 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005315 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005316 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005317 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005318 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005319 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005320 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005321}
5322
Gilles Peskinebe697d82019-05-16 18:00:41 +02005323psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5324 psa_key_handle_t private_key,
5325 const uint8_t *peer_key,
5326 size_t peer_key_length,
5327 uint8_t *output,
5328 size_t output_size,
5329 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005330{
5331 psa_key_slot_t *slot;
5332 psa_status_t status;
5333
5334 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5335 {
5336 status = PSA_ERROR_INVALID_ARGUMENT;
5337 goto exit;
5338 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005339 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005340 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005341 if( status != PSA_SUCCESS )
5342 goto exit;
5343
5344 status = psa_key_agreement_raw_internal( alg, slot,
5345 peer_key, peer_key_length,
5346 output, output_size,
5347 output_length );
5348
5349exit:
5350 if( status != PSA_SUCCESS )
5351 {
5352 /* If an error happens and is not handled properly, the output
5353 * may be used as a key to protect sensitive data. Arrange for such
5354 * a key to be random, which is likely to result in decryption or
5355 * verification errors. This is better than filling the buffer with
5356 * some constant data such as zeros, which would result in the data
5357 * being protected with a reproducible, easily knowable key.
5358 */
5359 psa_generate_random( output, output_size );
5360 *output_length = output_size;
5361 }
5362 return( status );
5363}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005364
5365
5366/****************************************************************/
5367/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005368/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005369
Gilles Peskine4c317f42018-07-12 01:24:09 +02005370psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005371 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005372{
Janos Follath24eed8d2019-11-22 13:21:35 +00005373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005374 GUARD_MODULE_INITIALIZED;
5375
Gilles Peskinef181eca2019-08-07 13:49:00 +02005376 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5377 {
5378 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5379 output,
5380 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5381 if( ret != 0 )
5382 return( mbedtls_to_psa_error( ret ) );
5383 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5384 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5385 }
5386
Gilles Peskinee59236f2018-01-27 23:32:46 +01005387 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5388 return( mbedtls_to_psa_error( ret ) );
5389}
5390
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005391#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5392#include "mbedtls/entropy_poll.h"
5393
Gilles Peskine7228da22019-07-15 11:06:15 +02005394psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005395 size_t seed_size )
5396{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005397 if( global_data.initialized )
5398 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005399
5400 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5401 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5402 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5403 return( PSA_ERROR_INVALID_ARGUMENT );
5404
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005405 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005406}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005407#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005408
Gilles Peskinee56e8782019-04-26 17:34:02 +02005409#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5410static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5411 size_t domain_parameters_size,
5412 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005413{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005414 size_t i;
5415 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005416
Gilles Peskinee56e8782019-04-26 17:34:02 +02005417 if( domain_parameters_size == 0 )
5418 {
5419 *exponent = 65537;
5420 return( PSA_SUCCESS );
5421 }
5422
5423 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5424 * support values that fit in a 32-bit integer, which is larger than
5425 * int on just about every platform anyway. */
5426 if( domain_parameters_size > sizeof( acc ) )
5427 return( PSA_ERROR_NOT_SUPPORTED );
5428 for( i = 0; i < domain_parameters_size; i++ )
5429 acc = ( acc << 8 ) | domain_parameters[i];
5430 if( acc > INT_MAX )
5431 return( PSA_ERROR_NOT_SUPPORTED );
5432 *exponent = acc;
5433 return( PSA_SUCCESS );
5434}
5435#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5436
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005437static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005438 psa_key_slot_t *slot, size_t bits,
5439 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005440{
Gilles Peskine8e338702019-07-30 20:06:31 +02005441 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005442
Gilles Peskinee56e8782019-04-26 17:34:02 +02005443 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005444 return( PSA_ERROR_INVALID_ARGUMENT );
5445
Gilles Peskinee59236f2018-01-27 23:32:46 +01005446 if( key_type_is_raw_bytes( type ) )
5447 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005448 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005449 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
5450 if( status != PSA_SUCCESS )
5451 return( status );
5452 status = psa_generate_random( slot->data.raw.data,
5453 slot->data.raw.bytes );
5454 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005455 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005456#if defined(MBEDTLS_DES_C)
5457 if( type == PSA_KEY_TYPE_DES )
5458 psa_des_set_key_parity( slot->data.raw.data,
5459 slot->data.raw.bytes );
5460#endif /* MBEDTLS_DES_C */
5461 }
5462 else
5463
5464#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005465 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005466 {
5467 mbedtls_rsa_context *rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00005468 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005469 int exponent;
5470 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005471 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5472 return( PSA_ERROR_NOT_SUPPORTED );
5473 /* Accept only byte-aligned keys, for the same reasons as
5474 * in psa_import_rsa_key(). */
5475 if( bits % 8 != 0 )
5476 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005477 status = psa_read_rsa_exponent( domain_parameters,
5478 domain_parameters_size,
5479 &exponent );
5480 if( status != PSA_SUCCESS )
5481 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005482 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5483 if( rsa == NULL )
5484 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5485 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5486 ret = mbedtls_rsa_gen_key( rsa,
5487 mbedtls_ctr_drbg_random,
5488 &global_data.ctr_drbg,
5489 (unsigned int) bits,
5490 exponent );
5491 if( ret != 0 )
5492 {
5493 mbedtls_rsa_free( rsa );
5494 mbedtls_free( rsa );
5495 return( mbedtls_to_psa_error( ret ) );
5496 }
5497 slot->data.rsa = rsa;
5498 }
5499 else
5500#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5501
5502#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005503 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005504 {
5505 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5506 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5507 const mbedtls_ecp_curve_info *curve_info =
5508 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5509 mbedtls_ecp_keypair *ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00005510 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005511 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005512 return( PSA_ERROR_NOT_SUPPORTED );
5513 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5514 return( PSA_ERROR_NOT_SUPPORTED );
5515 if( curve_info->bit_size != bits )
5516 return( PSA_ERROR_INVALID_ARGUMENT );
5517 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5518 if( ecp == NULL )
5519 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5520 mbedtls_ecp_keypair_init( ecp );
5521 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5522 mbedtls_ctr_drbg_random,
5523 &global_data.ctr_drbg );
5524 if( ret != 0 )
5525 {
5526 mbedtls_ecp_keypair_free( ecp );
5527 mbedtls_free( ecp );
5528 return( mbedtls_to_psa_error( ret ) );
5529 }
5530 slot->data.ecp = ecp;
5531 }
5532 else
5533#endif /* MBEDTLS_ECP_C */
5534
5535 return( PSA_ERROR_NOT_SUPPORTED );
5536
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005537 return( PSA_SUCCESS );
5538}
Darryl Green0c6575a2018-11-07 16:05:30 +00005539
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005540psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005541 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005542{
5543 psa_status_t status;
5544 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005545 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02005546
Gilles Peskine0f84d622019-09-12 19:03:13 +02005547 /* Reject any attempt to create a zero-length key so that we don't
5548 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5549 if( psa_get_key_bits( attributes ) == 0 )
5550 return( PSA_ERROR_INVALID_ARGUMENT );
5551
Gilles Peskinedf179142019-07-15 22:02:14 +02005552 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
5553 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005554 if( status != PSA_SUCCESS )
5555 goto exit;
5556
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005557#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5558 if( driver != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00005559 {
Gilles Peskine11792082019-08-06 18:36:36 +02005560 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
5561 size_t pubkey_length = 0; /* We don't support this feature yet */
5562 if( drv->key_management == NULL ||
5563 drv->key_management->p_generate == NULL )
5564 {
5565 status = PSA_ERROR_NOT_SUPPORTED;
5566 goto exit;
5567 }
5568 status = drv->key_management->p_generate(
5569 psa_get_se_driver_context( driver ),
5570 slot->data.se.slot_number, attributes,
5571 NULL, 0, &pubkey_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00005572 }
Gilles Peskine11792082019-08-06 18:36:36 +02005573 else
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005574#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005575 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005576 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005577 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005578 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005579 }
Gilles Peskine11792082019-08-06 18:36:36 +02005580
5581exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005582 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005583 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005584 if( status != PSA_SUCCESS )
5585 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005586 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005587 *handle = 0;
5588 }
Darryl Green0c6575a2018-11-07 16:05:30 +00005589 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005590}
5591
5592
Gilles Peskinee59236f2018-01-27 23:32:46 +01005593
5594/****************************************************************/
5595/* Module setup */
5596/****************************************************************/
5597
Gilles Peskine5e769522018-11-20 21:59:56 +01005598psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5599 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5600 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5601{
5602 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5603 return( PSA_ERROR_BAD_STATE );
5604 global_data.entropy_init = entropy_init;
5605 global_data.entropy_free = entropy_free;
5606 return( PSA_SUCCESS );
5607}
5608
Gilles Peskinee59236f2018-01-27 23:32:46 +01005609void mbedtls_psa_crypto_free( void )
5610{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005611 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005612 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5613 {
5614 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005615 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005616 }
5617 /* Wipe all remaining data, including configuration.
5618 * In particular, this sets all state indicator to the value
5619 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005620 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005621#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005622 /* Unregister all secure element drivers, so that we restart from
5623 * a pristine state. */
5624 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005625#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005626}
5627
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005628#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5629/** Recover a transaction that was interrupted by a power failure.
5630 *
5631 * This function is called during initialization, before psa_crypto_init()
5632 * returns. If this function returns a failure status, the initialization
5633 * fails.
5634 */
5635static psa_status_t psa_crypto_recover_transaction(
5636 const psa_crypto_transaction_t *transaction )
5637{
5638 switch( transaction->unknown.type )
5639 {
5640 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5641 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005642 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005643 * is implemented.
5644 * https://github.com/ARMmbed/mbed-crypto/issues/218
5645 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005646 default:
5647 /* We found an unsupported transaction in the storage.
5648 * We don't know what state the storage is in. Give up. */
5649 return( PSA_ERROR_STORAGE_FAILURE );
5650 }
5651}
5652#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5653
Gilles Peskinee59236f2018-01-27 23:32:46 +01005654psa_status_t psa_crypto_init( void )
5655{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005656 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005657 const unsigned char drbg_seed[] = "PSA";
5658
Gilles Peskinec6b69072018-11-20 21:42:52 +01005659 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005660 if( global_data.initialized != 0 )
5661 return( PSA_SUCCESS );
5662
Gilles Peskine5e769522018-11-20 21:59:56 +01005663 /* Set default configuration if
5664 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5665 if( global_data.entropy_init == NULL )
5666 global_data.entropy_init = mbedtls_entropy_init;
5667 if( global_data.entropy_free == NULL )
5668 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005669
Gilles Peskinec6b69072018-11-20 21:42:52 +01005670 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005671 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01005672#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5673 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5674 /* The PSA entropy injection feature depends on using NV seed as an entropy
5675 * source. Add NV seed as an entropy source for PSA entropy injection. */
5676 mbedtls_entropy_add_source( &global_data.entropy,
5677 mbedtls_nv_seed_poll, NULL,
5678 MBEDTLS_ENTROPY_BLOCK_SIZE,
5679 MBEDTLS_ENTROPY_SOURCE_STRONG );
5680#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01005681 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005682 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005683 status = mbedtls_to_psa_error(
5684 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5685 mbedtls_entropy_func,
5686 &global_data.entropy,
5687 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5688 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005689 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005690 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005691
Gilles Peskine66fb1262018-12-10 16:29:04 +01005692 status = psa_initialize_key_slots( );
5693 if( status != PSA_SUCCESS )
5694 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005695
Gilles Peskined9348f22019-10-01 15:22:29 +02005696#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5697 status = psa_init_all_se_drivers( );
5698 if( status != PSA_SUCCESS )
5699 goto exit;
5700#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5701
Gilles Peskine4b734222019-07-24 15:56:31 +02005702#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005703 status = psa_crypto_load_transaction( );
5704 if( status == PSA_SUCCESS )
5705 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005706 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5707 if( status != PSA_SUCCESS )
5708 goto exit;
5709 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005710 }
5711 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5712 {
5713 /* There's no transaction to complete. It's all good. */
5714 status = PSA_SUCCESS;
5715 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005716#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005717
Gilles Peskinec6b69072018-11-20 21:42:52 +01005718 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005719 global_data.initialized = 1;
5720
5721exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005722 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005723 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005724 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005725}
5726
5727#endif /* MBEDTLS_PSA_CRYPTO_C */