blob: 4450fdb56d66c921ae2d3b2ac42e3b360d6b7269 [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)
2040 case PSA_ALG_SHA_384:
2041 return( &mbedtls_sha384_info );
2042 case PSA_ALG_SHA_512:
2043 return( &mbedtls_sha512_info );
2044#endif
2045 default:
2046 return( NULL );
2047 }
2048}
Gilles Peskineb16841e2019-10-10 20:36:12 +02002049#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002050
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002051psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2052{
2053 switch( operation->alg )
2054 {
Gilles Peskine81736312018-06-26 15:04:31 +02002055 case 0:
2056 /* The object has (apparently) been initialized but it is not
2057 * in use. It's ok to call abort on such an object, and there's
2058 * nothing to do. */
2059 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002060#if defined(MBEDTLS_MD2_C)
2061 case PSA_ALG_MD2:
2062 mbedtls_md2_free( &operation->ctx.md2 );
2063 break;
2064#endif
2065#if defined(MBEDTLS_MD4_C)
2066 case PSA_ALG_MD4:
2067 mbedtls_md4_free( &operation->ctx.md4 );
2068 break;
2069#endif
2070#if defined(MBEDTLS_MD5_C)
2071 case PSA_ALG_MD5:
2072 mbedtls_md5_free( &operation->ctx.md5 );
2073 break;
2074#endif
2075#if defined(MBEDTLS_RIPEMD160_C)
2076 case PSA_ALG_RIPEMD160:
2077 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2078 break;
2079#endif
2080#if defined(MBEDTLS_SHA1_C)
2081 case PSA_ALG_SHA_1:
2082 mbedtls_sha1_free( &operation->ctx.sha1 );
2083 break;
2084#endif
2085#if defined(MBEDTLS_SHA256_C)
2086 case PSA_ALG_SHA_224:
2087 case PSA_ALG_SHA_256:
2088 mbedtls_sha256_free( &operation->ctx.sha256 );
2089 break;
2090#endif
2091#if defined(MBEDTLS_SHA512_C)
2092 case PSA_ALG_SHA_384:
2093 case PSA_ALG_SHA_512:
2094 mbedtls_sha512_free( &operation->ctx.sha512 );
2095 break;
2096#endif
2097 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002098 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002099 }
2100 operation->alg = 0;
2101 return( PSA_SUCCESS );
2102}
2103
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002104psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002105 psa_algorithm_t alg )
2106{
Janos Follath24eed8d2019-11-22 13:21:35 +00002107 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002108
2109 /* A context must be freshly initialized before it can be set up. */
2110 if( operation->alg != 0 )
2111 {
2112 return( PSA_ERROR_BAD_STATE );
2113 }
2114
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115 switch( alg )
2116 {
2117#if defined(MBEDTLS_MD2_C)
2118 case PSA_ALG_MD2:
2119 mbedtls_md2_init( &operation->ctx.md2 );
2120 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2121 break;
2122#endif
2123#if defined(MBEDTLS_MD4_C)
2124 case PSA_ALG_MD4:
2125 mbedtls_md4_init( &operation->ctx.md4 );
2126 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2127 break;
2128#endif
2129#if defined(MBEDTLS_MD5_C)
2130 case PSA_ALG_MD5:
2131 mbedtls_md5_init( &operation->ctx.md5 );
2132 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2133 break;
2134#endif
2135#if defined(MBEDTLS_RIPEMD160_C)
2136 case PSA_ALG_RIPEMD160:
2137 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2138 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2139 break;
2140#endif
2141#if defined(MBEDTLS_SHA1_C)
2142 case PSA_ALG_SHA_1:
2143 mbedtls_sha1_init( &operation->ctx.sha1 );
2144 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2145 break;
2146#endif
2147#if defined(MBEDTLS_SHA256_C)
2148 case PSA_ALG_SHA_224:
2149 mbedtls_sha256_init( &operation->ctx.sha256 );
2150 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2151 break;
2152 case PSA_ALG_SHA_256:
2153 mbedtls_sha256_init( &operation->ctx.sha256 );
2154 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2155 break;
2156#endif
2157#if defined(MBEDTLS_SHA512_C)
2158 case PSA_ALG_SHA_384:
2159 mbedtls_sha512_init( &operation->ctx.sha512 );
2160 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2161 break;
2162 case PSA_ALG_SHA_512:
2163 mbedtls_sha512_init( &operation->ctx.sha512 );
2164 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2165 break;
2166#endif
2167 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002168 return( PSA_ALG_IS_HASH( alg ) ?
2169 PSA_ERROR_NOT_SUPPORTED :
2170 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002171 }
2172 if( ret == 0 )
2173 operation->alg = alg;
2174 else
2175 psa_hash_abort( operation );
2176 return( mbedtls_to_psa_error( ret ) );
2177}
2178
2179psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2180 const uint8_t *input,
2181 size_t input_length )
2182{
Janos Follath24eed8d2019-11-22 13:21:35 +00002183 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002184
2185 /* Don't require hash implementations to behave correctly on a
2186 * zero-length input, which may have an invalid pointer. */
2187 if( input_length == 0 )
2188 return( PSA_SUCCESS );
2189
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002190 switch( operation->alg )
2191 {
2192#if defined(MBEDTLS_MD2_C)
2193 case PSA_ALG_MD2:
2194 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2195 input, input_length );
2196 break;
2197#endif
2198#if defined(MBEDTLS_MD4_C)
2199 case PSA_ALG_MD4:
2200 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2201 input, input_length );
2202 break;
2203#endif
2204#if defined(MBEDTLS_MD5_C)
2205 case PSA_ALG_MD5:
2206 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2207 input, input_length );
2208 break;
2209#endif
2210#if defined(MBEDTLS_RIPEMD160_C)
2211 case PSA_ALG_RIPEMD160:
2212 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2213 input, input_length );
2214 break;
2215#endif
2216#if defined(MBEDTLS_SHA1_C)
2217 case PSA_ALG_SHA_1:
2218 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2219 input, input_length );
2220 break;
2221#endif
2222#if defined(MBEDTLS_SHA256_C)
2223 case PSA_ALG_SHA_224:
2224 case PSA_ALG_SHA_256:
2225 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2226 input, input_length );
2227 break;
2228#endif
2229#if defined(MBEDTLS_SHA512_C)
2230 case PSA_ALG_SHA_384:
2231 case PSA_ALG_SHA_512:
2232 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2233 input, input_length );
2234 break;
2235#endif
2236 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002237 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002238 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002239
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240 if( ret != 0 )
2241 psa_hash_abort( operation );
2242 return( mbedtls_to_psa_error( ret ) );
2243}
2244
2245psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2246 uint8_t *hash,
2247 size_t hash_size,
2248 size_t *hash_length )
2249{
itayzafrir40835d42018-08-02 13:14:17 +03002250 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002252 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002253
2254 /* Fill the output buffer with something that isn't a valid hash
2255 * (barring an attack on the hash and deliberately-crafted input),
2256 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002257 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002258 /* If hash_size is 0 then hash may be NULL and then the
2259 * call to memset would have undefined behavior. */
2260 if( hash_size != 0 )
2261 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002262
2263 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002264 {
2265 status = PSA_ERROR_BUFFER_TOO_SMALL;
2266 goto exit;
2267 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002268
2269 switch( operation->alg )
2270 {
2271#if defined(MBEDTLS_MD2_C)
2272 case PSA_ALG_MD2:
2273 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2274 break;
2275#endif
2276#if defined(MBEDTLS_MD4_C)
2277 case PSA_ALG_MD4:
2278 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2279 break;
2280#endif
2281#if defined(MBEDTLS_MD5_C)
2282 case PSA_ALG_MD5:
2283 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2284 break;
2285#endif
2286#if defined(MBEDTLS_RIPEMD160_C)
2287 case PSA_ALG_RIPEMD160:
2288 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2289 break;
2290#endif
2291#if defined(MBEDTLS_SHA1_C)
2292 case PSA_ALG_SHA_1:
2293 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2294 break;
2295#endif
2296#if defined(MBEDTLS_SHA256_C)
2297 case PSA_ALG_SHA_224:
2298 case PSA_ALG_SHA_256:
2299 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2300 break;
2301#endif
2302#if defined(MBEDTLS_SHA512_C)
2303 case PSA_ALG_SHA_384:
2304 case PSA_ALG_SHA_512:
2305 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2306 break;
2307#endif
2308 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002309 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002310 }
itayzafrir40835d42018-08-02 13:14:17 +03002311 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002312
itayzafrir40835d42018-08-02 13:14:17 +03002313exit:
2314 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002315 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002316 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002317 return( psa_hash_abort( operation ) );
2318 }
2319 else
2320 {
2321 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002322 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002323 }
2324}
2325
Gilles Peskine2d277862018-06-18 15:41:12 +02002326psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2327 const uint8_t *hash,
2328 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002329{
2330 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2331 size_t actual_hash_length;
2332 psa_status_t status = psa_hash_finish( operation,
2333 actual_hash, sizeof( actual_hash ),
2334 &actual_hash_length );
2335 if( status != PSA_SUCCESS )
2336 return( status );
2337 if( actual_hash_length != hash_length )
2338 return( PSA_ERROR_INVALID_SIGNATURE );
2339 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2340 return( PSA_ERROR_INVALID_SIGNATURE );
2341 return( PSA_SUCCESS );
2342}
2343
Gilles Peskineeb35d782019-01-22 17:56:16 +01002344psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2345 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002346{
2347 if( target_operation->alg != 0 )
2348 return( PSA_ERROR_BAD_STATE );
2349
2350 switch( source_operation->alg )
2351 {
2352 case 0:
2353 return( PSA_ERROR_BAD_STATE );
2354#if defined(MBEDTLS_MD2_C)
2355 case PSA_ALG_MD2:
2356 mbedtls_md2_clone( &target_operation->ctx.md2,
2357 &source_operation->ctx.md2 );
2358 break;
2359#endif
2360#if defined(MBEDTLS_MD4_C)
2361 case PSA_ALG_MD4:
2362 mbedtls_md4_clone( &target_operation->ctx.md4,
2363 &source_operation->ctx.md4 );
2364 break;
2365#endif
2366#if defined(MBEDTLS_MD5_C)
2367 case PSA_ALG_MD5:
2368 mbedtls_md5_clone( &target_operation->ctx.md5,
2369 &source_operation->ctx.md5 );
2370 break;
2371#endif
2372#if defined(MBEDTLS_RIPEMD160_C)
2373 case PSA_ALG_RIPEMD160:
2374 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2375 &source_operation->ctx.ripemd160 );
2376 break;
2377#endif
2378#if defined(MBEDTLS_SHA1_C)
2379 case PSA_ALG_SHA_1:
2380 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2381 &source_operation->ctx.sha1 );
2382 break;
2383#endif
2384#if defined(MBEDTLS_SHA256_C)
2385 case PSA_ALG_SHA_224:
2386 case PSA_ALG_SHA_256:
2387 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2388 &source_operation->ctx.sha256 );
2389 break;
2390#endif
2391#if defined(MBEDTLS_SHA512_C)
2392 case PSA_ALG_SHA_384:
2393 case PSA_ALG_SHA_512:
2394 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2395 &source_operation->ctx.sha512 );
2396 break;
2397#endif
2398 default:
2399 return( PSA_ERROR_NOT_SUPPORTED );
2400 }
2401
2402 target_operation->alg = source_operation->alg;
2403 return( PSA_SUCCESS );
2404}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002405
2406
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002407/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002408/* MAC */
2409/****************************************************************/
2410
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002411static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412 psa_algorithm_t alg,
2413 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002414 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002415 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002416{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002417 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002418 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002420 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002421 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002422
Gilles Peskine8c9def32018-02-08 10:02:12 +01002423 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2424 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002425 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002426 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002427 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002428 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002429 mode = MBEDTLS_MODE_STREAM;
2430 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431 case PSA_ALG_CTR:
2432 mode = MBEDTLS_MODE_CTR;
2433 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002434 case PSA_ALG_CFB:
2435 mode = MBEDTLS_MODE_CFB;
2436 break;
2437 case PSA_ALG_OFB:
2438 mode = MBEDTLS_MODE_OFB;
2439 break;
2440 case PSA_ALG_CBC_NO_PADDING:
2441 mode = MBEDTLS_MODE_CBC;
2442 break;
2443 case PSA_ALG_CBC_PKCS7:
2444 mode = MBEDTLS_MODE_CBC;
2445 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002446 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002447 mode = MBEDTLS_MODE_CCM;
2448 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002449 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002450 mode = MBEDTLS_MODE_GCM;
2451 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002452 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2453 mode = MBEDTLS_MODE_CHACHAPOLY;
2454 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002455 default:
2456 return( NULL );
2457 }
2458 }
2459 else if( alg == PSA_ALG_CMAC )
2460 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002461 else
2462 return( NULL );
2463
2464 switch( key_type )
2465 {
2466 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002467 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002468 break;
2469 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002470 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2471 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002472 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002473 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002474 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002475 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002476 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2477 * but two-key Triple-DES is functionally three-key Triple-DES
2478 * with K1=K3, so that's how we present it to mbedtls. */
2479 if( key_bits == 128 )
2480 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002481 break;
2482 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002483 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484 break;
2485 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002486 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002488 case PSA_KEY_TYPE_CHACHA20:
2489 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2490 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002491 default:
2492 return( NULL );
2493 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002494 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002495 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002496
Jaeden Amero23bbb752018-06-26 14:16:54 +01002497 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2498 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002499}
2500
Gilles Peskinea05219c2018-11-16 16:02:56 +01002501#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002502static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002503{
Gilles Peskine2d277862018-06-18 15:41:12 +02002504 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002505 {
2506 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002507 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002508 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002509 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002510 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002511 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002512 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002513 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002514 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002515 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002516 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002517 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002518 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002519 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002520 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002521 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002522 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002523 return( 128 );
2524 default:
2525 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002526 }
2527}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002528#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002529
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002530/* Initialize the MAC operation structure. Once this function has been
2531 * called, psa_mac_abort can run and will do the right thing. */
2532static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2533 psa_algorithm_t alg )
2534{
2535 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2536
2537 operation->alg = alg;
2538 operation->key_set = 0;
2539 operation->iv_set = 0;
2540 operation->iv_required = 0;
2541 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002542 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002543
2544#if defined(MBEDTLS_CMAC_C)
2545 if( alg == PSA_ALG_CMAC )
2546 {
2547 operation->iv_required = 0;
2548 mbedtls_cipher_init( &operation->ctx.cmac );
2549 status = PSA_SUCCESS;
2550 }
2551 else
2552#endif /* MBEDTLS_CMAC_C */
2553#if defined(MBEDTLS_MD_C)
2554 if( PSA_ALG_IS_HMAC( operation->alg ) )
2555 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002556 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2557 operation->ctx.hmac.hash_ctx.alg = 0;
2558 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002559 }
2560 else
2561#endif /* MBEDTLS_MD_C */
2562 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002563 if( ! PSA_ALG_IS_MAC( alg ) )
2564 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002565 }
2566
2567 if( status != PSA_SUCCESS )
2568 memset( operation, 0, sizeof( *operation ) );
2569 return( status );
2570}
2571
Gilles Peskine01126fa2018-07-12 17:04:55 +02002572#if defined(MBEDTLS_MD_C)
2573static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2574{
Gilles Peskine3f108122018-12-07 18:14:53 +01002575 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002576 return( psa_hash_abort( &hmac->hash_ctx ) );
2577}
2578#endif /* MBEDTLS_MD_C */
2579
Gilles Peskine8c9def32018-02-08 10:02:12 +01002580psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2581{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002582 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002583 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002584 /* The object has (apparently) been initialized but it is not
2585 * in use. It's ok to call abort on such an object, and there's
2586 * nothing to do. */
2587 return( PSA_SUCCESS );
2588 }
2589 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002590#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002591 if( operation->alg == PSA_ALG_CMAC )
2592 {
2593 mbedtls_cipher_free( &operation->ctx.cmac );
2594 }
2595 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002596#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002597#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002598 if( PSA_ALG_IS_HMAC( operation->alg ) )
2599 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002600 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002601 }
2602 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002603#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002604 {
2605 /* Sanity check (shouldn't happen: operation->alg should
2606 * always have been initialized to a valid value). */
2607 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002608 }
Moran Peker41deec42018-04-04 15:43:05 +03002609
Gilles Peskine8c9def32018-02-08 10:02:12 +01002610 operation->alg = 0;
2611 operation->key_set = 0;
2612 operation->iv_set = 0;
2613 operation->iv_required = 0;
2614 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002615 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002616
Gilles Peskine8c9def32018-02-08 10:02:12 +01002617 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002618
2619bad_state:
2620 /* If abort is called on an uninitialized object, we can't trust
2621 * anything. Wipe the object in case it contains confidential data.
2622 * This may result in a memory leak if a pointer gets overwritten,
2623 * but it's too late to do anything about this. */
2624 memset( operation, 0, sizeof( *operation ) );
2625 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002626}
2627
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002628#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002629static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002630 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002631 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002632 const mbedtls_cipher_info_t *cipher_info )
2633{
Janos Follath24eed8d2019-11-22 13:21:35 +00002634 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002635
2636 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002637
2638 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2639 if( ret != 0 )
2640 return( ret );
2641
2642 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2643 slot->data.raw.data,
2644 key_bits );
2645 return( ret );
2646}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002647#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002648
Gilles Peskine248051a2018-06-20 16:09:38 +02002649#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002650static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2651 const uint8_t *key,
2652 size_t key_length,
2653 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002654{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002655 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002656 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002657 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002658 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002659 psa_status_t status;
2660
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002661 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2662 * overflow below. This should never trigger if the hash algorithm
2663 * is implemented correctly. */
2664 /* The size checks against the ipad and opad buffers cannot be written
2665 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2666 * because that triggers -Wlogical-op on GCC 7.3. */
2667 if( block_size > sizeof( ipad ) )
2668 return( PSA_ERROR_NOT_SUPPORTED );
2669 if( block_size > sizeof( hmac->opad ) )
2670 return( PSA_ERROR_NOT_SUPPORTED );
2671 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002672 return( PSA_ERROR_NOT_SUPPORTED );
2673
Gilles Peskined223b522018-06-11 18:12:58 +02002674 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002675 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002676 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002677 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002678 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002679 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002680 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002681 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002682 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002683 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002684 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002685 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002686 }
Gilles Peskine96889972018-07-12 17:07:03 +02002687 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2688 * but it is permitted. It is common when HMAC is used in HKDF, for
2689 * example. Don't call `memcpy` in the 0-length because `key` could be
2690 * an invalid pointer which would make the behavior undefined. */
2691 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002692 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002693
Gilles Peskined223b522018-06-11 18:12:58 +02002694 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2695 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002696 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002697 ipad[i] ^= 0x36;
2698 memset( ipad + key_length, 0x36, block_size - key_length );
2699
2700 /* Copy the key material from ipad to opad, flipping the requisite bits,
2701 * and filling the rest of opad with the requisite constant. */
2702 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002703 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2704 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002705
Gilles Peskine01126fa2018-07-12 17:04:55 +02002706 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002707 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002708 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002709
Gilles Peskine01126fa2018-07-12 17:04:55 +02002710 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002711
2712cleanup:
Ron Eldor296eca62019-09-10 15:21:37 +03002713 mbedtls_platform_zeroize( ipad, sizeof(ipad) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002714
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002715 return( status );
2716}
Gilles Peskine248051a2018-06-20 16:09:38 +02002717#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002718
Gilles Peskine89167cb2018-07-08 20:12:23 +02002719static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002720 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002721 psa_algorithm_t alg,
2722 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002723{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002724 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002725 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002726 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002727 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002728 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002729 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002730 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002731
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002732 /* A context must be freshly initialized before it can be set up. */
2733 if( operation->alg != 0 )
2734 {
2735 return( PSA_ERROR_BAD_STATE );
2736 }
2737
Gilles Peskined911eb72018-08-14 15:18:45 +02002738 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002739 if( status != PSA_SUCCESS )
2740 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002741 if( is_sign )
2742 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743
Gilles Peskine28f8f302019-07-24 13:30:31 +02002744 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002745 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002746 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002747 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002748
Gilles Peskine8c9def32018-02-08 10:02:12 +01002749#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002750 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002751 {
2752 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002753 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002754 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002755 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002756 if( cipher_info == NULL )
2757 {
2758 status = PSA_ERROR_NOT_SUPPORTED;
2759 goto exit;
2760 }
2761 operation->mac_size = cipher_info->block_size;
2762 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2763 status = mbedtls_to_psa_error( ret );
2764 }
2765 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002766#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002767#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002768 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002769 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002770 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002771 if( hash_alg == 0 )
2772 {
2773 status = PSA_ERROR_NOT_SUPPORTED;
2774 goto exit;
2775 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002776
2777 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2778 /* Sanity check. This shouldn't fail on a valid configuration. */
2779 if( operation->mac_size == 0 ||
2780 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2781 {
2782 status = PSA_ERROR_NOT_SUPPORTED;
2783 goto exit;
2784 }
2785
Gilles Peskine8e338702019-07-30 20:06:31 +02002786 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002787 {
2788 status = PSA_ERROR_INVALID_ARGUMENT;
2789 goto exit;
2790 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002791
Gilles Peskine01126fa2018-07-12 17:04:55 +02002792 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2793 slot->data.raw.data,
2794 slot->data.raw.bytes,
2795 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002796 }
2797 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002799 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002800 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002801 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002802 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002803
Gilles Peskined911eb72018-08-14 15:18:45 +02002804 if( truncated == 0 )
2805 {
2806 /* The "normal" case: untruncated algorithm. Nothing to do. */
2807 }
2808 else if( truncated < 4 )
2809 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002810 /* A very short MAC is too short for security since it can be
2811 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2812 * so we make this our minimum, even though 32 bits is still
2813 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002814 status = PSA_ERROR_NOT_SUPPORTED;
2815 }
2816 else if( truncated > operation->mac_size )
2817 {
2818 /* It's impossible to "truncate" to a larger length. */
2819 status = PSA_ERROR_INVALID_ARGUMENT;
2820 }
2821 else
2822 operation->mac_size = truncated;
2823
Gilles Peskinefbfac682018-07-08 20:51:54 +02002824exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002825 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002826 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002827 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002828 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002829 else
2830 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002831 operation->key_set = 1;
2832 }
2833 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002834}
2835
Gilles Peskine89167cb2018-07-08 20:12:23 +02002836psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002837 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002838 psa_algorithm_t alg )
2839{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002840 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002841}
2842
2843psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002844 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002845 psa_algorithm_t alg )
2846{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002847 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002848}
2849
Gilles Peskine8c9def32018-02-08 10:02:12 +01002850psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2851 const uint8_t *input,
2852 size_t input_length )
2853{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002854 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002855 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002856 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002857 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002858 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002859 operation->has_input = 1;
2860
Gilles Peskine8c9def32018-02-08 10:02:12 +01002861#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002862 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002863 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002864 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2865 input, input_length );
2866 status = mbedtls_to_psa_error( ret );
2867 }
2868 else
2869#endif /* MBEDTLS_CMAC_C */
2870#if defined(MBEDTLS_MD_C)
2871 if( PSA_ALG_IS_HMAC( operation->alg ) )
2872 {
2873 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2874 input_length );
2875 }
2876 else
2877#endif /* MBEDTLS_MD_C */
2878 {
2879 /* This shouldn't happen if `operation` was initialized by
2880 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002881 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002882 }
2883
Gilles Peskinefbfac682018-07-08 20:51:54 +02002884 if( status != PSA_SUCCESS )
2885 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002886 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002887}
2888
Gilles Peskine01126fa2018-07-12 17:04:55 +02002889#if defined(MBEDTLS_MD_C)
2890static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2891 uint8_t *mac,
2892 size_t mac_size )
2893{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002894 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002895 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2896 size_t hash_size = 0;
2897 size_t block_size = psa_get_hash_block_size( hash_alg );
2898 psa_status_t status;
2899
Gilles Peskine01126fa2018-07-12 17:04:55 +02002900 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2901 if( status != PSA_SUCCESS )
2902 return( status );
2903 /* From here on, tmp needs to be wiped. */
2904
2905 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2906 if( status != PSA_SUCCESS )
2907 goto exit;
2908
2909 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2910 if( status != PSA_SUCCESS )
2911 goto exit;
2912
2913 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2914 if( status != PSA_SUCCESS )
2915 goto exit;
2916
Gilles Peskined911eb72018-08-14 15:18:45 +02002917 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2918 if( status != PSA_SUCCESS )
2919 goto exit;
2920
2921 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002922
2923exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002924 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002925 return( status );
2926}
2927#endif /* MBEDTLS_MD_C */
2928
mohammad16036df908f2018-04-02 08:34:15 -07002929static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002930 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002931 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002933 if( ! operation->key_set )
2934 return( PSA_ERROR_BAD_STATE );
2935 if( operation->iv_required && ! operation->iv_set )
2936 return( PSA_ERROR_BAD_STATE );
2937
Gilles Peskine8c9def32018-02-08 10:02:12 +01002938 if( mac_size < operation->mac_size )
2939 return( PSA_ERROR_BUFFER_TOO_SMALL );
2940
Gilles Peskine8c9def32018-02-08 10:02:12 +01002941#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002942 if( operation->alg == PSA_ALG_CMAC )
2943 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002944 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2945 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2946 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002947 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002948 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002949 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002950 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002951 else
2952#endif /* MBEDTLS_CMAC_C */
2953#if defined(MBEDTLS_MD_C)
2954 if( PSA_ALG_IS_HMAC( operation->alg ) )
2955 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002956 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002957 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002958 }
2959 else
2960#endif /* MBEDTLS_MD_C */
2961 {
2962 /* This shouldn't happen if `operation` was initialized by
2963 * a setup function. */
2964 return( PSA_ERROR_BAD_STATE );
2965 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002966}
2967
Gilles Peskineacd4be32018-07-08 19:56:25 +02002968psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2969 uint8_t *mac,
2970 size_t mac_size,
2971 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002972{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002973 psa_status_t status;
2974
Jaeden Amero252ef282019-02-15 14:05:35 +00002975 if( operation->alg == 0 )
2976 {
2977 return( PSA_ERROR_BAD_STATE );
2978 }
2979
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002980 /* Fill the output buffer with something that isn't a valid mac
2981 * (barring an attack on the mac and deliberately-crafted input),
2982 * in case the caller doesn't check the return status properly. */
2983 *mac_length = mac_size;
2984 /* If mac_size is 0 then mac may be NULL and then the
2985 * call to memset would have undefined behavior. */
2986 if( mac_size != 0 )
2987 memset( mac, '!', mac_size );
2988
Gilles Peskine89167cb2018-07-08 20:12:23 +02002989 if( ! operation->is_sign )
2990 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002991 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002992 }
mohammad16036df908f2018-04-02 08:34:15 -07002993
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002994 status = psa_mac_finish_internal( operation, mac, mac_size );
2995
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002996 if( status == PSA_SUCCESS )
2997 {
2998 status = psa_mac_abort( operation );
2999 if( status == PSA_SUCCESS )
3000 *mac_length = operation->mac_size;
3001 else
3002 memset( mac, '!', mac_size );
3003 }
3004 else
3005 psa_mac_abort( operation );
3006 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003007}
3008
Gilles Peskineacd4be32018-07-08 19:56:25 +02003009psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3010 const uint8_t *mac,
3011 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003012{
Gilles Peskine828ed142018-06-18 23:25:51 +02003013 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003014 psa_status_t status;
3015
Jaeden Amero252ef282019-02-15 14:05:35 +00003016 if( operation->alg == 0 )
3017 {
3018 return( PSA_ERROR_BAD_STATE );
3019 }
3020
Gilles Peskine89167cb2018-07-08 20:12:23 +02003021 if( operation->is_sign )
3022 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003023 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003024 }
3025 if( operation->mac_size != mac_length )
3026 {
3027 status = PSA_ERROR_INVALID_SIGNATURE;
3028 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003029 }
mohammad16036df908f2018-04-02 08:34:15 -07003030
3031 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003032 actual_mac, sizeof( actual_mac ) );
3033
3034 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3035 status = PSA_ERROR_INVALID_SIGNATURE;
3036
3037cleanup:
3038 if( status == PSA_SUCCESS )
3039 status = psa_mac_abort( operation );
3040 else
3041 psa_mac_abort( operation );
3042
Gilles Peskine3f108122018-12-07 18:14:53 +01003043 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003044
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003045 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003046}
3047
3048
Gilles Peskine20035e32018-02-03 22:44:14 +01003049
Gilles Peskine20035e32018-02-03 22:44:14 +01003050/****************************************************************/
3051/* Asymmetric cryptography */
3052/****************************************************************/
3053
Gilles Peskine2b450e32018-06-27 15:42:46 +02003054#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003055/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003056 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003057static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3058 size_t hash_length,
3059 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003060{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003061 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003062 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003063 *md_alg = mbedtls_md_get_type( md_info );
3064
3065 /* The Mbed TLS RSA module uses an unsigned int for hash length
3066 * parameters. Validate that it fits so that we don't risk an
3067 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003068#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003069 if( hash_length > UINT_MAX )
3070 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003071#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003072
3073#if defined(MBEDTLS_PKCS1_V15)
3074 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3075 * must be correct. */
3076 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3077 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003078 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003079 if( md_info == NULL )
3080 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003081 if( mbedtls_md_get_size( md_info ) != hash_length )
3082 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003083 }
3084#endif /* MBEDTLS_PKCS1_V15 */
3085
3086#if defined(MBEDTLS_PKCS1_V21)
3087 /* PSS requires a hash internally. */
3088 if( PSA_ALG_IS_RSA_PSS( alg ) )
3089 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003090 if( md_info == NULL )
3091 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003092 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003093#endif /* MBEDTLS_PKCS1_V21 */
3094
Gilles Peskine61b91d42018-06-08 16:09:36 +02003095 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003096}
3097
Gilles Peskine2b450e32018-06-27 15:42:46 +02003098static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3099 psa_algorithm_t alg,
3100 const uint8_t *hash,
3101 size_t hash_length,
3102 uint8_t *signature,
3103 size_t signature_size,
3104 size_t *signature_length )
3105{
3106 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003107 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003108 mbedtls_md_type_t md_alg;
3109
3110 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3111 if( status != PSA_SUCCESS )
3112 return( status );
3113
Gilles Peskine630a18a2018-06-29 17:49:35 +02003114 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003115 return( PSA_ERROR_BUFFER_TOO_SMALL );
3116
3117#if defined(MBEDTLS_PKCS1_V15)
3118 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3119 {
3120 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3121 MBEDTLS_MD_NONE );
3122 ret = mbedtls_rsa_pkcs1_sign( rsa,
3123 mbedtls_ctr_drbg_random,
3124 &global_data.ctr_drbg,
3125 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003126 md_alg,
3127 (unsigned int) hash_length,
3128 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003129 signature );
3130 }
3131 else
3132#endif /* MBEDTLS_PKCS1_V15 */
3133#if defined(MBEDTLS_PKCS1_V21)
3134 if( PSA_ALG_IS_RSA_PSS( alg ) )
3135 {
3136 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3137 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3138 mbedtls_ctr_drbg_random,
3139 &global_data.ctr_drbg,
3140 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003141 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003142 (unsigned int) hash_length,
3143 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003144 signature );
3145 }
3146 else
3147#endif /* MBEDTLS_PKCS1_V21 */
3148 {
3149 return( PSA_ERROR_INVALID_ARGUMENT );
3150 }
3151
3152 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003153 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003154 return( mbedtls_to_psa_error( ret ) );
3155}
3156
3157static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3158 psa_algorithm_t alg,
3159 const uint8_t *hash,
3160 size_t hash_length,
3161 const uint8_t *signature,
3162 size_t signature_length )
3163{
3164 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003165 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003166 mbedtls_md_type_t md_alg;
3167
3168 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3169 if( status != PSA_SUCCESS )
3170 return( status );
3171
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003172 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3173 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003174
3175#if defined(MBEDTLS_PKCS1_V15)
3176 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3177 {
3178 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3179 MBEDTLS_MD_NONE );
3180 ret = mbedtls_rsa_pkcs1_verify( rsa,
3181 mbedtls_ctr_drbg_random,
3182 &global_data.ctr_drbg,
3183 MBEDTLS_RSA_PUBLIC,
3184 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003185 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003186 hash,
3187 signature );
3188 }
3189 else
3190#endif /* MBEDTLS_PKCS1_V15 */
3191#if defined(MBEDTLS_PKCS1_V21)
3192 if( PSA_ALG_IS_RSA_PSS( alg ) )
3193 {
3194 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3195 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3196 mbedtls_ctr_drbg_random,
3197 &global_data.ctr_drbg,
3198 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003199 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003200 (unsigned int) hash_length,
3201 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003202 signature );
3203 }
3204 else
3205#endif /* MBEDTLS_PKCS1_V21 */
3206 {
3207 return( PSA_ERROR_INVALID_ARGUMENT );
3208 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003209
3210 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3211 * the rest of the signature is invalid". This has little use in
3212 * practice and PSA doesn't report this distinction. */
3213 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3214 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003215 return( mbedtls_to_psa_error( ret ) );
3216}
3217#endif /* MBEDTLS_RSA_C */
3218
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003219#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003220/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3221 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3222 * (even though these functions don't modify it). */
3223static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3224 psa_algorithm_t alg,
3225 const uint8_t *hash,
3226 size_t hash_length,
3227 uint8_t *signature,
3228 size_t signature_size,
3229 size_t *signature_length )
3230{
Janos Follath24eed8d2019-11-22 13:21:35 +00003231 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003232 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003233 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003234 mbedtls_mpi_init( &r );
3235 mbedtls_mpi_init( &s );
3236
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003237 if( signature_size < 2 * curve_bytes )
3238 {
3239 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3240 goto cleanup;
3241 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003242
Gilles Peskinea05219c2018-11-16 16:02:56 +01003243#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003244 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3245 {
3246 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3247 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3248 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003249 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3250 &ecp->d, hash,
3251 hash_length, md_alg,
3252 mbedtls_ctr_drbg_random,
3253 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003254 }
3255 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003256#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003257 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003258 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003259 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3260 hash, hash_length,
3261 mbedtls_ctr_drbg_random,
3262 &global_data.ctr_drbg ) );
3263 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003264
3265 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3266 signature,
3267 curve_bytes ) );
3268 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3269 signature + curve_bytes,
3270 curve_bytes ) );
3271
3272cleanup:
3273 mbedtls_mpi_free( &r );
3274 mbedtls_mpi_free( &s );
3275 if( ret == 0 )
3276 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003277 return( mbedtls_to_psa_error( ret ) );
3278}
3279
3280static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3281 const uint8_t *hash,
3282 size_t hash_length,
3283 const uint8_t *signature,
3284 size_t signature_length )
3285{
Janos Follath24eed8d2019-11-22 13:21:35 +00003286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003287 mbedtls_mpi r, s;
3288 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3289 mbedtls_mpi_init( &r );
3290 mbedtls_mpi_init( &s );
3291
3292 if( signature_length != 2 * curve_bytes )
3293 return( PSA_ERROR_INVALID_SIGNATURE );
3294
3295 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3296 signature,
3297 curve_bytes ) );
3298 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3299 signature + curve_bytes,
3300 curve_bytes ) );
3301
3302 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3303 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003304
3305cleanup:
3306 mbedtls_mpi_free( &r );
3307 mbedtls_mpi_free( &s );
3308 return( mbedtls_to_psa_error( ret ) );
3309}
3310#endif /* MBEDTLS_ECDSA_C */
3311
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003312psa_status_t psa_sign_hash( psa_key_handle_t handle,
3313 psa_algorithm_t alg,
3314 const uint8_t *hash,
3315 size_t hash_length,
3316 uint8_t *signature,
3317 size_t signature_size,
3318 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003319{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003320 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003321 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003322#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3323 const psa_drv_se_t *drv;
3324 psa_drv_se_context_t *drv_context;
3325#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003326
3327 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003328 /* Immediately reject a zero-length signature buffer. This guarantees
3329 * that signature must be a valid pointer. (On the other hand, the hash
3330 * buffer can in principle be empty since it doesn't actually have
3331 * to be a hash.) */
3332 if( signature_size == 0 )
3333 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003334
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003335 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003336 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003337 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003338 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003339 {
3340 status = PSA_ERROR_INVALID_ARGUMENT;
3341 goto exit;
3342 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003343
Gilles Peskineedc64242019-08-07 21:05:07 +02003344#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3345 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3346 {
3347 if( drv->asymmetric == NULL ||
3348 drv->asymmetric->p_sign == NULL )
3349 {
3350 status = PSA_ERROR_NOT_SUPPORTED;
3351 goto exit;
3352 }
3353 status = drv->asymmetric->p_sign( drv_context,
3354 slot->data.se.slot_number,
3355 alg,
3356 hash, hash_length,
3357 signature, signature_size,
3358 signature_length );
3359 }
3360 else
3361#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine20035e32018-02-03 22:44:14 +01003362#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003363 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003364 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003365 status = psa_rsa_sign( slot->data.rsa,
3366 alg,
3367 hash, hash_length,
3368 signature, signature_size,
3369 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003370 }
3371 else
3372#endif /* defined(MBEDTLS_RSA_C) */
3373#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003374 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003375 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003376#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003377 if(
3378#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3379 PSA_ALG_IS_ECDSA( alg )
3380#else
3381 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3382#endif
3383 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003384 status = psa_ecdsa_sign( slot->data.ecp,
3385 alg,
3386 hash, hash_length,
3387 signature, signature_size,
3388 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003389 else
3390#endif /* defined(MBEDTLS_ECDSA_C) */
3391 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003392 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003393 }
itayzafrir5c753392018-05-08 11:18:38 +03003394 }
3395 else
3396#endif /* defined(MBEDTLS_ECP_C) */
3397 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003398 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003399 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003400
3401exit:
3402 /* Fill the unused part of the output buffer (the whole buffer on error,
3403 * the trailing part on success) with something that isn't a valid mac
3404 * (barring an attack on the mac and deliberately-crafted input),
3405 * in case the caller doesn't check the return status properly. */
3406 if( status == PSA_SUCCESS )
3407 memset( signature + *signature_length, '!',
3408 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003409 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003410 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003411 /* If signature_size is 0 then we have nothing to do. We must not call
3412 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003413 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003414}
3415
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003416psa_status_t psa_verify_hash( psa_key_handle_t handle,
3417 psa_algorithm_t alg,
3418 const uint8_t *hash,
3419 size_t hash_length,
3420 const uint8_t *signature,
3421 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003422{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003423 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003424 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003425#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3426 const psa_drv_se_t *drv;
3427 psa_drv_se_context_t *drv_context;
3428#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003429
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003430 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003431 if( status != PSA_SUCCESS )
3432 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003433
Gilles Peskineedc64242019-08-07 21:05:07 +02003434#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3435 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3436 {
3437 if( drv->asymmetric == NULL ||
3438 drv->asymmetric->p_verify == NULL )
3439 return( PSA_ERROR_NOT_SUPPORTED );
3440 return( drv->asymmetric->p_verify( drv_context,
3441 slot->data.se.slot_number,
3442 alg,
3443 hash, hash_length,
3444 signature, signature_length ) );
3445 }
3446 else
3447#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine61b91d42018-06-08 16:09:36 +02003448#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003449 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003450 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003451 return( psa_rsa_verify( slot->data.rsa,
3452 alg,
3453 hash, hash_length,
3454 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003455 }
3456 else
3457#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003458#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003459 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003460 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003461#if defined(MBEDTLS_ECDSA_C)
3462 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003463 return( psa_ecdsa_verify( slot->data.ecp,
3464 hash, hash_length,
3465 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003466 else
3467#endif /* defined(MBEDTLS_ECDSA_C) */
3468 {
3469 return( PSA_ERROR_INVALID_ARGUMENT );
3470 }
itayzafrir5c753392018-05-08 11:18:38 +03003471 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003472 else
3473#endif /* defined(MBEDTLS_ECP_C) */
3474 {
3475 return( PSA_ERROR_NOT_SUPPORTED );
3476 }
3477}
3478
Gilles Peskine072ac562018-06-30 00:21:29 +02003479#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3480static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3481 mbedtls_rsa_context *rsa )
3482{
3483 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3484 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3485 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3486 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3487}
3488#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3489
Gilles Peskinec5487a82018-12-03 18:08:14 +01003490psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003491 psa_algorithm_t alg,
3492 const uint8_t *input,
3493 size_t input_length,
3494 const uint8_t *salt,
3495 size_t salt_length,
3496 uint8_t *output,
3497 size_t output_size,
3498 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003499{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003500 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003501 psa_status_t status;
3502
Darryl Green5cc689a2018-07-24 15:34:10 +01003503 (void) input;
3504 (void) input_length;
3505 (void) salt;
3506 (void) output;
3507 (void) output_size;
3508
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003509 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003510
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003511 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3512 return( PSA_ERROR_INVALID_ARGUMENT );
3513
Gilles Peskine28f8f302019-07-24 13:30:31 +02003514 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003515 if( status != PSA_SUCCESS )
3516 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003517 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3518 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003519 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003520
3521#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003522 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003523 {
3524 mbedtls_rsa_context *rsa = slot->data.rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00003525 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003526 if( output_size < mbedtls_rsa_get_len( rsa ) )
Vikas Katariya21599b62019-08-02 12:26:29 +01003527 return( PSA_ERROR_BUFFER_TOO_SMALL );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003528#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003529 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003530 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003531 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3532 mbedtls_ctr_drbg_random,
3533 &global_data.ctr_drbg,
3534 MBEDTLS_RSA_PUBLIC,
3535 input_length,
3536 input,
3537 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003538 }
3539 else
3540#endif /* MBEDTLS_PKCS1_V15 */
3541#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003542 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003543 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003544 psa_rsa_oaep_set_padding_mode( alg, rsa );
3545 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3546 mbedtls_ctr_drbg_random,
3547 &global_data.ctr_drbg,
3548 MBEDTLS_RSA_PUBLIC,
3549 salt, salt_length,
3550 input_length,
3551 input,
3552 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003553 }
3554 else
3555#endif /* MBEDTLS_PKCS1_V21 */
3556 {
3557 return( PSA_ERROR_INVALID_ARGUMENT );
3558 }
3559 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003560 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003561 return( mbedtls_to_psa_error( ret ) );
3562 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003563 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003564#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003565 {
3566 return( PSA_ERROR_NOT_SUPPORTED );
3567 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003568}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003569
Gilles Peskinec5487a82018-12-03 18:08:14 +01003570psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003571 psa_algorithm_t alg,
3572 const uint8_t *input,
3573 size_t input_length,
3574 const uint8_t *salt,
3575 size_t salt_length,
3576 uint8_t *output,
3577 size_t output_size,
3578 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003579{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003580 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003581 psa_status_t status;
3582
Darryl Green5cc689a2018-07-24 15:34:10 +01003583 (void) input;
3584 (void) input_length;
3585 (void) salt;
3586 (void) output;
3587 (void) output_size;
3588
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003589 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003590
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003591 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3592 return( PSA_ERROR_INVALID_ARGUMENT );
3593
Gilles Peskine28f8f302019-07-24 13:30:31 +02003594 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003595 if( status != PSA_SUCCESS )
3596 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003597 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003598 return( PSA_ERROR_INVALID_ARGUMENT );
3599
3600#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003601 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003602 {
3603 mbedtls_rsa_context *rsa = slot->data.rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00003604 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003605
Gilles Peskine630a18a2018-06-29 17:49:35 +02003606 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003607 return( PSA_ERROR_INVALID_ARGUMENT );
3608
3609#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003610 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003611 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003612 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3613 mbedtls_ctr_drbg_random,
3614 &global_data.ctr_drbg,
3615 MBEDTLS_RSA_PRIVATE,
3616 output_length,
3617 input,
3618 output,
3619 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003620 }
3621 else
3622#endif /* MBEDTLS_PKCS1_V15 */
3623#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003624 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003625 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003626 psa_rsa_oaep_set_padding_mode( alg, rsa );
3627 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3628 mbedtls_ctr_drbg_random,
3629 &global_data.ctr_drbg,
3630 MBEDTLS_RSA_PRIVATE,
3631 salt, salt_length,
3632 output_length,
3633 input,
3634 output,
3635 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003636 }
3637 else
3638#endif /* MBEDTLS_PKCS1_V21 */
3639 {
3640 return( PSA_ERROR_INVALID_ARGUMENT );
3641 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003642
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003643 return( mbedtls_to_psa_error( ret ) );
3644 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003645 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003646#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003647 {
3648 return( PSA_ERROR_NOT_SUPPORTED );
3649 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003650}
Gilles Peskine20035e32018-02-03 22:44:14 +01003651
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003652
3653
mohammad1603503973b2018-03-12 15:59:30 +02003654/****************************************************************/
3655/* Symmetric cryptography */
3656/****************************************************************/
3657
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003658/* Initialize the cipher operation structure. Once this function has been
3659 * called, psa_cipher_abort can run and will do the right thing. */
3660static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3661 psa_algorithm_t alg )
3662{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003663 if( ! PSA_ALG_IS_CIPHER( alg ) )
3664 {
3665 memset( operation, 0, sizeof( *operation ) );
3666 return( PSA_ERROR_INVALID_ARGUMENT );
3667 }
3668
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003669 operation->alg = alg;
3670 operation->key_set = 0;
3671 operation->iv_set = 0;
3672 operation->iv_required = 1;
3673 operation->iv_size = 0;
3674 operation->block_size = 0;
3675 mbedtls_cipher_init( &operation->ctx.cipher );
3676 return( PSA_SUCCESS );
3677}
3678
Gilles Peskinee553c652018-06-04 16:22:46 +02003679static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003680 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003681 psa_algorithm_t alg,
3682 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003683{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003684 int ret = 0;
3685 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003686 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003687 size_t key_bits;
3688 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003689 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3690 PSA_KEY_USAGE_ENCRYPT :
3691 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003692
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003693 /* A context must be freshly initialized before it can be set up. */
3694 if( operation->alg != 0 )
3695 {
3696 return( PSA_ERROR_BAD_STATE );
3697 }
3698
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003699 status = psa_cipher_init( operation, alg );
3700 if( status != PSA_SUCCESS )
3701 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003702
Gilles Peskine28f8f302019-07-24 13:30:31 +02003703 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003704 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003705 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003706 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003707
Gilles Peskine8e338702019-07-30 20:06:31 +02003708 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003709 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003710 {
3711 status = PSA_ERROR_NOT_SUPPORTED;
3712 goto exit;
3713 }
mohammad1603503973b2018-03-12 15:59:30 +02003714
mohammad1603503973b2018-03-12 15:59:30 +02003715 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003716 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003717 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003718
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003719#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003720 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003721 {
3722 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003723 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003724 memcpy( keys, slot->data.raw.data, 16 );
3725 memcpy( keys + 16, slot->data.raw.data, 8 );
3726 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3727 keys,
3728 192, cipher_operation );
3729 }
3730 else
3731#endif
3732 {
3733 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3734 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003735 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003736 }
Moran Peker41deec42018-04-04 15:43:05 +03003737 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003738 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003739
mohammad16038481e742018-03-18 13:57:31 +02003740#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003741 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003742 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003743 case PSA_ALG_CBC_NO_PADDING:
3744 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3745 MBEDTLS_PADDING_NONE );
3746 break;
3747 case PSA_ALG_CBC_PKCS7:
3748 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3749 MBEDTLS_PADDING_PKCS7 );
3750 break;
3751 default:
3752 /* The algorithm doesn't involve padding. */
3753 ret = 0;
3754 break;
3755 }
3756 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003757 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003758#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3759
mohammad1603503973b2018-03-12 15:59:30 +02003760 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003761 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003762 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003763 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003764 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003765 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003766 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003767#if defined(MBEDTLS_CHACHA20_C)
3768 else
3769 if( alg == PSA_ALG_CHACHA20 )
3770 operation->iv_size = 12;
3771#endif
mohammad1603503973b2018-03-12 15:59:30 +02003772
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003773exit:
3774 if( status == 0 )
3775 status = mbedtls_to_psa_error( ret );
3776 if( status != 0 )
3777 psa_cipher_abort( operation );
3778 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003779}
3780
Gilles Peskinefe119512018-07-08 21:39:34 +02003781psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003782 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003783 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003784{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003785 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003786}
3787
Gilles Peskinefe119512018-07-08 21:39:34 +02003788psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003789 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003790 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003791{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003792 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003793}
3794
Gilles Peskinefe119512018-07-08 21:39:34 +02003795psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003796 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003797 size_t iv_size,
3798 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003799{
itayzafrir534bd7c2018-08-02 13:56:32 +03003800 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003801 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003802 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003803 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003804 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003805 }
Moran Peker41deec42018-04-04 15:43:05 +03003806 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003807 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003808 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003809 goto exit;
3810 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003811 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3812 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003813 if( ret != 0 )
3814 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003815 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003816 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003817 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003818
mohammad16038481e742018-03-18 13:57:31 +02003819 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003820 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003821
Moran Peker395db872018-05-31 14:07:14 +03003822exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003823 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003824 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003825 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003826}
3827
Gilles Peskinefe119512018-07-08 21:39:34 +02003828psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003829 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003830 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003831{
itayzafrir534bd7c2018-08-02 13:56:32 +03003832 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003833 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003834 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003835 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003836 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003837 }
Moran Pekera28258c2018-05-29 16:25:04 +03003838 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003839 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003840 status = PSA_ERROR_INVALID_ARGUMENT;
3841 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003842 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003843 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3844 status = mbedtls_to_psa_error( ret );
3845exit:
3846 if( status == PSA_SUCCESS )
3847 operation->iv_set = 1;
3848 else
mohammad1603503973b2018-03-12 15:59:30 +02003849 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003850 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003851}
3852
Gilles Peskinee553c652018-06-04 16:22:46 +02003853psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3854 const uint8_t *input,
3855 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003856 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003857 size_t output_size,
3858 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003859{
itayzafrir534bd7c2018-08-02 13:56:32 +03003860 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003862 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003863
3864 if( operation->alg == 0 )
3865 {
3866 return( PSA_ERROR_BAD_STATE );
3867 }
3868
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003869 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003870 {
3871 /* Take the unprocessed partial block left over from previous
3872 * update calls, if any, plus the input to this call. Remove
3873 * the last partial block, if any. You get the data that will be
3874 * output in this call. */
3875 expected_output_size =
3876 ( operation->ctx.cipher.unprocessed_len + input_length )
3877 / operation->block_size * operation->block_size;
3878 }
3879 else
3880 {
3881 expected_output_size = input_length;
3882 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003883
Gilles Peskine89d789c2018-06-04 17:17:16 +02003884 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003885 {
3886 status = PSA_ERROR_BUFFER_TOO_SMALL;
3887 goto exit;
3888 }
mohammad160382759612018-03-12 18:16:40 +02003889
mohammad1603503973b2018-03-12 15:59:30 +02003890 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003891 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003892 status = mbedtls_to_psa_error( ret );
3893exit:
3894 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003895 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003896 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003897}
3898
Gilles Peskinee553c652018-06-04 16:22:46 +02003899psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3900 uint8_t *output,
3901 size_t output_size,
3902 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003903{
David Saadab4ecc272019-02-14 13:48:10 +02003904 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003905 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003906 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003907
mohammad1603503973b2018-03-12 15:59:30 +02003908 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003909 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003910 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003911 }
3912 if( operation->iv_required && ! operation->iv_set )
3913 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003914 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003915 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003916
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003917 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003918 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3919 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003920 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003921 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003922 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003923 }
3924
Janos Follath315b51c2018-07-09 16:04:51 +01003925 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3926 temp_output_buffer,
3927 output_length );
3928 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003929 {
Janos Follath315b51c2018-07-09 16:04:51 +01003930 status = mbedtls_to_psa_error( cipher_ret );
3931 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003932 }
Janos Follath315b51c2018-07-09 16:04:51 +01003933
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003934 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003935 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003936 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003937 memcpy( output, temp_output_buffer, *output_length );
3938 else
3939 {
Janos Follath315b51c2018-07-09 16:04:51 +01003940 status = PSA_ERROR_BUFFER_TOO_SMALL;
3941 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003942 }
mohammad1603503973b2018-03-12 15:59:30 +02003943
Gilles Peskine3f108122018-12-07 18:14:53 +01003944 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003945 status = psa_cipher_abort( operation );
3946
3947 return( status );
3948
3949error:
3950
3951 *output_length = 0;
3952
Gilles Peskine3f108122018-12-07 18:14:53 +01003953 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003954 (void) psa_cipher_abort( operation );
3955
3956 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003957}
3958
Gilles Peskinee553c652018-06-04 16:22:46 +02003959psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3960{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003961 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003962 {
3963 /* The object has (apparently) been initialized but it is not
3964 * in use. It's ok to call abort on such an object, and there's
3965 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003966 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003967 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003968
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003969 /* Sanity check (shouldn't happen: operation->alg should
3970 * always have been initialized to a valid value). */
3971 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3972 return( PSA_ERROR_BAD_STATE );
3973
mohammad1603503973b2018-03-12 15:59:30 +02003974 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003975
Moran Peker41deec42018-04-04 15:43:05 +03003976 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003977 operation->key_set = 0;
3978 operation->iv_set = 0;
3979 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003980 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003981 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003982
Moran Peker395db872018-05-31 14:07:14 +03003983 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003984}
3985
Gilles Peskinea0655c32018-04-30 17:06:50 +02003986
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003987
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003988
mohammad16035955c982018-04-26 00:53:03 +03003989/****************************************************************/
3990/* AEAD */
3991/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003992
Gilles Peskineedf9a652018-08-17 18:11:56 +02003993typedef struct
3994{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003995 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003996 const mbedtls_cipher_info_t *cipher_info;
3997 union
3998 {
3999#if defined(MBEDTLS_CCM_C)
4000 mbedtls_ccm_context ccm;
4001#endif /* MBEDTLS_CCM_C */
4002#if defined(MBEDTLS_GCM_C)
4003 mbedtls_gcm_context gcm;
4004#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004005#if defined(MBEDTLS_CHACHAPOLY_C)
4006 mbedtls_chachapoly_context chachapoly;
4007#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004008 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004009 psa_algorithm_t core_alg;
4010 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004011 uint8_t tag_length;
4012} aead_operation_t;
4013
Gilles Peskine30a9e412019-01-14 18:36:12 +01004014static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004015{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004016 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004017 {
4018#if defined(MBEDTLS_CCM_C)
4019 case PSA_ALG_CCM:
4020 mbedtls_ccm_free( &operation->ctx.ccm );
4021 break;
4022#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004023#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004024 case PSA_ALG_GCM:
4025 mbedtls_gcm_free( &operation->ctx.gcm );
4026 break;
4027#endif /* MBEDTLS_GCM_C */
4028 }
4029}
4030
4031static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004032 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004033 psa_key_usage_t usage,
4034 psa_algorithm_t alg )
4035{
4036 psa_status_t status;
4037 size_t key_bits;
4038 mbedtls_cipher_id_t cipher_id;
4039
Gilles Peskine28f8f302019-07-24 13:30:31 +02004040 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004041 if( status != PSA_SUCCESS )
4042 return( status );
4043
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004044 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004045
4046 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004047 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004048 &cipher_id );
4049 if( operation->cipher_info == NULL )
4050 return( PSA_ERROR_NOT_SUPPORTED );
4051
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004052 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004053 {
4054#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004055 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4056 operation->core_alg = PSA_ALG_CCM;
4057 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004058 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4059 * The call to mbedtls_ccm_encrypt_and_tag or
4060 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004061 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004062 return( PSA_ERROR_INVALID_ARGUMENT );
4063 mbedtls_ccm_init( &operation->ctx.ccm );
4064 status = mbedtls_to_psa_error(
4065 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
4066 operation->slot->data.raw.data,
4067 (unsigned int) key_bits ) );
4068 if( status != 0 )
4069 goto cleanup;
4070 break;
4071#endif /* MBEDTLS_CCM_C */
4072
4073#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004074 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4075 operation->core_alg = PSA_ALG_GCM;
4076 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004077 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4078 * The call to mbedtls_gcm_crypt_and_tag or
4079 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004080 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004081 return( PSA_ERROR_INVALID_ARGUMENT );
4082 mbedtls_gcm_init( &operation->ctx.gcm );
4083 status = mbedtls_to_psa_error(
4084 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
4085 operation->slot->data.raw.data,
4086 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004087 if( status != 0 )
4088 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004089 break;
4090#endif /* MBEDTLS_GCM_C */
4091
Gilles Peskine26869f22019-05-06 15:25:00 +02004092#if defined(MBEDTLS_CHACHAPOLY_C)
4093 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4094 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4095 operation->full_tag_length = 16;
4096 /* We only support the default tag length. */
4097 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4098 return( PSA_ERROR_NOT_SUPPORTED );
4099 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4100 status = mbedtls_to_psa_error(
4101 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
4102 operation->slot->data.raw.data ) );
4103 if( status != 0 )
4104 goto cleanup;
4105 break;
4106#endif /* MBEDTLS_CHACHAPOLY_C */
4107
Gilles Peskineedf9a652018-08-17 18:11:56 +02004108 default:
4109 return( PSA_ERROR_NOT_SUPPORTED );
4110 }
4111
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004112 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4113 {
4114 status = PSA_ERROR_INVALID_ARGUMENT;
4115 goto cleanup;
4116 }
4117 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004118
Gilles Peskineedf9a652018-08-17 18:11:56 +02004119 return( PSA_SUCCESS );
4120
4121cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004122 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004123 return( status );
4124}
4125
Gilles Peskinec5487a82018-12-03 18:08:14 +01004126psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004127 psa_algorithm_t alg,
4128 const uint8_t *nonce,
4129 size_t nonce_length,
4130 const uint8_t *additional_data,
4131 size_t additional_data_length,
4132 const uint8_t *plaintext,
4133 size_t plaintext_length,
4134 uint8_t *ciphertext,
4135 size_t ciphertext_size,
4136 size_t *ciphertext_length )
4137{
mohammad16035955c982018-04-26 00:53:03 +03004138 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004139 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004140 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004141
mohammad1603f08a5502018-06-03 15:05:47 +03004142 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004143
Gilles Peskinec5487a82018-12-03 18:08:14 +01004144 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004145 if( status != PSA_SUCCESS )
4146 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004147
Gilles Peskineedf9a652018-08-17 18:11:56 +02004148 /* For all currently supported modes, the tag is at the end of the
4149 * ciphertext. */
4150 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4151 {
4152 status = PSA_ERROR_BUFFER_TOO_SMALL;
4153 goto exit;
4154 }
4155 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004156
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004157#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004158 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004159 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004160 status = mbedtls_to_psa_error(
4161 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4162 MBEDTLS_GCM_ENCRYPT,
4163 plaintext_length,
4164 nonce, nonce_length,
4165 additional_data, additional_data_length,
4166 plaintext, ciphertext,
4167 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004168 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004169 else
4170#endif /* MBEDTLS_GCM_C */
4171#if defined(MBEDTLS_CCM_C)
4172 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004173 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004174 status = mbedtls_to_psa_error(
4175 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4176 plaintext_length,
4177 nonce, nonce_length,
4178 additional_data,
4179 additional_data_length,
4180 plaintext, ciphertext,
4181 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004182 }
mohammad16035c8845f2018-05-09 05:40:09 -07004183 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004184#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004185#if defined(MBEDTLS_CHACHAPOLY_C)
4186 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4187 {
4188 if( nonce_length != 12 || operation.tag_length != 16 )
4189 {
4190 status = PSA_ERROR_NOT_SUPPORTED;
4191 goto exit;
4192 }
4193 status = mbedtls_to_psa_error(
4194 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4195 plaintext_length,
4196 nonce,
4197 additional_data,
4198 additional_data_length,
4199 plaintext,
4200 ciphertext,
4201 tag ) );
4202 }
4203 else
4204#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004205 {
mohammad1603554faad2018-06-03 15:07:38 +03004206 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004207 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004208
Gilles Peskineedf9a652018-08-17 18:11:56 +02004209 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4210 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004211
Gilles Peskineedf9a652018-08-17 18:11:56 +02004212exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004213 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004214 if( status == PSA_SUCCESS )
4215 *ciphertext_length = plaintext_length + operation.tag_length;
4216 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004217}
4218
Gilles Peskineee652a32018-06-01 19:23:52 +02004219/* Locate the tag in a ciphertext buffer containing the encrypted data
4220 * followed by the tag. Return the length of the part preceding the tag in
4221 * *plaintext_length. This is the size of the plaintext in modes where
4222 * the encrypted data has the same size as the plaintext, such as
4223 * CCM and GCM. */
4224static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4225 const uint8_t *ciphertext,
4226 size_t ciphertext_length,
4227 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004228 const uint8_t **p_tag )
4229{
4230 size_t payload_length;
4231 if( tag_length > ciphertext_length )
4232 return( PSA_ERROR_INVALID_ARGUMENT );
4233 payload_length = ciphertext_length - tag_length;
4234 if( payload_length > plaintext_size )
4235 return( PSA_ERROR_BUFFER_TOO_SMALL );
4236 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004237 return( PSA_SUCCESS );
4238}
4239
Gilles Peskinec5487a82018-12-03 18:08:14 +01004240psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004241 psa_algorithm_t alg,
4242 const uint8_t *nonce,
4243 size_t nonce_length,
4244 const uint8_t *additional_data,
4245 size_t additional_data_length,
4246 const uint8_t *ciphertext,
4247 size_t ciphertext_length,
4248 uint8_t *plaintext,
4249 size_t plaintext_size,
4250 size_t *plaintext_length )
4251{
mohammad16035955c982018-04-26 00:53:03 +03004252 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004253 aead_operation_t operation;
4254 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004255
Gilles Peskineee652a32018-06-01 19:23:52 +02004256 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004257
Gilles Peskinec5487a82018-12-03 18:08:14 +01004258 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004259 if( status != PSA_SUCCESS )
4260 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004261
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004262 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4263 ciphertext, ciphertext_length,
4264 plaintext_size, &tag );
4265 if( status != PSA_SUCCESS )
4266 goto exit;
4267
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004268#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004269 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004270 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004271 status = mbedtls_to_psa_error(
4272 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4273 ciphertext_length - operation.tag_length,
4274 nonce, nonce_length,
4275 additional_data,
4276 additional_data_length,
4277 tag, operation.tag_length,
4278 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004279 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004280 else
4281#endif /* MBEDTLS_GCM_C */
4282#if defined(MBEDTLS_CCM_C)
4283 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004284 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004285 status = mbedtls_to_psa_error(
4286 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4287 ciphertext_length - operation.tag_length,
4288 nonce, nonce_length,
4289 additional_data,
4290 additional_data_length,
4291 ciphertext, plaintext,
4292 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004293 }
mohammad160339574652018-06-01 04:39:53 -07004294 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004295#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004296#if defined(MBEDTLS_CHACHAPOLY_C)
4297 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4298 {
4299 if( nonce_length != 12 || operation.tag_length != 16 )
4300 {
4301 status = PSA_ERROR_NOT_SUPPORTED;
4302 goto exit;
4303 }
4304 status = mbedtls_to_psa_error(
4305 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4306 ciphertext_length - operation.tag_length,
4307 nonce,
4308 additional_data,
4309 additional_data_length,
4310 tag,
4311 ciphertext,
4312 plaintext ) );
4313 }
4314 else
4315#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004316 {
mohammad1603554faad2018-06-03 15:07:38 +03004317 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004318 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004319
Gilles Peskineedf9a652018-08-17 18:11:56 +02004320 if( status != PSA_SUCCESS && plaintext_size != 0 )
4321 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004322
Gilles Peskineedf9a652018-08-17 18:11:56 +02004323exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004324 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004325 if( status == PSA_SUCCESS )
4326 *plaintext_length = ciphertext_length - operation.tag_length;
4327 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004328}
4329
Gilles Peskinea0655c32018-04-30 17:06:50 +02004330
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004331
Gilles Peskine20035e32018-02-03 22:44:14 +01004332/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004333/* Generators */
4334/****************************************************************/
4335
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004336#define HKDF_STATE_INIT 0 /* no input yet */
4337#define HKDF_STATE_STARTED 1 /* got salt */
4338#define HKDF_STATE_KEYED 2 /* got key */
4339#define HKDF_STATE_OUTPUT 3 /* output started */
4340
Gilles Peskinecbe66502019-05-16 16:59:18 +02004341static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004342 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004343{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004344 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4345 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004346 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004347 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004348}
4349
4350
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004351psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004352{
4353 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004354 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004355 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004356 {
4357 /* The object has (apparently) been initialized but it is not
4358 * in use. It's ok to call abort on such an object, and there's
4359 * nothing to do. */
4360 }
4361 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004362#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004363 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004364 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004365 mbedtls_free( operation->ctx.hkdf.info );
4366 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004367 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004368 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004369 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004370 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004371 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004372 if( operation->ctx.tls12_prf.seed != NULL )
4373 {
4374 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4375 operation->ctx.tls12_prf.seed_length );
4376 mbedtls_free( operation->ctx.tls12_prf.seed );
4377 }
4378
4379 if( operation->ctx.tls12_prf.label != NULL )
4380 {
4381 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4382 operation->ctx.tls12_prf.label_length );
4383 mbedtls_free( operation->ctx.tls12_prf.label );
4384 }
4385
4386 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4387
4388 /* We leave the fields Ai and output_block to be erased safely by the
4389 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004390 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004391 else
4392#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004393 {
4394 status = PSA_ERROR_BAD_STATE;
4395 }
Janos Follath083036a2019-06-11 10:22:26 +01004396 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004397 return( status );
4398}
4399
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004400psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004401 size_t *capacity)
4402{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004403 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004404 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004405 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004406 return PSA_ERROR_BAD_STATE;
4407 }
4408
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004409 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004410 return( PSA_SUCCESS );
4411}
4412
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004413psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004414 size_t capacity )
4415{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004416 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004417 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004418 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004419 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004420 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004421 return( PSA_SUCCESS );
4422}
4423
Gilles Peskinebef7f142018-07-12 17:22:21 +02004424#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004425/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004426 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004427static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004428 psa_algorithm_t hash_alg,
4429 uint8_t *output,
4430 size_t output_length )
4431{
4432 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4433 psa_status_t status;
4434
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004435 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4436 return( PSA_ERROR_BAD_STATE );
4437 hkdf->state = HKDF_STATE_OUTPUT;
4438
Gilles Peskinebef7f142018-07-12 17:22:21 +02004439 while( output_length != 0 )
4440 {
4441 /* Copy what remains of the current block */
4442 uint8_t n = hash_length - hkdf->offset_in_block;
4443 if( n > output_length )
4444 n = (uint8_t) output_length;
4445 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4446 output += n;
4447 output_length -= n;
4448 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004449 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004450 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004451 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004452 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004453 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004454 * object was corrupted or if this function is called directly
4455 * inside the library. */
4456 if( hkdf->block_number == 0xff )
4457 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004458
4459 /* We need a new block */
4460 ++hkdf->block_number;
4461 hkdf->offset_in_block = 0;
4462 status = psa_hmac_setup_internal( &hkdf->hmac,
4463 hkdf->prk, hash_length,
4464 hash_alg );
4465 if( status != PSA_SUCCESS )
4466 return( status );
4467 if( hkdf->block_number != 1 )
4468 {
4469 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4470 hkdf->output_block,
4471 hash_length );
4472 if( status != PSA_SUCCESS )
4473 return( status );
4474 }
4475 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4476 hkdf->info,
4477 hkdf->info_length );
4478 if( status != PSA_SUCCESS )
4479 return( status );
4480 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4481 &hkdf->block_number, 1 );
4482 if( status != PSA_SUCCESS )
4483 return( status );
4484 status = psa_hmac_finish_internal( &hkdf->hmac,
4485 hkdf->output_block,
4486 sizeof( hkdf->output_block ) );
4487 if( status != PSA_SUCCESS )
4488 return( status );
4489 }
4490
4491 return( PSA_SUCCESS );
4492}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004493
Janos Follath7742fee2019-06-17 12:58:10 +01004494static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4495 psa_tls12_prf_key_derivation_t *tls12_prf,
4496 psa_algorithm_t alg )
4497{
4498 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4499 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004500 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4501 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004502
Janos Follath7742fee2019-06-17 12:58:10 +01004503 /* We can't be wanting more output after block 0xff, otherwise
4504 * the capacity check in psa_key_derivation_output_bytes() would have
4505 * prevented this call. It could happen only if the operation
4506 * object was corrupted or if this function is called directly
4507 * inside the library. */
4508 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004509 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004510
4511 /* We need a new block */
4512 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004513 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004514
4515 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4516 *
4517 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4518 *
4519 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4520 * HMAC_hash(secret, A(2) + seed) +
4521 * HMAC_hash(secret, A(3) + seed) + ...
4522 *
4523 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004524 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004525 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004526 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004527 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004528 * is currently extracted as `output_block` and where i is
4529 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004530 */
4531
Janos Follathea29bfb2019-06-19 12:21:20 +01004532 /* Save the hash context before using it, to preserve the hash state with
4533 * only the inner padding in it. We need this, because inner padding depends
4534 * on the key (secret in the RFC's terminology). */
4535 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4536 if( status != PSA_SUCCESS )
4537 goto cleanup;
4538
4539 /* Calculate A(i) where i = tls12_prf->block_number. */
4540 if( tls12_prf->block_number == 1 )
4541 {
4542 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4543 * the variable seed and in this instance means it in the context of the
4544 * P_hash function, where seed = label + seed.) */
4545 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4546 tls12_prf->label, tls12_prf->label_length );
4547 if( status != PSA_SUCCESS )
4548 goto cleanup;
4549 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4550 tls12_prf->seed, tls12_prf->seed_length );
4551 if( status != PSA_SUCCESS )
4552 goto cleanup;
4553 }
4554 else
4555 {
4556 /* A(i) = HMAC_hash(secret, A(i-1)) */
4557 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4558 tls12_prf->Ai, hash_length );
4559 if( status != PSA_SUCCESS )
4560 goto cleanup;
4561 }
4562
4563 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4564 tls12_prf->Ai, hash_length );
4565 if( status != PSA_SUCCESS )
4566 goto cleanup;
4567 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4568 if( status != PSA_SUCCESS )
4569 goto cleanup;
4570
4571 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4572 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4573 tls12_prf->Ai, hash_length );
4574 if( status != PSA_SUCCESS )
4575 goto cleanup;
4576 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4577 tls12_prf->label, tls12_prf->label_length );
4578 if( status != PSA_SUCCESS )
4579 goto cleanup;
4580 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4581 tls12_prf->seed, tls12_prf->seed_length );
4582 if( status != PSA_SUCCESS )
4583 goto cleanup;
4584 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4585 tls12_prf->output_block, hash_length );
4586 if( status != PSA_SUCCESS )
4587 goto cleanup;
4588 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4589 if( status != PSA_SUCCESS )
4590 goto cleanup;
4591
Janos Follath7742fee2019-06-17 12:58:10 +01004592
4593cleanup:
4594
Janos Follathea29bfb2019-06-19 12:21:20 +01004595 cleanup_status = psa_hash_abort( &backup );
4596 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4597 status = cleanup_status;
4598
4599 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004600}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004601
Janos Follath844eb0e2019-06-19 12:10:49 +01004602static psa_status_t psa_key_derivation_tls12_prf_read(
4603 psa_tls12_prf_key_derivation_t *tls12_prf,
4604 psa_algorithm_t alg,
4605 uint8_t *output,
4606 size_t output_length )
4607{
4608 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4609 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4610 psa_status_t status;
4611 uint8_t offset, length;
4612
4613 while( output_length != 0 )
4614 {
4615 /* Check if we have fully processed the current block. */
4616 if( tls12_prf->left_in_block == 0 )
4617 {
4618 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4619 alg );
4620 if( status != PSA_SUCCESS )
4621 return( status );
4622
4623 continue;
4624 }
4625
4626 if( tls12_prf->left_in_block > output_length )
4627 length = (uint8_t) output_length;
4628 else
4629 length = tls12_prf->left_in_block;
4630
4631 offset = hash_length - tls12_prf->left_in_block;
4632 memcpy( output, tls12_prf->output_block + offset, length );
4633 output += length;
4634 output_length -= length;
4635 tls12_prf->left_in_block -= length;
4636 }
4637
4638 return( PSA_SUCCESS );
4639}
Gilles Peskinebef7f142018-07-12 17:22:21 +02004640#endif /* MBEDTLS_MD_C */
4641
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004642psa_status_t psa_key_derivation_output_bytes(
4643 psa_key_derivation_operation_t *operation,
4644 uint8_t *output,
4645 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004646{
4647 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004648 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004649
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004650 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004651 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004652 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004653 return PSA_ERROR_BAD_STATE;
4654 }
4655
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004656 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004657 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004658 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004659 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004660 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004661 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004662 goto exit;
4663 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004664 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004665 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004666 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004667 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004668 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4669 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004670 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004671 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004672 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004673 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004674 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004675
Gilles Peskinebef7f142018-07-12 17:22:21 +02004676#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004677 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004678 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004679 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004680 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004681 output, output_length );
4682 }
Janos Follathadbec812019-06-14 11:05:39 +01004683 else
Janos Follathadbec812019-06-14 11:05:39 +01004684 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004685 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004686 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004687 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004688 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004689 output_length );
4690 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004691 else
4692#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004693 {
4694 return( PSA_ERROR_BAD_STATE );
4695 }
4696
4697exit:
4698 if( status != PSA_SUCCESS )
4699 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004700 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004701 * This allows us to differentiate between exhausted operations and
4702 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4703 * operations. */
4704 psa_algorithm_t alg = operation->alg;
4705 psa_key_derivation_abort( operation );
4706 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004707 memset( output, '!', output_length );
4708 }
4709 return( status );
4710}
4711
Gilles Peskine08542d82018-07-19 17:05:42 +02004712#if defined(MBEDTLS_DES_C)
4713static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4714{
4715 if( data_size >= 8 )
4716 mbedtls_des_key_set_parity( data );
4717 if( data_size >= 16 )
4718 mbedtls_des_key_set_parity( data + 8 );
4719 if( data_size >= 24 )
4720 mbedtls_des_key_set_parity( data + 16 );
4721}
4722#endif /* MBEDTLS_DES_C */
4723
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004724static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004725 psa_key_slot_t *slot,
4726 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004727 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004728{
4729 uint8_t *data = NULL;
4730 size_t bytes = PSA_BITS_TO_BYTES( bits );
4731 psa_status_t status;
4732
Gilles Peskine8e338702019-07-30 20:06:31 +02004733 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004734 return( PSA_ERROR_INVALID_ARGUMENT );
4735 if( bits % 8 != 0 )
4736 return( PSA_ERROR_INVALID_ARGUMENT );
4737 data = mbedtls_calloc( 1, bytes );
4738 if( data == NULL )
4739 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4740
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004741 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004742 if( status != PSA_SUCCESS )
4743 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02004744#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004745 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004746 psa_des_set_key_parity( data, bytes );
4747#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004748 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004749
4750exit:
4751 mbedtls_free( data );
4752 return( status );
4753}
4754
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004755psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004756 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004757 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004758{
4759 psa_status_t status;
4760 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004761 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004762
4763 /* Reject any attempt to create a zero-length key so that we don't
4764 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4765 if( psa_get_key_bits( attributes ) == 0 )
4766 return( PSA_ERROR_INVALID_ARGUMENT );
4767
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004768 if( ! operation->can_output_key )
4769 return( PSA_ERROR_NOT_PERMITTED );
4770
Gilles Peskinedf179142019-07-15 22:02:14 +02004771 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
4772 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004773#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4774 if( driver != NULL )
4775 {
4776 /* Deriving a key in a secure element is not implemented yet. */
4777 status = PSA_ERROR_NOT_SUPPORTED;
4778 }
4779#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004780 if( status == PSA_SUCCESS )
4781 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004782 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004783 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004784 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004785 }
4786 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004787 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004788 if( status != PSA_SUCCESS )
4789 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004790 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004791 *handle = 0;
4792 }
4793 return( status );
4794}
4795
Gilles Peskineeab56e42018-07-12 17:12:33 +02004796
4797
4798/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004799/* Key derivation */
4800/****************************************************************/
4801
Gilles Peskine969c5d62019-01-16 15:53:06 +01004802static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004803 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004804 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004805{
Janos Follath5fe19732019-06-20 15:09:30 +01004806 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4807 * initialisers for this union leave some bytes unspecified.) */
4808 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4809
Gilles Peskine969c5d62019-01-16 15:53:06 +01004810 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004811#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004812 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
4813 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4814 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004815 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004816 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004817 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4818 if( hash_size == 0 )
4819 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004820 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4821 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004822 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004823 {
4824 return( PSA_ERROR_NOT_SUPPORTED );
4825 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004826 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004827 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004828 }
4829#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004830 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004831 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004832}
4833
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004834psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004835 psa_algorithm_t alg )
4836{
4837 psa_status_t status;
4838
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004839 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004840 return( PSA_ERROR_BAD_STATE );
4841
Gilles Peskine6843c292019-01-18 16:44:49 +01004842 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4843 return( PSA_ERROR_INVALID_ARGUMENT );
4844 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004845 {
4846 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004847 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004848 }
4849 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4850 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004851 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004852 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004853 else
4854 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004855
4856 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004857 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004858 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004859}
4860
4861#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004862static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004863 psa_algorithm_t hash_alg,
4864 psa_key_derivation_step_t step,
4865 const uint8_t *data,
4866 size_t data_length )
4867{
4868 psa_status_t status;
4869 switch( step )
4870 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004871 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004872 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004873 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004874 status = psa_hmac_setup_internal( &hkdf->hmac,
4875 data, data_length,
4876 hash_alg );
4877 if( status != PSA_SUCCESS )
4878 return( status );
4879 hkdf->state = HKDF_STATE_STARTED;
4880 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004881 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004882 /* If no salt was provided, use an empty salt. */
4883 if( hkdf->state == HKDF_STATE_INIT )
4884 {
4885 status = psa_hmac_setup_internal( &hkdf->hmac,
4886 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004887 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004888 if( status != PSA_SUCCESS )
4889 return( status );
4890 hkdf->state = HKDF_STATE_STARTED;
4891 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004892 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004893 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004894 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4895 data, data_length );
4896 if( status != PSA_SUCCESS )
4897 return( status );
4898 status = psa_hmac_finish_internal( &hkdf->hmac,
4899 hkdf->prk,
4900 sizeof( hkdf->prk ) );
4901 if( status != PSA_SUCCESS )
4902 return( status );
4903 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4904 hkdf->block_number = 0;
4905 hkdf->state = HKDF_STATE_KEYED;
4906 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004907 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004908 if( hkdf->state == HKDF_STATE_OUTPUT )
4909 return( PSA_ERROR_BAD_STATE );
4910 if( hkdf->info_set )
4911 return( PSA_ERROR_BAD_STATE );
4912 hkdf->info_length = data_length;
4913 if( data_length != 0 )
4914 {
4915 hkdf->info = mbedtls_calloc( 1, data_length );
4916 if( hkdf->info == NULL )
4917 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4918 memcpy( hkdf->info, data, data_length );
4919 }
4920 hkdf->info_set = 1;
4921 return( PSA_SUCCESS );
4922 default:
4923 return( PSA_ERROR_INVALID_ARGUMENT );
4924 }
4925}
Janos Follathb03233e2019-06-11 15:30:30 +01004926
Janos Follathf08e2652019-06-13 09:05:41 +01004927static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4928 const uint8_t *data,
4929 size_t data_length )
4930{
4931 if( prf->state != TLS12_PRF_STATE_INIT )
4932 return( PSA_ERROR_BAD_STATE );
4933
Janos Follathd6dce9f2019-07-04 09:11:38 +01004934 if( data_length != 0 )
4935 {
4936 prf->seed = mbedtls_calloc( 1, data_length );
4937 if( prf->seed == NULL )
4938 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004939
Janos Follathd6dce9f2019-07-04 09:11:38 +01004940 memcpy( prf->seed, data, data_length );
4941 prf->seed_length = data_length;
4942 }
Janos Follathf08e2652019-06-13 09:05:41 +01004943
4944 prf->state = TLS12_PRF_STATE_SEED_SET;
4945
4946 return( PSA_SUCCESS );
4947}
4948
Janos Follath81550542019-06-13 14:26:34 +01004949static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4950 psa_algorithm_t hash_alg,
4951 const uint8_t *data,
4952 size_t data_length )
4953{
4954 psa_status_t status;
4955 if( prf->state != TLS12_PRF_STATE_SEED_SET )
4956 return( PSA_ERROR_BAD_STATE );
4957
4958 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4959 if( status != PSA_SUCCESS )
4960 return( status );
4961
4962 prf->state = TLS12_PRF_STATE_KEY_SET;
4963
4964 return( PSA_SUCCESS );
4965}
4966
Janos Follath6660f0e2019-06-17 08:44:03 +01004967static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4968 psa_tls12_prf_key_derivation_t *prf,
4969 psa_algorithm_t hash_alg,
4970 const uint8_t *data,
4971 size_t data_length )
4972{
4973 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004974 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
4975 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01004976
4977 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4978 return( PSA_ERROR_INVALID_ARGUMENT );
4979
4980 /* Quoting RFC 4279, Section 2:
4981 *
4982 * The premaster secret is formed as follows: if the PSK is N octets
4983 * long, concatenate a uint16 with the value N, N zero octets, a second
4984 * uint16 with the value N, and the PSK itself.
4985 */
4986
Janos Follath40e13932019-06-26 13:22:29 +01004987 *cur++ = ( data_length >> 8 ) & 0xff;
4988 *cur++ = ( data_length >> 0 ) & 0xff;
4989 memset( cur, 0, data_length );
4990 cur += data_length;
4991 *cur++ = pms[0];
4992 *cur++ = pms[1];
4993 memcpy( cur, data, data_length );
4994 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01004995
Janos Follath40e13932019-06-26 13:22:29 +01004996 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01004997
4998 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4999 return( status );
5000}
5001
Janos Follath63028dd2019-06-13 09:15:47 +01005002static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5003 const uint8_t *data,
5004 size_t data_length )
5005{
5006 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5007 return( PSA_ERROR_BAD_STATE );
5008
Janos Follathd6dce9f2019-07-04 09:11:38 +01005009 if( data_length != 0 )
5010 {
5011 prf->label = mbedtls_calloc( 1, data_length );
5012 if( prf->label == NULL )
5013 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005014
Janos Follathd6dce9f2019-07-04 09:11:38 +01005015 memcpy( prf->label, data, data_length );
5016 prf->label_length = data_length;
5017 }
Janos Follath63028dd2019-06-13 09:15:47 +01005018
5019 prf->state = TLS12_PRF_STATE_LABEL_SET;
5020
5021 return( PSA_SUCCESS );
5022}
5023
Janos Follathb03233e2019-06-11 15:30:30 +01005024static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5025 psa_algorithm_t hash_alg,
5026 psa_key_derivation_step_t step,
5027 const uint8_t *data,
5028 size_t data_length )
5029{
Janos Follathb03233e2019-06-11 15:30:30 +01005030 switch( step )
5031 {
Janos Follathf08e2652019-06-13 09:05:41 +01005032 case PSA_KEY_DERIVATION_INPUT_SEED:
5033 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005034 case PSA_KEY_DERIVATION_INPUT_SECRET:
5035 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005036 case PSA_KEY_DERIVATION_INPUT_LABEL:
5037 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005038 default:
5039 return( PSA_ERROR_INVALID_ARGUMENT );
5040 }
5041}
Janos Follath6660f0e2019-06-17 08:44:03 +01005042
5043static psa_status_t psa_tls12_prf_psk_to_ms_input(
5044 psa_tls12_prf_key_derivation_t *prf,
5045 psa_algorithm_t hash_alg,
5046 psa_key_derivation_step_t step,
5047 const uint8_t *data,
5048 size_t data_length )
5049{
5050 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005051 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005052 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5053 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005054 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005055
5056 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5057}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005058#endif /* MBEDTLS_MD_C */
5059
Gilles Peskineb8965192019-09-24 16:21:10 +02005060/** Check whether the given key type is acceptable for the given
5061 * input step of a key derivation.
5062 *
5063 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5064 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5065 * Both secret and non-secret inputs can alternatively have the type
5066 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5067 * that the input was passed as a buffer rather than via a key object.
5068 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005069static int psa_key_derivation_check_input_type(
5070 psa_key_derivation_step_t step,
5071 psa_key_type_t key_type )
5072{
5073 switch( step )
5074 {
5075 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005076 if( key_type == PSA_KEY_TYPE_DERIVE )
5077 return( PSA_SUCCESS );
5078 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005079 return( PSA_SUCCESS );
5080 break;
5081 case PSA_KEY_DERIVATION_INPUT_LABEL:
5082 case PSA_KEY_DERIVATION_INPUT_SALT:
5083 case PSA_KEY_DERIVATION_INPUT_INFO:
5084 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005085 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5086 return( PSA_SUCCESS );
5087 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005088 return( PSA_SUCCESS );
5089 break;
5090 }
5091 return( PSA_ERROR_INVALID_ARGUMENT );
5092}
5093
Janos Follathb80a94e2019-06-12 15:54:46 +01005094static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005095 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005096 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005097 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005098 const uint8_t *data,
5099 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005100{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005101 psa_status_t status;
5102 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5103
5104 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005105 if( status != PSA_SUCCESS )
5106 goto exit;
5107
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005108#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005109 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005110 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005111 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005112 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005113 step, data, data_length );
5114 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005115 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005116 {
Janos Follathb03233e2019-06-11 15:30:30 +01005117 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5118 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5119 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005120 }
5121 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5122 {
5123 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5124 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5125 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005126 }
5127 else
5128#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005129 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005130 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005131 return( PSA_ERROR_BAD_STATE );
5132 }
5133
Gilles Peskine224b0d62019-09-23 18:13:17 +02005134exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005135 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005136 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005137 return( status );
5138}
5139
Janos Follath51f4a0f2019-06-14 11:35:55 +01005140psa_status_t psa_key_derivation_input_bytes(
5141 psa_key_derivation_operation_t *operation,
5142 psa_key_derivation_step_t step,
5143 const uint8_t *data,
5144 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005145{
Gilles Peskineb8965192019-09-24 16:21:10 +02005146 return( psa_key_derivation_input_internal( operation, step,
5147 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005148 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005149}
5150
Janos Follath51f4a0f2019-06-14 11:35:55 +01005151psa_status_t psa_key_derivation_input_key(
5152 psa_key_derivation_operation_t *operation,
5153 psa_key_derivation_step_t step,
5154 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005155{
5156 psa_key_slot_t *slot;
5157 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005158
Gilles Peskine28f8f302019-07-24 13:30:31 +02005159 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005160 PSA_KEY_USAGE_DERIVE,
5161 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005162 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005163 {
5164 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005165 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005166 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005167
5168 /* Passing a key object as a SECRET input unlocks the permission
5169 * to output to a key object. */
5170 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5171 operation->can_output_key = 1;
5172
Janos Follathb80a94e2019-06-12 15:54:46 +01005173 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005174 step, slot->attr.type,
Janos Follathb80a94e2019-06-12 15:54:46 +01005175 slot->data.raw.data,
5176 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005177}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005178
5179
5180
5181/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005182/* Key agreement */
5183/****************************************************************/
5184
Gilles Peskinea05219c2018-11-16 16:02:56 +01005185#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005186static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5187 size_t peer_key_length,
5188 const mbedtls_ecp_keypair *our_key,
5189 uint8_t *shared_secret,
5190 size_t shared_secret_size,
5191 size_t *shared_secret_length )
5192{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005193 mbedtls_ecp_keypair *their_key = NULL;
5194 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005195 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005196 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005197
Jaeden Ameroccdce902019-01-10 11:42:27 +00005198 status = psa_import_ec_public_key(
5199 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5200 peer_key, peer_key_length,
5201 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005202 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005203 goto exit;
5204
Jaeden Amero97271b32019-01-10 19:38:51 +00005205 status = mbedtls_to_psa_error(
5206 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5207 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005208 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005209 status = mbedtls_to_psa_error(
5210 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5211 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005212 goto exit;
5213
Jaeden Amero97271b32019-01-10 19:38:51 +00005214 status = mbedtls_to_psa_error(
5215 mbedtls_ecdh_calc_secret( &ecdh,
5216 shared_secret_length,
5217 shared_secret, shared_secret_size,
5218 mbedtls_ctr_drbg_random,
5219 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005220
5221exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005222 mbedtls_ecdh_free( &ecdh );
Jaeden Ameroccdce902019-01-10 11:42:27 +00005223 mbedtls_ecp_keypair_free( their_key );
5224 mbedtls_free( their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005225 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005226}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005227#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005228
Gilles Peskine01d718c2018-09-18 12:01:02 +02005229#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5230
Gilles Peskine0216fe12019-04-11 21:23:21 +02005231static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5232 psa_key_slot_t *private_key,
5233 const uint8_t *peer_key,
5234 size_t peer_key_length,
5235 uint8_t *shared_secret,
5236 size_t shared_secret_size,
5237 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005238{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005239 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005240 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005241#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005242 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005243 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005244 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005245 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5246 private_key->data.ecp,
5247 shared_secret, shared_secret_size,
5248 shared_secret_length ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005249#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005250 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005251 (void) private_key;
5252 (void) peer_key;
5253 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005254 (void) shared_secret;
5255 (void) shared_secret_size;
5256 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005257 return( PSA_ERROR_NOT_SUPPORTED );
5258 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005259}
5260
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005261/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005262 * to potentially free embedded data structures and wipe confidential data.
5263 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005265 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005266 psa_key_slot_t *private_key,
5267 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005268 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005269{
5270 psa_status_t status;
5271 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5272 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005273 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005274
5275 /* Step 1: run the secret agreement algorithm to generate the shared
5276 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005277 status = psa_key_agreement_raw_internal( ka_alg,
5278 private_key,
5279 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005280 shared_secret,
5281 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005282 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005283 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005284 goto exit;
5285
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005286 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005287 * the shared secret. A shared secret is permitted wherever a key
5288 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005289 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005290 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005291 shared_secret,
5292 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005293
Gilles Peskine12313cd2018-06-20 00:20:32 +02005294exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005295 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005296 return( status );
5297}
5298
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005299psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005300 psa_key_derivation_step_t step,
5301 psa_key_handle_t private_key,
5302 const uint8_t *peer_key,
5303 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005304{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005305 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005306 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005307 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005308 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005309 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005310 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005311 if( status != PSA_SUCCESS )
5312 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005313 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005314 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005315 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005316 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005317 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005318 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005319}
5320
Gilles Peskinebe697d82019-05-16 18:00:41 +02005321psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5322 psa_key_handle_t private_key,
5323 const uint8_t *peer_key,
5324 size_t peer_key_length,
5325 uint8_t *output,
5326 size_t output_size,
5327 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005328{
5329 psa_key_slot_t *slot;
5330 psa_status_t status;
5331
5332 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5333 {
5334 status = PSA_ERROR_INVALID_ARGUMENT;
5335 goto exit;
5336 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005337 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005338 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005339 if( status != PSA_SUCCESS )
5340 goto exit;
5341
5342 status = psa_key_agreement_raw_internal( alg, slot,
5343 peer_key, peer_key_length,
5344 output, output_size,
5345 output_length );
5346
5347exit:
5348 if( status != PSA_SUCCESS )
5349 {
5350 /* If an error happens and is not handled properly, the output
5351 * may be used as a key to protect sensitive data. Arrange for such
5352 * a key to be random, which is likely to result in decryption or
5353 * verification errors. This is better than filling the buffer with
5354 * some constant data such as zeros, which would result in the data
5355 * being protected with a reproducible, easily knowable key.
5356 */
5357 psa_generate_random( output, output_size );
5358 *output_length = output_size;
5359 }
5360 return( status );
5361}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005362
5363
5364/****************************************************************/
5365/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005366/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005367
Gilles Peskine4c317f42018-07-12 01:24:09 +02005368psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005369 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005370{
Janos Follath24eed8d2019-11-22 13:21:35 +00005371 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005372 GUARD_MODULE_INITIALIZED;
5373
Gilles Peskinef181eca2019-08-07 13:49:00 +02005374 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5375 {
5376 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5377 output,
5378 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5379 if( ret != 0 )
5380 return( mbedtls_to_psa_error( ret ) );
5381 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5382 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5383 }
5384
Gilles Peskinee59236f2018-01-27 23:32:46 +01005385 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5386 return( mbedtls_to_psa_error( ret ) );
5387}
5388
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005389#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5390#include "mbedtls/entropy_poll.h"
5391
Gilles Peskine7228da22019-07-15 11:06:15 +02005392psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005393 size_t seed_size )
5394{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005395 if( global_data.initialized )
5396 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005397
5398 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5399 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5400 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5401 return( PSA_ERROR_INVALID_ARGUMENT );
5402
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005403 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005404}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005405#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005406
Gilles Peskinee56e8782019-04-26 17:34:02 +02005407#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5408static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5409 size_t domain_parameters_size,
5410 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005411{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005412 size_t i;
5413 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005414
Gilles Peskinee56e8782019-04-26 17:34:02 +02005415 if( domain_parameters_size == 0 )
5416 {
5417 *exponent = 65537;
5418 return( PSA_SUCCESS );
5419 }
5420
5421 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5422 * support values that fit in a 32-bit integer, which is larger than
5423 * int on just about every platform anyway. */
5424 if( domain_parameters_size > sizeof( acc ) )
5425 return( PSA_ERROR_NOT_SUPPORTED );
5426 for( i = 0; i < domain_parameters_size; i++ )
5427 acc = ( acc << 8 ) | domain_parameters[i];
5428 if( acc > INT_MAX )
5429 return( PSA_ERROR_NOT_SUPPORTED );
5430 *exponent = acc;
5431 return( PSA_SUCCESS );
5432}
5433#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5434
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005435static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005436 psa_key_slot_t *slot, size_t bits,
5437 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005438{
Gilles Peskine8e338702019-07-30 20:06:31 +02005439 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005440
Gilles Peskinee56e8782019-04-26 17:34:02 +02005441 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005442 return( PSA_ERROR_INVALID_ARGUMENT );
5443
Gilles Peskinee59236f2018-01-27 23:32:46 +01005444 if( key_type_is_raw_bytes( type ) )
5445 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005446 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005447 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
5448 if( status != PSA_SUCCESS )
5449 return( status );
5450 status = psa_generate_random( slot->data.raw.data,
5451 slot->data.raw.bytes );
5452 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005453 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005454#if defined(MBEDTLS_DES_C)
5455 if( type == PSA_KEY_TYPE_DES )
5456 psa_des_set_key_parity( slot->data.raw.data,
5457 slot->data.raw.bytes );
5458#endif /* MBEDTLS_DES_C */
5459 }
5460 else
5461
5462#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005463 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005464 {
5465 mbedtls_rsa_context *rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00005466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005467 int exponent;
5468 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005469 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5470 return( PSA_ERROR_NOT_SUPPORTED );
5471 /* Accept only byte-aligned keys, for the same reasons as
5472 * in psa_import_rsa_key(). */
5473 if( bits % 8 != 0 )
5474 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005475 status = psa_read_rsa_exponent( domain_parameters,
5476 domain_parameters_size,
5477 &exponent );
5478 if( status != PSA_SUCCESS )
5479 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005480 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5481 if( rsa == NULL )
5482 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5483 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5484 ret = mbedtls_rsa_gen_key( rsa,
5485 mbedtls_ctr_drbg_random,
5486 &global_data.ctr_drbg,
5487 (unsigned int) bits,
5488 exponent );
5489 if( ret != 0 )
5490 {
5491 mbedtls_rsa_free( rsa );
5492 mbedtls_free( rsa );
5493 return( mbedtls_to_psa_error( ret ) );
5494 }
5495 slot->data.rsa = rsa;
5496 }
5497 else
5498#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5499
5500#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005501 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005502 {
5503 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5504 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5505 const mbedtls_ecp_curve_info *curve_info =
5506 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5507 mbedtls_ecp_keypair *ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00005508 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005509 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005510 return( PSA_ERROR_NOT_SUPPORTED );
5511 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5512 return( PSA_ERROR_NOT_SUPPORTED );
5513 if( curve_info->bit_size != bits )
5514 return( PSA_ERROR_INVALID_ARGUMENT );
5515 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5516 if( ecp == NULL )
5517 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5518 mbedtls_ecp_keypair_init( ecp );
5519 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5520 mbedtls_ctr_drbg_random,
5521 &global_data.ctr_drbg );
5522 if( ret != 0 )
5523 {
5524 mbedtls_ecp_keypair_free( ecp );
5525 mbedtls_free( ecp );
5526 return( mbedtls_to_psa_error( ret ) );
5527 }
5528 slot->data.ecp = ecp;
5529 }
5530 else
5531#endif /* MBEDTLS_ECP_C */
5532
5533 return( PSA_ERROR_NOT_SUPPORTED );
5534
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005535 return( PSA_SUCCESS );
5536}
Darryl Green0c6575a2018-11-07 16:05:30 +00005537
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005538psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005539 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005540{
5541 psa_status_t status;
5542 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005543 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02005544
Gilles Peskine0f84d622019-09-12 19:03:13 +02005545 /* Reject any attempt to create a zero-length key so that we don't
5546 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5547 if( psa_get_key_bits( attributes ) == 0 )
5548 return( PSA_ERROR_INVALID_ARGUMENT );
5549
Gilles Peskinedf179142019-07-15 22:02:14 +02005550 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
5551 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005552 if( status != PSA_SUCCESS )
5553 goto exit;
5554
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005555#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5556 if( driver != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00005557 {
Gilles Peskine11792082019-08-06 18:36:36 +02005558 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
5559 size_t pubkey_length = 0; /* We don't support this feature yet */
5560 if( drv->key_management == NULL ||
5561 drv->key_management->p_generate == NULL )
5562 {
5563 status = PSA_ERROR_NOT_SUPPORTED;
5564 goto exit;
5565 }
5566 status = drv->key_management->p_generate(
5567 psa_get_se_driver_context( driver ),
5568 slot->data.se.slot_number, attributes,
5569 NULL, 0, &pubkey_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00005570 }
Gilles Peskine11792082019-08-06 18:36:36 +02005571 else
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005572#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005573 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005574 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005575 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005576 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005577 }
Gilles Peskine11792082019-08-06 18:36:36 +02005578
5579exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005580 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005581 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005582 if( status != PSA_SUCCESS )
5583 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005584 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005585 *handle = 0;
5586 }
Darryl Green0c6575a2018-11-07 16:05:30 +00005587 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005588}
5589
5590
Gilles Peskinee59236f2018-01-27 23:32:46 +01005591
5592/****************************************************************/
5593/* Module setup */
5594/****************************************************************/
5595
Gilles Peskine5e769522018-11-20 21:59:56 +01005596psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5597 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5598 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5599{
5600 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5601 return( PSA_ERROR_BAD_STATE );
5602 global_data.entropy_init = entropy_init;
5603 global_data.entropy_free = entropy_free;
5604 return( PSA_SUCCESS );
5605}
5606
Gilles Peskinee59236f2018-01-27 23:32:46 +01005607void mbedtls_psa_crypto_free( void )
5608{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005609 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005610 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5611 {
5612 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005613 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005614 }
5615 /* Wipe all remaining data, including configuration.
5616 * In particular, this sets all state indicator to the value
5617 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005618 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005619#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005620 /* Unregister all secure element drivers, so that we restart from
5621 * a pristine state. */
5622 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005623#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005624}
5625
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005626#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5627/** Recover a transaction that was interrupted by a power failure.
5628 *
5629 * This function is called during initialization, before psa_crypto_init()
5630 * returns. If this function returns a failure status, the initialization
5631 * fails.
5632 */
5633static psa_status_t psa_crypto_recover_transaction(
5634 const psa_crypto_transaction_t *transaction )
5635{
5636 switch( transaction->unknown.type )
5637 {
5638 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5639 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005640 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005641 * is implemented.
5642 * https://github.com/ARMmbed/mbed-crypto/issues/218
5643 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005644 default:
5645 /* We found an unsupported transaction in the storage.
5646 * We don't know what state the storage is in. Give up. */
5647 return( PSA_ERROR_STORAGE_FAILURE );
5648 }
5649}
5650#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5651
Gilles Peskinee59236f2018-01-27 23:32:46 +01005652psa_status_t psa_crypto_init( void )
5653{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005654 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005655 const unsigned char drbg_seed[] = "PSA";
5656
Gilles Peskinec6b69072018-11-20 21:42:52 +01005657 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005658 if( global_data.initialized != 0 )
5659 return( PSA_SUCCESS );
5660
Gilles Peskine5e769522018-11-20 21:59:56 +01005661 /* Set default configuration if
5662 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5663 if( global_data.entropy_init == NULL )
5664 global_data.entropy_init = mbedtls_entropy_init;
5665 if( global_data.entropy_free == NULL )
5666 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005667
Gilles Peskinec6b69072018-11-20 21:42:52 +01005668 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005669 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01005670#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5671 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5672 /* The PSA entropy injection feature depends on using NV seed as an entropy
5673 * source. Add NV seed as an entropy source for PSA entropy injection. */
5674 mbedtls_entropy_add_source( &global_data.entropy,
5675 mbedtls_nv_seed_poll, NULL,
5676 MBEDTLS_ENTROPY_BLOCK_SIZE,
5677 MBEDTLS_ENTROPY_SOURCE_STRONG );
5678#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01005679 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005680 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005681 status = mbedtls_to_psa_error(
5682 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5683 mbedtls_entropy_func,
5684 &global_data.entropy,
5685 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5686 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005687 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005688 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005689
Gilles Peskine66fb1262018-12-10 16:29:04 +01005690 status = psa_initialize_key_slots( );
5691 if( status != PSA_SUCCESS )
5692 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005693
Gilles Peskined9348f22019-10-01 15:22:29 +02005694#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5695 status = psa_init_all_se_drivers( );
5696 if( status != PSA_SUCCESS )
5697 goto exit;
5698#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5699
Gilles Peskine4b734222019-07-24 15:56:31 +02005700#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005701 status = psa_crypto_load_transaction( );
5702 if( status == PSA_SUCCESS )
5703 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005704 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5705 if( status != PSA_SUCCESS )
5706 goto exit;
5707 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005708 }
5709 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5710 {
5711 /* There's no transaction to complete. It's all good. */
5712 status = PSA_SUCCESS;
5713 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005714#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005715
Gilles Peskinec6b69072018-11-20 21:42:52 +01005716 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005717 global_data.initialized = 1;
5718
5719exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005720 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005721 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005722 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005723}
5724
5725#endif /* MBEDTLS_PSA_CRYPTO_C */