blob: ad7367b9cf0ad250c0068d118cfe1f4a2c740efc [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)
Mohammad Abo Mokha5c7b7d2018-07-04 15:57:00 +030029/*
itayzafrir14e76782019-01-16 11:16:39 +020030 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is being built for SPM
31 * (Secure Partition Manager) integration which separates the code into two
32 * parts: NSPE (Non-Secure Processing Environment) and SPE (Secure Processing
33 * Environment). When building for the SPE, an additional header file should be
34 * included.
Mohammad Abo Mokha5c7b7d2018-07-04 15:57:00 +030035 */
mohammad160327010052018-07-03 13:16:15 +030036#if defined(MBEDTLS_PSA_CRYPTO_SPM)
Mohammad Abo Mokha5c7b7d2018-07-04 15:57:00 +030037/*
itayzafrir14e76782019-01-16 11:16:39 +020038 * PSA_CRYPTO_SECURE means that this file is compiled for the SPE.
39 * Some headers will be affected by this flag.
Mohammad Abo Mokha5c7b7d2018-07-04 15:57:00 +030040 */
mohammad160327010052018-07-03 13:16:15 +030041#define PSA_CRYPTO_SECURE 1
42#include "crypto_spe.h"
43#endif
44
Gilles Peskinee59236f2018-01-27 23:32:46 +010045#include "psa/crypto.h"
46
Gilles Peskine039b90c2018-12-07 18:24:41 +010047#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010048#include "psa_crypto_invasive.h"
Gilles Peskine961849f2018-11-30 18:54:54 +010049#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010050/* Include internal declarations that are useful for implementing persistently
51 * stored keys. */
52#include "psa_crypto_storage.h"
53
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#include <stdlib.h>
55#include <string.h>
56#if defined(MBEDTLS_PLATFORM_C)
57#include "mbedtls/platform.h"
58#else
59#define mbedtls_calloc calloc
60#define mbedtls_free free
61#endif
62
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020064#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000065#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020066#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010067#include "mbedtls/blowfish.h"
68#include "mbedtls/camellia.h"
69#include "mbedtls/cipher.h"
70#include "mbedtls/ccm.h"
71#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020074#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010075#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010076#include "mbedtls/entropy.h"
Netanel Gonen2bcd3122018-11-19 11:53:02 +020077#include "mbedtls/entropy_poll.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010078#include "mbedtls/error.h"
79#include "mbedtls/gcm.h"
80#include "mbedtls/md2.h"
81#include "mbedtls/md4.h"
82#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010083#include "mbedtls/md.h"
84#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010085#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010086#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010087#include "mbedtls/platform_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010088#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010089#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010090#include "mbedtls/sha1.h"
91#include "mbedtls/sha256.h"
92#include "mbedtls/sha512.h"
93#include "mbedtls/xtea.h"
94
Netanel Gonen2bcd3122018-11-19 11:53:02 +020095#if ( defined(MBEDTLS_ENTROPY_NV_SEED) && defined(MBEDTLS_PSA_HAS_ITS_IO) )
Oren Cohen23a67842019-01-24 14:32:11 +020096#include "psa/internal_trusted_storage.h"
Netanel Gonen2bcd3122018-11-19 11:53:02 +020097#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +010098
Gilles Peskine996deb12018-08-01 15:45:45 +020099#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
100
Gilles Peskine9ef733f2018-02-07 21:05:37 +0100101/* constant-time buffer comparison */
102static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
103{
104 size_t i;
105 unsigned char diff = 0;
106
107 for( i = 0; i < n; i++ )
108 diff |= a[i] ^ b[i];
109
110 return( diff );
111}
112
113
114
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100115/****************************************************************/
116/* Global data, support functions and library management */
117/****************************************************************/
118
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200119static int key_type_is_raw_bytes( psa_key_type_t type )
120{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200121 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200122}
123
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100124/* Values for psa_global_data_t::rng_state */
125#define RNG_NOT_INITIALIZED 0
126#define RNG_INITIALIZED 1
127#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100128
Gilles Peskine2d277862018-06-18 15:41:12 +0200129typedef struct
130{
Gilles Peskine5e769522018-11-20 21:59:56 +0100131 void (* entropy_init )( mbedtls_entropy_context *ctx );
132 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133 mbedtls_entropy_context entropy;
134 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100135 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100136 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100137} psa_global_data_t;
138
139static psa_global_data_t global_data;
140
itayzafrir0adf0fc2018-09-06 16:24:41 +0300141#define GUARD_MODULE_INITIALIZED \
142 if( global_data.initialized == 0 ) \
143 return( PSA_ERROR_BAD_STATE );
144
Gilles Peskinee59236f2018-01-27 23:32:46 +0100145static psa_status_t mbedtls_to_psa_error( int ret )
146{
Gilles Peskinea5905292018-02-07 20:59:33 +0100147 /* If there's both a high-level code and low-level code, dispatch on
148 * the high-level code. */
149 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100150 {
151 case 0:
152 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100153
154 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
155 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
156 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
157 return( PSA_ERROR_NOT_SUPPORTED );
158 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
159 return( PSA_ERROR_HARDWARE_FAILURE );
160
161 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
162 return( PSA_ERROR_HARDWARE_FAILURE );
163
Gilles Peskine9a944802018-06-21 09:35:35 +0200164 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
165 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
166 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
167 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
168 case MBEDTLS_ERR_ASN1_INVALID_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
173 return( PSA_ERROR_BUFFER_TOO_SMALL );
174
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000175 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
177 return( PSA_ERROR_NOT_SUPPORTED );
178 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
179 return( PSA_ERROR_HARDWARE_FAILURE );
180
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000181 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100182 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
183 return( PSA_ERROR_NOT_SUPPORTED );
184 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
185 return( PSA_ERROR_HARDWARE_FAILURE );
186
187 case MBEDTLS_ERR_CCM_BAD_INPUT:
188 return( PSA_ERROR_INVALID_ARGUMENT );
189 case MBEDTLS_ERR_CCM_AUTH_FAILED:
190 return( PSA_ERROR_INVALID_SIGNATURE );
191 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
192 return( PSA_ERROR_HARDWARE_FAILURE );
193
194 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
195 return( PSA_ERROR_NOT_SUPPORTED );
196 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
197 return( PSA_ERROR_INVALID_ARGUMENT );
198 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
199 return( PSA_ERROR_INSUFFICIENT_MEMORY );
200 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
201 return( PSA_ERROR_INVALID_PADDING );
202 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
203 return( PSA_ERROR_BAD_STATE );
204 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
205 return( PSA_ERROR_INVALID_SIGNATURE );
206 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
207 return( PSA_ERROR_TAMPERING_DETECTED );
208 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
209 return( PSA_ERROR_HARDWARE_FAILURE );
210
211 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
212 return( PSA_ERROR_HARDWARE_FAILURE );
213
214 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
215 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
216 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
217 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
218 return( PSA_ERROR_NOT_SUPPORTED );
219 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
220 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
221
222 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
223 return( PSA_ERROR_NOT_SUPPORTED );
224 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
225 return( PSA_ERROR_HARDWARE_FAILURE );
226
Gilles Peskinee59236f2018-01-27 23:32:46 +0100227 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
228 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
229 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
230 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100231
232 case MBEDTLS_ERR_GCM_AUTH_FAILED:
233 return( PSA_ERROR_INVALID_SIGNATURE );
234 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200235 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100236 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
237 return( PSA_ERROR_HARDWARE_FAILURE );
238
239 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
241 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
242 return( PSA_ERROR_HARDWARE_FAILURE );
243
244 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
245 return( PSA_ERROR_NOT_SUPPORTED );
246 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
247 return( PSA_ERROR_INVALID_ARGUMENT );
248 case MBEDTLS_ERR_MD_ALLOC_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_MEMORY );
250 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
251 return( PSA_ERROR_STORAGE_FAILURE );
252 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
253 return( PSA_ERROR_HARDWARE_FAILURE );
254
Gilles Peskinef76aa772018-10-29 19:24:33 +0100255 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
256 return( PSA_ERROR_STORAGE_FAILURE );
257 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
258 return( PSA_ERROR_INVALID_ARGUMENT );
259 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
260 return( PSA_ERROR_INVALID_ARGUMENT );
261 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
262 return( PSA_ERROR_BUFFER_TOO_SMALL );
263 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
264 return( PSA_ERROR_INVALID_ARGUMENT );
265 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
266 return( PSA_ERROR_INVALID_ARGUMENT );
267 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
268 return( PSA_ERROR_INVALID_ARGUMENT );
269 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
270 return( PSA_ERROR_INSUFFICIENT_MEMORY );
271
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100272 case MBEDTLS_ERR_PK_ALLOC_FAILED:
273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
274 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
275 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100278 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100279 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
280 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
281 return( PSA_ERROR_INVALID_ARGUMENT );
282 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
283 return( PSA_ERROR_NOT_SUPPORTED );
284 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
285 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
286 return( PSA_ERROR_NOT_PERMITTED );
287 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_PK_INVALID_ALG:
290 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
291 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
292 return( PSA_ERROR_NOT_SUPPORTED );
293 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
294 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100295 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
296 return( PSA_ERROR_HARDWARE_FAILURE );
297
298 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
299 return( PSA_ERROR_HARDWARE_FAILURE );
300
301 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
302 return( PSA_ERROR_INVALID_ARGUMENT );
303 case MBEDTLS_ERR_RSA_INVALID_PADDING:
304 return( PSA_ERROR_INVALID_PADDING );
305 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
306 return( PSA_ERROR_HARDWARE_FAILURE );
307 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
308 return( PSA_ERROR_INVALID_ARGUMENT );
309 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
310 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
311 return( PSA_ERROR_TAMPERING_DETECTED );
312 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
313 return( PSA_ERROR_INVALID_SIGNATURE );
314 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
315 return( PSA_ERROR_BUFFER_TOO_SMALL );
316 case MBEDTLS_ERR_RSA_RNG_FAILED:
317 return( PSA_ERROR_INSUFFICIENT_MEMORY );
318 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
319 return( PSA_ERROR_NOT_SUPPORTED );
320 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
321 return( PSA_ERROR_HARDWARE_FAILURE );
322
323 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
324 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
325 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
326 return( PSA_ERROR_HARDWARE_FAILURE );
327
328 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
329 return( PSA_ERROR_INVALID_ARGUMENT );
330 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
331 return( PSA_ERROR_HARDWARE_FAILURE );
332
itayzafrir5c753392018-05-08 11:18:38 +0300333 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300334 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300335 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300336 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
337 return( PSA_ERROR_BUFFER_TOO_SMALL );
338 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
339 return( PSA_ERROR_NOT_SUPPORTED );
340 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
341 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
342 return( PSA_ERROR_INVALID_SIGNATURE );
343 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
344 return( PSA_ERROR_INSUFFICIENT_MEMORY );
345 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
346 return( PSA_ERROR_HARDWARE_FAILURE );
itayzafrir5c753392018-05-08 11:18:38 +0300347
Gilles Peskinee59236f2018-01-27 23:32:46 +0100348 default:
349 return( PSA_ERROR_UNKNOWN_ERROR );
350 }
351}
352
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200353
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200354
355
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100356/****************************************************************/
357/* Key management */
358/****************************************************************/
359
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100360#if defined(MBEDTLS_ECP_C)
Gilles Peskine34ef7f52018-06-18 20:47:51 +0200361static psa_ecc_curve_t mbedtls_ecc_group_to_psa( mbedtls_ecp_group_id grpid )
362{
363 switch( grpid )
364 {
365 case MBEDTLS_ECP_DP_SECP192R1:
366 return( PSA_ECC_CURVE_SECP192R1 );
367 case MBEDTLS_ECP_DP_SECP224R1:
368 return( PSA_ECC_CURVE_SECP224R1 );
369 case MBEDTLS_ECP_DP_SECP256R1:
370 return( PSA_ECC_CURVE_SECP256R1 );
371 case MBEDTLS_ECP_DP_SECP384R1:
372 return( PSA_ECC_CURVE_SECP384R1 );
373 case MBEDTLS_ECP_DP_SECP521R1:
374 return( PSA_ECC_CURVE_SECP521R1 );
375 case MBEDTLS_ECP_DP_BP256R1:
376 return( PSA_ECC_CURVE_BRAINPOOL_P256R1 );
377 case MBEDTLS_ECP_DP_BP384R1:
378 return( PSA_ECC_CURVE_BRAINPOOL_P384R1 );
379 case MBEDTLS_ECP_DP_BP512R1:
380 return( PSA_ECC_CURVE_BRAINPOOL_P512R1 );
381 case MBEDTLS_ECP_DP_CURVE25519:
382 return( PSA_ECC_CURVE_CURVE25519 );
383 case MBEDTLS_ECP_DP_SECP192K1:
384 return( PSA_ECC_CURVE_SECP192K1 );
385 case MBEDTLS_ECP_DP_SECP224K1:
386 return( PSA_ECC_CURVE_SECP224K1 );
387 case MBEDTLS_ECP_DP_SECP256K1:
388 return( PSA_ECC_CURVE_SECP256K1 );
389 case MBEDTLS_ECP_DP_CURVE448:
390 return( PSA_ECC_CURVE_CURVE448 );
391 default:
392 return( 0 );
393 }
394}
395
Gilles Peskine12313cd2018-06-20 00:20:32 +0200396static mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_curve_t curve )
397{
398 switch( curve )
399 {
400 case PSA_ECC_CURVE_SECP192R1:
401 return( MBEDTLS_ECP_DP_SECP192R1 );
402 case PSA_ECC_CURVE_SECP224R1:
403 return( MBEDTLS_ECP_DP_SECP224R1 );
404 case PSA_ECC_CURVE_SECP256R1:
405 return( MBEDTLS_ECP_DP_SECP256R1 );
406 case PSA_ECC_CURVE_SECP384R1:
407 return( MBEDTLS_ECP_DP_SECP384R1 );
408 case PSA_ECC_CURVE_SECP521R1:
409 return( MBEDTLS_ECP_DP_SECP521R1 );
410 case PSA_ECC_CURVE_BRAINPOOL_P256R1:
411 return( MBEDTLS_ECP_DP_BP256R1 );
412 case PSA_ECC_CURVE_BRAINPOOL_P384R1:
413 return( MBEDTLS_ECP_DP_BP384R1 );
414 case PSA_ECC_CURVE_BRAINPOOL_P512R1:
415 return( MBEDTLS_ECP_DP_BP512R1 );
416 case PSA_ECC_CURVE_CURVE25519:
417 return( MBEDTLS_ECP_DP_CURVE25519 );
418 case PSA_ECC_CURVE_SECP192K1:
419 return( MBEDTLS_ECP_DP_SECP192K1 );
420 case PSA_ECC_CURVE_SECP224K1:
421 return( MBEDTLS_ECP_DP_SECP224K1 );
422 case PSA_ECC_CURVE_SECP256K1:
423 return( MBEDTLS_ECP_DP_SECP256K1 );
424 case PSA_ECC_CURVE_CURVE448:
425 return( MBEDTLS_ECP_DP_CURVE448 );
426 default:
427 return( MBEDTLS_ECP_DP_NONE );
428 }
429}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100430#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200431
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200432static psa_status_t prepare_raw_data_slot( psa_key_type_t type,
433 size_t bits,
434 struct raw_data *raw )
435{
436 /* Check that the bit size is acceptable for the key type */
437 switch( type )
438 {
439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200440 if( bits == 0 )
441 {
442 raw->bytes = 0;
443 raw->data = NULL;
444 return( PSA_SUCCESS );
445 }
446 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200447#if defined(MBEDTLS_MD_C)
448 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200449#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200450 case PSA_KEY_TYPE_DERIVE:
451 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200452#if defined(MBEDTLS_AES_C)
453 case PSA_KEY_TYPE_AES:
454 if( bits != 128 && bits != 192 && bits != 256 )
455 return( PSA_ERROR_INVALID_ARGUMENT );
456 break;
457#endif
458#if defined(MBEDTLS_CAMELLIA_C)
459 case PSA_KEY_TYPE_CAMELLIA:
460 if( bits != 128 && bits != 192 && bits != 256 )
461 return( PSA_ERROR_INVALID_ARGUMENT );
462 break;
463#endif
464#if defined(MBEDTLS_DES_C)
465 case PSA_KEY_TYPE_DES:
466 if( bits != 64 && bits != 128 && bits != 192 )
467 return( PSA_ERROR_INVALID_ARGUMENT );
468 break;
469#endif
470#if defined(MBEDTLS_ARC4_C)
471 case PSA_KEY_TYPE_ARC4:
472 if( bits < 8 || bits > 2048 )
473 return( PSA_ERROR_INVALID_ARGUMENT );
474 break;
475#endif
476 default:
477 return( PSA_ERROR_NOT_SUPPORTED );
478 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200479 if( bits % 8 != 0 )
480 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200481
482 /* Allocate memory for the key */
483 raw->bytes = PSA_BITS_TO_BYTES( bits );
484 raw->data = mbedtls_calloc( 1, raw->bytes );
485 if( raw->data == NULL )
486 {
487 raw->bytes = 0;
488 return( PSA_ERROR_INSUFFICIENT_MEMORY );
489 }
490 return( PSA_SUCCESS );
491}
492
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200493#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100494/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
495 * that are not a multiple of 8) well. For example, there is only
496 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
497 * way to return the exact bit size of a key.
498 * To keep things simple, reject non-byte-aligned key sizes. */
499static psa_status_t psa_check_rsa_key_byte_aligned(
500 const mbedtls_rsa_context *rsa )
501{
502 mbedtls_mpi n;
503 psa_status_t status;
504 mbedtls_mpi_init( &n );
505 status = mbedtls_to_psa_error(
506 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
507 if( status == PSA_SUCCESS )
508 {
509 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
510 status = PSA_ERROR_NOT_SUPPORTED;
511 }
512 mbedtls_mpi_free( &n );
513 return( status );
514}
515
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000516static psa_status_t psa_import_rsa_key( psa_key_type_t type,
517 const uint8_t *data,
518 size_t data_length,
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200519 mbedtls_rsa_context **p_rsa )
520{
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000521 psa_status_t status;
522 mbedtls_pk_context pk;
523 mbedtls_rsa_context *rsa;
524 size_t bits;
525
526 mbedtls_pk_init( &pk );
527
528 /* Parse the data. */
529 if( PSA_KEY_TYPE_IS_KEYPAIR( type ) )
530 status = mbedtls_to_psa_error(
531 mbedtls_pk_parse_key( &pk, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200532 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000533 status = mbedtls_to_psa_error(
534 mbedtls_pk_parse_public_key( &pk, data, data_length ) );
535 if( status != PSA_SUCCESS )
536 goto exit;
537
538 /* We have something that the pkparse module recognizes. If it is a
539 * valid RSA key, store it. */
540 if( mbedtls_pk_get_type( &pk ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200541 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000542 status = PSA_ERROR_INVALID_ARGUMENT;
543 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200544 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000545
546 rsa = mbedtls_pk_rsa( pk );
547 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
548 * supports non-byte-aligned key sizes, but not well. For example,
549 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
550 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
551 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
552 {
553 status = PSA_ERROR_NOT_SUPPORTED;
554 goto exit;
555 }
556 status = psa_check_rsa_key_byte_aligned( rsa );
557
558exit:
559 /* Free the content of the pk object only on error. */
560 if( status != PSA_SUCCESS )
561 {
562 mbedtls_pk_free( &pk );
563 return( status );
564 }
565
566 /* On success, store the content of the object in the RSA context. */
567 *p_rsa = rsa;
568
569 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200570}
571#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
572
Jaeden Ameroccdce902019-01-10 11:42:27 +0000573#if defined(MBEDTLS_ECP_C)
574
575/* Import a public key given as the uncompressed representation defined by SEC1
576 * 2.3.3 as the content of an ECPoint. */
577static psa_status_t psa_import_ec_public_key( psa_ecc_curve_t curve,
578 const uint8_t *data,
579 size_t data_length,
580 mbedtls_ecp_keypair **p_ecp )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200581{
Jaeden Ameroccdce902019-01-10 11:42:27 +0000582 psa_status_t status = PSA_ERROR_TAMPERING_DETECTED;
583 mbedtls_ecp_keypair *ecp = NULL;
584 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
585
586 *p_ecp = NULL;
587 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
588 if( ecp == NULL )
589 return( PSA_ERROR_INSUFFICIENT_MEMORY );
590 mbedtls_ecp_keypair_init( ecp );
591
592 /* Load the group. */
593 status = mbedtls_to_psa_error(
594 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
595 if( status != PSA_SUCCESS )
596 goto exit;
597 /* Load the public value. */
598 status = mbedtls_to_psa_error(
599 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
600 data, data_length ) );
601 if( status != PSA_SUCCESS )
602 goto exit;
603
604 /* Check that the point is on the curve. */
605 status = mbedtls_to_psa_error(
606 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
607 if( status != PSA_SUCCESS )
608 goto exit;
609
610 *p_ecp = ecp;
611 return( PSA_SUCCESS );
612
613exit:
614 if( ecp != NULL )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200615 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000616 mbedtls_ecp_keypair_free( ecp );
617 mbedtls_free( ecp );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200618 }
Jaeden Ameroccdce902019-01-10 11:42:27 +0000619 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200620}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000621#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200622
Gilles Peskinef76aa772018-10-29 19:24:33 +0100623#if defined(MBEDTLS_ECP_C)
624/* Import a private key given as a byte string which is the private value
625 * in big-endian order. */
626static psa_status_t psa_import_ec_private_key( psa_ecc_curve_t curve,
627 const uint8_t *data,
628 size_t data_length,
629 mbedtls_ecp_keypair **p_ecp )
630{
631 psa_status_t status = PSA_ERROR_TAMPERING_DETECTED;
632 mbedtls_ecp_keypair *ecp = NULL;
633 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
634
635 *p_ecp = NULL;
636 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
637 if( ecp == NULL )
638 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Jaeden Amero83d29392019-01-10 20:17:42 +0000639 mbedtls_ecp_keypair_init( ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100640
641 /* Load the group. */
642 status = mbedtls_to_psa_error(
643 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
644 if( status != PSA_SUCCESS )
645 goto exit;
646 /* Load the secret value. */
647 status = mbedtls_to_psa_error(
648 mbedtls_mpi_read_binary( &ecp->d, data, data_length ) );
649 if( status != PSA_SUCCESS )
650 goto exit;
651 /* Validate the private key. */
652 status = mbedtls_to_psa_error(
653 mbedtls_ecp_check_privkey( &ecp->grp, &ecp->d ) );
654 if( status != PSA_SUCCESS )
655 goto exit;
656 /* Calculate the public key from the private key. */
657 status = mbedtls_to_psa_error(
658 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
659 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
660 if( status != PSA_SUCCESS )
661 goto exit;
662
663 *p_ecp = ecp;
664 return( PSA_SUCCESS );
665
666exit:
667 if( ecp != NULL )
668 {
669 mbedtls_ecp_keypair_free( ecp );
670 mbedtls_free( ecp );
671 }
672 return( status );
673}
674#endif /* defined(MBEDTLS_ECP_C) */
675
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100676/** Import key data into a slot. `slot->type` must have been set
677 * previously. This function assumes that the slot does not contain
678 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100679psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
680 const uint8_t *data,
681 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100682{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200683 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100684
Darryl Green940d72c2018-07-13 13:18:51 +0100685 if( key_type_is_raw_bytes( slot->type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100686 {
Gilles Peskine6d912132018-03-07 16:41:37 +0100687 /* Ensure that a bytes-to-bit conversion won't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100688 if( data_length > SIZE_MAX / 8 )
689 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green940d72c2018-07-13 13:18:51 +0100690 status = prepare_raw_data_slot( slot->type,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200691 PSA_BYTES_TO_BITS( data_length ),
692 &slot->data.raw );
693 if( status != PSA_SUCCESS )
694 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200695 if( data_length != 0 )
696 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100697 }
698 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100699#if defined(MBEDTLS_ECP_C)
Darryl Green940d72c2018-07-13 13:18:51 +0100700 if( PSA_KEY_TYPE_IS_ECC_KEYPAIR( slot->type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100701 {
Darryl Green940d72c2018-07-13 13:18:51 +0100702 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100703 data, data_length,
704 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100705 }
Jaeden Ameroccdce902019-01-10 11:42:27 +0000706 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100707 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000708 status = psa_import_ec_public_key(
709 PSA_KEY_TYPE_GET_CURVE( slot->type ),
710 data, data_length,
711 &slot->data.ecp );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100712 }
713 else
Gilles Peskine969ac722018-01-28 18:16:59 +0100714#endif /* MBEDTLS_ECP_C */
Jaeden Ameroccdce902019-01-10 11:42:27 +0000715#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
716 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100717 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000718 status = psa_import_rsa_key( slot->type,
719 data, data_length,
720 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100721 }
722 else
Jaeden Ameroccdce902019-01-10 11:42:27 +0000723#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100724 {
725 return( PSA_ERROR_NOT_SUPPORTED );
726 }
Jaeden Ameroc67200d2019-01-14 13:12:39 +0000727 return( status );
Darryl Green940d72c2018-07-13 13:18:51 +0100728}
729
Darryl Green06fd18d2018-07-16 11:21:11 +0100730/* Retrieve an empty key slot (slot with no key data, but possibly
731 * with some metadata such as a policy). */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100732static psa_status_t psa_get_empty_key_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100733 psa_key_slot_t **p_slot )
Darryl Green06fd18d2018-07-16 11:21:11 +0100734{
735 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100736 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100737
738 *p_slot = NULL;
739
Gilles Peskinec5487a82018-12-03 18:08:14 +0100740 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100741 if( status != PSA_SUCCESS )
742 return( status );
743
744 if( slot->type != PSA_KEY_TYPE_NONE )
745 return( PSA_ERROR_OCCUPIED_SLOT );
746
747 *p_slot = slot;
748 return( status );
749}
750
Gilles Peskinef603c712019-01-19 13:40:11 +0100751/** Calculate the intersection of two algorithm usage policies.
752 *
753 * Return 0 (which allows no operation) on incompatibility.
754 */
755static psa_algorithm_t psa_key_policy_algorithm_intersection(
756 psa_algorithm_t alg1,
757 psa_algorithm_t alg2 )
758{
759 /* Common case: the policy only allows alg. */
760 if( alg1 == alg2 )
761 return( alg1 );
762 /* If the policies are from the same hash-and-sign family, check
763 * if one is a wildcard. If so the other has the specific algorithm. */
764 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
765 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
766 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
767 {
768 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
769 return( alg2 );
770 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
771 return( alg1 );
772 }
773 /* If the policies are incompatible, allow nothing. */
774 return( 0 );
775}
776
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100777/** Test whether a policy permits an algorithm.
778 *
779 * The caller must test usage flags separately.
780 */
781static int psa_key_policy_permits( const psa_key_policy_t *policy,
782 psa_algorithm_t alg )
783{
784 /* Common case: the policy only allows alg. */
785 if( alg == policy->alg )
786 return( 1 );
787 /* If policy->alg is a hash-and-sign with a wildcard for the hash,
788 * and alg is the same hash-and-sign family with any hash,
789 * then alg is compliant with policy->alg. */
790 if( PSA_ALG_IS_HASH_AND_SIGN( alg ) &&
791 PSA_ALG_SIGN_GET_HASH( policy->alg ) == PSA_ALG_ANY_HASH )
792 {
793 return( ( policy->alg & ~PSA_ALG_HASH_MASK ) ==
794 ( alg & ~PSA_ALG_HASH_MASK ) );
795 }
796 /* If it isn't permitted, it's forbidden. */
797 return( 0 );
798}
799
Gilles Peskinef603c712019-01-19 13:40:11 +0100800/** Restrict a key policy based on a constraint.
801 *
802 * \param[in,out] policy The policy to restrict.
803 * \param[in] constraint The policy constraint to apply.
804 *
805 * \retval #PSA_SUCCESS
806 * \c *policy contains the intersection of the original value of
807 * \c *policy and \c *constraint.
808 * \retval #PSA_ERROR_INVALID_ARGUMENT
809 * \c *policy and \c *constraint are incompatible.
810 * \c *policy is unchanged.
811 */
812static psa_status_t psa_restrict_key_policy(
813 psa_key_policy_t *policy,
814 const psa_key_policy_t *constraint )
815{
816 psa_algorithm_t intersection_alg =
817 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
818 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
819 return( PSA_ERROR_INVALID_ARGUMENT );
820 policy->usage &= constraint->usage;
821 policy->alg = intersection_alg;
822 return( PSA_SUCCESS );
823}
824
Darryl Green06fd18d2018-07-16 11:21:11 +0100825/** Retrieve a slot which must contain a key. The key must have allow all the
826 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
827 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100828static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100829 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100830 psa_key_usage_t usage,
831 psa_algorithm_t alg )
832{
833 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100834 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100835
836 *p_slot = NULL;
837
Gilles Peskinec5487a82018-12-03 18:08:14 +0100838 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100839 if( status != PSA_SUCCESS )
840 return( status );
841 if( slot->type == PSA_KEY_TYPE_NONE )
842 return( PSA_ERROR_EMPTY_SLOT );
843
844 /* Enforce that usage policy for the key slot contains all the flags
845 * required by the usage parameter. There is one exception: public
846 * keys can always be exported, so we treat public key objects as
847 * if they had the export flag. */
848 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->type ) )
849 usage &= ~PSA_KEY_USAGE_EXPORT;
850 if( ( slot->policy.usage & usage ) != usage )
851 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100852
853 /* Enforce that the usage policy permits the requested algortihm. */
854 if( alg != 0 && ! psa_key_policy_permits( &slot->policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100855 return( PSA_ERROR_NOT_PERMITTED );
856
857 *p_slot = slot;
858 return( PSA_SUCCESS );
859}
Darryl Green940d72c2018-07-13 13:18:51 +0100860
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100861/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100862static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000863{
864 if( slot->type == PSA_KEY_TYPE_NONE )
865 {
866 /* No key material to clean. */
867 }
868 else if( key_type_is_raw_bytes( slot->type ) )
869 {
870 mbedtls_free( slot->data.raw.data );
871 }
872 else
873#if defined(MBEDTLS_RSA_C)
874 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
875 {
876 mbedtls_rsa_free( slot->data.rsa );
877 mbedtls_free( slot->data.rsa );
878 }
879 else
880#endif /* defined(MBEDTLS_RSA_C) */
881#if defined(MBEDTLS_ECP_C)
882 if( PSA_KEY_TYPE_IS_ECC( slot->type ) )
883 {
884 mbedtls_ecp_keypair_free( slot->data.ecp );
885 mbedtls_free( slot->data.ecp );
886 }
887 else
888#endif /* defined(MBEDTLS_ECP_C) */
889 {
890 /* Shouldn't happen: the key type is not any type that we
891 * put in. */
892 return( PSA_ERROR_TAMPERING_DETECTED );
893 }
894
895 return( PSA_SUCCESS );
896}
897
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100898/** Completely wipe a slot in memory, including its policy.
899 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100900psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100901{
902 psa_status_t status = psa_remove_key_data_from_memory( slot );
903 /* At this point, key material and other type-specific content has
904 * been wiped. Clear remaining metadata. We can call memset and not
905 * zeroize because the metadata is not particularly sensitive. */
906 memset( slot, 0, sizeof( *slot ) );
907 return( status );
908}
909
Gilles Peskinec5487a82018-12-03 18:08:14 +0100910psa_status_t psa_import_key( psa_key_handle_t handle,
Darryl Green940d72c2018-07-13 13:18:51 +0100911 psa_key_type_t type,
912 const uint8_t *data,
913 size_t data_length )
914{
Gilles Peskine2f060a82018-12-04 17:12:32 +0100915 psa_key_slot_t *slot;
Darryl Green940d72c2018-07-13 13:18:51 +0100916 psa_status_t status;
917
Gilles Peskinec5487a82018-12-03 18:08:14 +0100918 status = psa_get_empty_key_slot( handle, &slot );
Darryl Green940d72c2018-07-13 13:18:51 +0100919 if( status != PSA_SUCCESS )
920 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100921
922 slot->type = type;
Darryl Green940d72c2018-07-13 13:18:51 +0100923
924 status = psa_import_key_into_slot( slot, data, data_length );
925 if( status != PSA_SUCCESS )
926 {
927 slot->type = PSA_KEY_TYPE_NONE;
928 return( status );
929 }
930
Darryl Greend49a4992018-06-18 17:27:26 +0100931#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
932 if( slot->lifetime == PSA_KEY_LIFETIME_PERSISTENT )
933 {
934 /* Store in file location */
Gilles Peskine69f976b2018-11-30 18:46:56 +0100935 status = psa_save_persistent_key( slot->persistent_storage_id,
936 slot->type, &slot->policy, data,
Darryl Greend49a4992018-06-18 17:27:26 +0100937 data_length );
938 if( status != PSA_SUCCESS )
939 {
940 (void) psa_remove_key_data_from_memory( slot );
941 slot->type = PSA_KEY_TYPE_NONE;
942 }
943 }
944#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
945
946 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100947}
948
Gilles Peskinec5487a82018-12-03 18:08:14 +0100949psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100950{
Gilles Peskine2f060a82018-12-04 17:12:32 +0100951 psa_key_slot_t *slot;
Darryl Greend49a4992018-06-18 17:27:26 +0100952 psa_status_t status = PSA_SUCCESS;
953 psa_status_t storage_status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100954
Gilles Peskinec5487a82018-12-03 18:08:14 +0100955 status = psa_get_key_slot( handle, &slot );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100956 if( status != PSA_SUCCESS )
957 return( status );
Darryl Greend49a4992018-06-18 17:27:26 +0100958#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
959 if( slot->lifetime == PSA_KEY_LIFETIME_PERSISTENT )
960 {
Gilles Peskine69f976b2018-11-30 18:46:56 +0100961 storage_status =
962 psa_destroy_persistent_key( slot->persistent_storage_id );
Darryl Greend49a4992018-06-18 17:27:26 +0100963 }
964#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100965 status = psa_wipe_key_slot( slot );
Darryl Greend49a4992018-06-18 17:27:26 +0100966 if( status != PSA_SUCCESS )
967 return( status );
968 return( storage_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100969}
970
Gilles Peskineb870b182018-07-06 16:02:09 +0200971/* Return the size of the key in the given slot, in bits. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100972static size_t psa_get_key_bits( const psa_key_slot_t *slot )
Gilles Peskineb870b182018-07-06 16:02:09 +0200973{
974 if( key_type_is_raw_bytes( slot->type ) )
975 return( slot->data.raw.bytes * 8 );
976#if defined(MBEDTLS_RSA_C)
Gilles Peskined8008d62018-06-29 19:51:51 +0200977 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Gilles Peskineaac64a22018-11-12 18:37:42 +0100978 return( PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) ) );
Gilles Peskineb870b182018-07-06 16:02:09 +0200979#endif /* defined(MBEDTLS_RSA_C) */
980#if defined(MBEDTLS_ECP_C)
981 if( PSA_KEY_TYPE_IS_ECC( slot->type ) )
982 return( slot->data.ecp->grp.pbits );
983#endif /* defined(MBEDTLS_ECP_C) */
984 /* Shouldn't happen except on an empty slot. */
985 return( 0 );
986}
987
Gilles Peskinec5487a82018-12-03 18:08:14 +0100988psa_status_t psa_get_key_information( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +0200989 psa_key_type_t *type,
990 size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100991{
Gilles Peskine2f060a82018-12-04 17:12:32 +0100992 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200993 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100994
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100995 if( type != NULL )
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200996 *type = 0;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100997 if( bits != NULL )
998 *bits = 0;
Gilles Peskinec5487a82018-12-03 18:08:14 +0100999 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001000 if( status != PSA_SUCCESS )
1001 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001002
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001003 if( slot->type == PSA_KEY_TYPE_NONE )
1004 return( PSA_ERROR_EMPTY_SLOT );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001005 if( type != NULL )
1006 *type = slot->type;
Gilles Peskineb870b182018-07-06 16:02:09 +02001007 if( bits != NULL )
1008 *bits = psa_get_key_bits( slot );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001009 return( PSA_SUCCESS );
1010}
1011
Jaeden Ameroccdce902019-01-10 11:42:27 +00001012#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero25384a22019-01-10 10:23:21 +00001013static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1014 unsigned char *buf, size_t size )
1015{
1016 int ret;
1017 unsigned char *c;
1018 size_t len = 0;
1019
1020 c = buf + size;
1021
1022 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1023
1024 return( (int) len );
1025}
Jaeden Ameroccdce902019-01-10 11:42:27 +00001026#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero25384a22019-01-10 10:23:21 +00001027
Gilles Peskinef603c712019-01-19 13:40:11 +01001028static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1029 uint8_t *data,
1030 size_t data_size,
1031 size_t *data_length,
1032 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001033{
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001034 *data_length = 0;
1035
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001036 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001037 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001038
Gilles Peskine48c0ea12018-06-21 14:15:31 +02001039 if( key_type_is_raw_bytes( slot->type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040 {
1041 if( slot->data.raw.bytes > data_size )
1042 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine52b90182018-10-29 19:26:27 +01001043 if( data_size != 0 )
1044 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001045 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
Gilles Peskine52b90182018-10-29 19:26:27 +01001046 memset( data + slot->data.raw.bytes, 0,
1047 data_size - slot->data.raw.bytes );
1048 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001049 *data_length = slot->data.raw.bytes;
1050 return( PSA_SUCCESS );
1051 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001052#if defined(MBEDTLS_ECP_C)
1053 if( PSA_KEY_TYPE_IS_ECC_KEYPAIR( slot->type ) && !export_public_key )
1054 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001055 psa_status_t status;
1056
Gilles Peskine188c71e2018-10-29 19:26:02 +01001057 size_t bytes = PSA_BITS_TO_BYTES( psa_get_key_bits( slot ) );
1058 if( bytes > data_size )
1059 return( PSA_ERROR_BUFFER_TOO_SMALL );
1060 status = mbedtls_to_psa_error(
1061 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1062 if( status != PSA_SUCCESS )
1063 return( status );
1064 memset( data + bytes, 0, data_size - bytes );
1065 *data_length = bytes;
1066 return( PSA_SUCCESS );
1067 }
1068#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001069 else
Moran Peker17e36e12018-05-02 12:55:20 +03001070 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001071#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskined8008d62018-06-29 19:51:51 +02001072 if( PSA_KEY_TYPE_IS_RSA( slot->type ) ||
Moran Pekera998bc62018-04-16 18:16:20 +03001073 PSA_KEY_TYPE_IS_ECC( slot->type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001074 {
Moran Pekera998bc62018-04-16 18:16:20 +03001075 mbedtls_pk_context pk;
1076 int ret;
Gilles Peskined8008d62018-06-29 19:51:51 +02001077 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001078 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001079#if defined(MBEDTLS_RSA_C)
1080 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001081 pk.pk_info = &mbedtls_rsa_info;
1082 pk.pk_ctx = slot->data.rsa;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001083#else
1084 return( PSA_ERROR_NOT_SUPPORTED );
1085#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001086 }
1087 else
1088 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001089#if defined(MBEDTLS_ECP_C)
1090 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001091 pk.pk_info = &mbedtls_eckey_info;
1092 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001093#else
1094 return( PSA_ERROR_NOT_SUPPORTED );
1095#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001096 }
Moran Pekerd7326592018-05-29 16:56:39 +03001097 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->type ) )
Jaeden Amero25384a22019-01-10 10:23:21 +00001098 {
Jaeden Ameroccdce902019-01-10 11:42:27 +00001099 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001100 }
Moran Peker17e36e12018-05-02 12:55:20 +03001101 else
Jaeden Amero25384a22019-01-10 10:23:21 +00001102 {
Moran Peker17e36e12018-05-02 12:55:20 +03001103 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001104 }
Moran Peker60364322018-04-29 11:34:58 +03001105 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001106 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001107 /* If data_size is 0 then data may be NULL and then the
1108 * call to memset would have undefined behavior. */
1109 if( data_size != 0 )
1110 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001111 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001112 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001113 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1114 * Move the data to the beginning and erase remaining data
1115 * at the original location. */
1116 if( 2 * (size_t) ret <= data_size )
1117 {
1118 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001119 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001120 }
1121 else if( (size_t) ret < data_size )
1122 {
1123 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001124 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001125 }
Moran Pekera998bc62018-04-16 18:16:20 +03001126 *data_length = ret;
1127 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001128 }
1129 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001130#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001131 {
1132 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001133 it is valid for a special-purpose implementation to omit
1134 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001135 return( PSA_ERROR_NOT_SUPPORTED );
1136 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001137 }
1138}
1139
Gilles Peskinec5487a82018-12-03 18:08:14 +01001140psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001141 uint8_t *data,
1142 size_t data_size,
1143 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001144{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001145 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001146 psa_status_t status;
1147
1148 /* Set the key to empty now, so that even when there are errors, we always
1149 * set data_length to a value between 0 and data_size. On error, setting
1150 * the key to empty is a good choice because an empty key representation is
1151 * unlikely to be accepted anywhere. */
1152 *data_length = 0;
1153
1154 /* Export requires the EXPORT flag. There is an exception for public keys,
1155 * which don't require any flag, but psa_get_key_from_slot takes
1156 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001157 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001158 if( status != PSA_SUCCESS )
1159 return( status );
1160 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001161 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001162}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001163
Gilles Peskinec5487a82018-12-03 18:08:14 +01001164psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001165 uint8_t *data,
1166 size_t data_size,
1167 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001168{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001169 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001170 psa_status_t status;
1171
1172 /* Set the key to empty now, so that even when there are errors, we always
1173 * set data_length to a value between 0 and data_size. On error, setting
1174 * the key to empty is a good choice because an empty key representation is
1175 * unlikely to be accepted anywhere. */
1176 *data_length = 0;
1177
1178 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001179 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001180 if( status != PSA_SUCCESS )
1181 return( status );
1182 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001183 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001184}
1185
Darryl Green0c6575a2018-11-07 16:05:30 +00001186#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine2f060a82018-12-04 17:12:32 +01001187static psa_status_t psa_save_generated_persistent_key( psa_key_slot_t *slot,
Darryl Green0c6575a2018-11-07 16:05:30 +00001188 size_t bits )
1189{
1190 psa_status_t status;
1191 uint8_t *data;
1192 size_t key_length;
1193 size_t data_size = PSA_KEY_EXPORT_MAX_SIZE( slot->type, bits );
1194 data = mbedtls_calloc( 1, data_size );
itayzafrir910c76b2018-11-21 16:03:21 +02001195 if( data == NULL )
1196 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Darryl Green0c6575a2018-11-07 16:05:30 +00001197 /* Get key data in export format */
1198 status = psa_internal_export_key( slot, data, data_size, &key_length, 0 );
1199 if( status != PSA_SUCCESS )
1200 {
1201 slot->type = PSA_KEY_TYPE_NONE;
1202 goto exit;
1203 }
1204 /* Store in file location */
Gilles Peskine69f976b2018-11-30 18:46:56 +01001205 status = psa_save_persistent_key( slot->persistent_storage_id,
1206 slot->type, &slot->policy,
Darryl Green0c6575a2018-11-07 16:05:30 +00001207 data, key_length );
1208 if( status != PSA_SUCCESS )
1209 {
1210 slot->type = PSA_KEY_TYPE_NONE;
1211 }
1212exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01001213 mbedtls_platform_zeroize( data, key_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00001214 mbedtls_free( data );
1215 return( status );
1216}
1217#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1218
Gilles Peskinef603c712019-01-19 13:40:11 +01001219static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
1220 psa_key_handle_t target )
1221{
1222 psa_status_t status;
1223 uint8_t *buffer = NULL;
1224 size_t buffer_size = 0;
1225 size_t length;
1226
1227 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->type,
1228 psa_get_key_bits( source ) );
1229 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001230 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001231 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01001232 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1233 if( status != PSA_SUCCESS )
1234 goto exit;
1235 status = psa_import_key( target, source->type, buffer, length );
1236
1237exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001238 if( buffer_size != 0 )
1239 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001240 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01001241 return( status );
1242}
1243
1244psa_status_t psa_copy_key(psa_key_handle_t source_handle,
1245 psa_key_handle_t target_handle,
1246 const psa_key_policy_t *constraint)
1247{
1248 psa_key_slot_t *source_slot = NULL;
1249 psa_key_slot_t *target_slot = NULL;
1250 psa_key_policy_t new_policy;
1251 psa_status_t status;
1252 status = psa_get_key_from_slot( source_handle, &source_slot, 0, 0 );
1253 if( status != PSA_SUCCESS )
1254 return( status );
1255 status = psa_get_empty_key_slot( target_handle, &target_slot );
1256 if( status != PSA_SUCCESS )
1257 return( status );
1258
1259 new_policy = target_slot->policy;
1260 status = psa_restrict_key_policy( &new_policy, &source_slot->policy );
1261 if( status != PSA_SUCCESS )
1262 return( status );
1263 if( constraint != NULL )
1264 {
1265 status = psa_restrict_key_policy( &new_policy, constraint );
1266 if( status != PSA_SUCCESS )
1267 return( status );
1268 }
1269
1270 status = psa_copy_key_material( source_slot, target_handle );
1271 if( status != PSA_SUCCESS )
1272 return( status );
1273
1274 target_slot->policy = new_policy;
1275 return( PSA_SUCCESS );
1276}
1277
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001278
1279
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001280/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001281/* Message digests */
1282/****************************************************************/
1283
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001284static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001285{
1286 switch( alg )
1287 {
1288#if defined(MBEDTLS_MD2_C)
1289 case PSA_ALG_MD2:
1290 return( &mbedtls_md2_info );
1291#endif
1292#if defined(MBEDTLS_MD4_C)
1293 case PSA_ALG_MD4:
1294 return( &mbedtls_md4_info );
1295#endif
1296#if defined(MBEDTLS_MD5_C)
1297 case PSA_ALG_MD5:
1298 return( &mbedtls_md5_info );
1299#endif
1300#if defined(MBEDTLS_RIPEMD160_C)
1301 case PSA_ALG_RIPEMD160:
1302 return( &mbedtls_ripemd160_info );
1303#endif
1304#if defined(MBEDTLS_SHA1_C)
1305 case PSA_ALG_SHA_1:
1306 return( &mbedtls_sha1_info );
1307#endif
1308#if defined(MBEDTLS_SHA256_C)
1309 case PSA_ALG_SHA_224:
1310 return( &mbedtls_sha224_info );
1311 case PSA_ALG_SHA_256:
1312 return( &mbedtls_sha256_info );
1313#endif
1314#if defined(MBEDTLS_SHA512_C)
1315 case PSA_ALG_SHA_384:
1316 return( &mbedtls_sha384_info );
1317 case PSA_ALG_SHA_512:
1318 return( &mbedtls_sha512_info );
1319#endif
1320 default:
1321 return( NULL );
1322 }
1323}
1324
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001325psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
1326{
1327 switch( operation->alg )
1328 {
Gilles Peskine81736312018-06-26 15:04:31 +02001329 case 0:
1330 /* The object has (apparently) been initialized but it is not
1331 * in use. It's ok to call abort on such an object, and there's
1332 * nothing to do. */
1333 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001334#if defined(MBEDTLS_MD2_C)
1335 case PSA_ALG_MD2:
1336 mbedtls_md2_free( &operation->ctx.md2 );
1337 break;
1338#endif
1339#if defined(MBEDTLS_MD4_C)
1340 case PSA_ALG_MD4:
1341 mbedtls_md4_free( &operation->ctx.md4 );
1342 break;
1343#endif
1344#if defined(MBEDTLS_MD5_C)
1345 case PSA_ALG_MD5:
1346 mbedtls_md5_free( &operation->ctx.md5 );
1347 break;
1348#endif
1349#if defined(MBEDTLS_RIPEMD160_C)
1350 case PSA_ALG_RIPEMD160:
1351 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
1352 break;
1353#endif
1354#if defined(MBEDTLS_SHA1_C)
1355 case PSA_ALG_SHA_1:
1356 mbedtls_sha1_free( &operation->ctx.sha1 );
1357 break;
1358#endif
1359#if defined(MBEDTLS_SHA256_C)
1360 case PSA_ALG_SHA_224:
1361 case PSA_ALG_SHA_256:
1362 mbedtls_sha256_free( &operation->ctx.sha256 );
1363 break;
1364#endif
1365#if defined(MBEDTLS_SHA512_C)
1366 case PSA_ALG_SHA_384:
1367 case PSA_ALG_SHA_512:
1368 mbedtls_sha512_free( &operation->ctx.sha512 );
1369 break;
1370#endif
1371 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02001372 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001373 }
1374 operation->alg = 0;
1375 return( PSA_SUCCESS );
1376}
1377
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02001378psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001379 psa_algorithm_t alg )
1380{
1381 int ret;
1382 operation->alg = 0;
1383 switch( alg )
1384 {
1385#if defined(MBEDTLS_MD2_C)
1386 case PSA_ALG_MD2:
1387 mbedtls_md2_init( &operation->ctx.md2 );
1388 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
1389 break;
1390#endif
1391#if defined(MBEDTLS_MD4_C)
1392 case PSA_ALG_MD4:
1393 mbedtls_md4_init( &operation->ctx.md4 );
1394 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
1395 break;
1396#endif
1397#if defined(MBEDTLS_MD5_C)
1398 case PSA_ALG_MD5:
1399 mbedtls_md5_init( &operation->ctx.md5 );
1400 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
1401 break;
1402#endif
1403#if defined(MBEDTLS_RIPEMD160_C)
1404 case PSA_ALG_RIPEMD160:
1405 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
1406 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
1407 break;
1408#endif
1409#if defined(MBEDTLS_SHA1_C)
1410 case PSA_ALG_SHA_1:
1411 mbedtls_sha1_init( &operation->ctx.sha1 );
1412 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
1413 break;
1414#endif
1415#if defined(MBEDTLS_SHA256_C)
1416 case PSA_ALG_SHA_224:
1417 mbedtls_sha256_init( &operation->ctx.sha256 );
1418 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
1419 break;
1420 case PSA_ALG_SHA_256:
1421 mbedtls_sha256_init( &operation->ctx.sha256 );
1422 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
1423 break;
1424#endif
1425#if defined(MBEDTLS_SHA512_C)
1426 case PSA_ALG_SHA_384:
1427 mbedtls_sha512_init( &operation->ctx.sha512 );
1428 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
1429 break;
1430 case PSA_ALG_SHA_512:
1431 mbedtls_sha512_init( &operation->ctx.sha512 );
1432 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
1433 break;
1434#endif
1435 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02001436 return( PSA_ALG_IS_HASH( alg ) ?
1437 PSA_ERROR_NOT_SUPPORTED :
1438 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001439 }
1440 if( ret == 0 )
1441 operation->alg = alg;
1442 else
1443 psa_hash_abort( operation );
1444 return( mbedtls_to_psa_error( ret ) );
1445}
1446
1447psa_status_t psa_hash_update( psa_hash_operation_t *operation,
1448 const uint8_t *input,
1449 size_t input_length )
1450{
1451 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02001452
1453 /* Don't require hash implementations to behave correctly on a
1454 * zero-length input, which may have an invalid pointer. */
1455 if( input_length == 0 )
1456 return( PSA_SUCCESS );
1457
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001458 switch( operation->alg )
1459 {
1460#if defined(MBEDTLS_MD2_C)
1461 case PSA_ALG_MD2:
1462 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
1463 input, input_length );
1464 break;
1465#endif
1466#if defined(MBEDTLS_MD4_C)
1467 case PSA_ALG_MD4:
1468 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
1469 input, input_length );
1470 break;
1471#endif
1472#if defined(MBEDTLS_MD5_C)
1473 case PSA_ALG_MD5:
1474 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
1475 input, input_length );
1476 break;
1477#endif
1478#if defined(MBEDTLS_RIPEMD160_C)
1479 case PSA_ALG_RIPEMD160:
1480 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
1481 input, input_length );
1482 break;
1483#endif
1484#if defined(MBEDTLS_SHA1_C)
1485 case PSA_ALG_SHA_1:
1486 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
1487 input, input_length );
1488 break;
1489#endif
1490#if defined(MBEDTLS_SHA256_C)
1491 case PSA_ALG_SHA_224:
1492 case PSA_ALG_SHA_256:
1493 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
1494 input, input_length );
1495 break;
1496#endif
1497#if defined(MBEDTLS_SHA512_C)
1498 case PSA_ALG_SHA_384:
1499 case PSA_ALG_SHA_512:
1500 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
1501 input, input_length );
1502 break;
1503#endif
1504 default:
1505 ret = MBEDTLS_ERR_MD_BAD_INPUT_DATA;
1506 break;
1507 }
Gilles Peskine94e44542018-07-12 16:58:43 +02001508
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001509 if( ret != 0 )
1510 psa_hash_abort( operation );
1511 return( mbedtls_to_psa_error( ret ) );
1512}
1513
1514psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
1515 uint8_t *hash,
1516 size_t hash_size,
1517 size_t *hash_length )
1518{
itayzafrir40835d42018-08-02 13:14:17 +03001519 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001520 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02001521 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001522
1523 /* Fill the output buffer with something that isn't a valid hash
1524 * (barring an attack on the hash and deliberately-crafted input),
1525 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02001526 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001527 /* If hash_size is 0 then hash may be NULL and then the
1528 * call to memset would have undefined behavior. */
1529 if( hash_size != 0 )
1530 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001531
1532 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03001533 {
1534 status = PSA_ERROR_BUFFER_TOO_SMALL;
1535 goto exit;
1536 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001537
1538 switch( operation->alg )
1539 {
1540#if defined(MBEDTLS_MD2_C)
1541 case PSA_ALG_MD2:
1542 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
1543 break;
1544#endif
1545#if defined(MBEDTLS_MD4_C)
1546 case PSA_ALG_MD4:
1547 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
1548 break;
1549#endif
1550#if defined(MBEDTLS_MD5_C)
1551 case PSA_ALG_MD5:
1552 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
1553 break;
1554#endif
1555#if defined(MBEDTLS_RIPEMD160_C)
1556 case PSA_ALG_RIPEMD160:
1557 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
1558 break;
1559#endif
1560#if defined(MBEDTLS_SHA1_C)
1561 case PSA_ALG_SHA_1:
1562 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
1563 break;
1564#endif
1565#if defined(MBEDTLS_SHA256_C)
1566 case PSA_ALG_SHA_224:
1567 case PSA_ALG_SHA_256:
1568 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
1569 break;
1570#endif
1571#if defined(MBEDTLS_SHA512_C)
1572 case PSA_ALG_SHA_384:
1573 case PSA_ALG_SHA_512:
1574 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
1575 break;
1576#endif
1577 default:
1578 ret = MBEDTLS_ERR_MD_BAD_INPUT_DATA;
1579 break;
1580 }
itayzafrir40835d42018-08-02 13:14:17 +03001581 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001582
itayzafrir40835d42018-08-02 13:14:17 +03001583exit:
1584 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001585 {
Gilles Peskineaee13332018-07-02 12:15:28 +02001586 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001587 return( psa_hash_abort( operation ) );
1588 }
1589 else
1590 {
1591 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03001592 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001593 }
1594}
1595
Gilles Peskine2d277862018-06-18 15:41:12 +02001596psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
1597 const uint8_t *hash,
1598 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001599{
1600 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
1601 size_t actual_hash_length;
1602 psa_status_t status = psa_hash_finish( operation,
1603 actual_hash, sizeof( actual_hash ),
1604 &actual_hash_length );
1605 if( status != PSA_SUCCESS )
1606 return( status );
1607 if( actual_hash_length != hash_length )
1608 return( PSA_ERROR_INVALID_SIGNATURE );
1609 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
1610 return( PSA_ERROR_INVALID_SIGNATURE );
1611 return( PSA_SUCCESS );
1612}
1613
Gilles Peskineeb35d782019-01-22 17:56:16 +01001614psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
1615 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01001616{
1617 if( target_operation->alg != 0 )
1618 return( PSA_ERROR_BAD_STATE );
1619
1620 switch( source_operation->alg )
1621 {
1622 case 0:
1623 return( PSA_ERROR_BAD_STATE );
1624#if defined(MBEDTLS_MD2_C)
1625 case PSA_ALG_MD2:
1626 mbedtls_md2_clone( &target_operation->ctx.md2,
1627 &source_operation->ctx.md2 );
1628 break;
1629#endif
1630#if defined(MBEDTLS_MD4_C)
1631 case PSA_ALG_MD4:
1632 mbedtls_md4_clone( &target_operation->ctx.md4,
1633 &source_operation->ctx.md4 );
1634 break;
1635#endif
1636#if defined(MBEDTLS_MD5_C)
1637 case PSA_ALG_MD5:
1638 mbedtls_md5_clone( &target_operation->ctx.md5,
1639 &source_operation->ctx.md5 );
1640 break;
1641#endif
1642#if defined(MBEDTLS_RIPEMD160_C)
1643 case PSA_ALG_RIPEMD160:
1644 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
1645 &source_operation->ctx.ripemd160 );
1646 break;
1647#endif
1648#if defined(MBEDTLS_SHA1_C)
1649 case PSA_ALG_SHA_1:
1650 mbedtls_sha1_clone( &target_operation->ctx.sha1,
1651 &source_operation->ctx.sha1 );
1652 break;
1653#endif
1654#if defined(MBEDTLS_SHA256_C)
1655 case PSA_ALG_SHA_224:
1656 case PSA_ALG_SHA_256:
1657 mbedtls_sha256_clone( &target_operation->ctx.sha256,
1658 &source_operation->ctx.sha256 );
1659 break;
1660#endif
1661#if defined(MBEDTLS_SHA512_C)
1662 case PSA_ALG_SHA_384:
1663 case PSA_ALG_SHA_512:
1664 mbedtls_sha512_clone( &target_operation->ctx.sha512,
1665 &source_operation->ctx.sha512 );
1666 break;
1667#endif
1668 default:
1669 return( PSA_ERROR_NOT_SUPPORTED );
1670 }
1671
1672 target_operation->alg = source_operation->alg;
1673 return( PSA_SUCCESS );
1674}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001675
1676
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001677/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01001678/* MAC */
1679/****************************************************************/
1680
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001681static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01001682 psa_algorithm_t alg,
1683 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02001684 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03001685 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01001686{
Gilles Peskine8c9def32018-02-08 10:02:12 +01001687 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03001688 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001689
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02001690 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02001691 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02001692
Gilles Peskine8c9def32018-02-08 10:02:12 +01001693 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
1694 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03001695 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01001696 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02001697 case PSA_ALG_ARC4:
Gilles Peskine8c9def32018-02-08 10:02:12 +01001698 mode = MBEDTLS_MODE_STREAM;
1699 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001700 case PSA_ALG_CTR:
1701 mode = MBEDTLS_MODE_CTR;
1702 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02001703 case PSA_ALG_CFB:
1704 mode = MBEDTLS_MODE_CFB;
1705 break;
1706 case PSA_ALG_OFB:
1707 mode = MBEDTLS_MODE_OFB;
1708 break;
1709 case PSA_ALG_CBC_NO_PADDING:
1710 mode = MBEDTLS_MODE_CBC;
1711 break;
1712 case PSA_ALG_CBC_PKCS7:
1713 mode = MBEDTLS_MODE_CBC;
1714 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02001715 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01001716 mode = MBEDTLS_MODE_CCM;
1717 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02001718 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01001719 mode = MBEDTLS_MODE_GCM;
1720 break;
1721 default:
1722 return( NULL );
1723 }
1724 }
1725 else if( alg == PSA_ALG_CMAC )
1726 mode = MBEDTLS_MODE_ECB;
1727 else if( alg == PSA_ALG_GMAC )
1728 mode = MBEDTLS_MODE_GCM;
1729 else
1730 return( NULL );
1731
1732 switch( key_type )
1733 {
1734 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03001735 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001736 break;
1737 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02001738 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
1739 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01001740 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03001741 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001742 else
mohammad1603f4f0d612018-06-03 15:04:51 +03001743 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02001744 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
1745 * but two-key Triple-DES is functionally three-key Triple-DES
1746 * with K1=K3, so that's how we present it to mbedtls. */
1747 if( key_bits == 128 )
1748 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001749 break;
1750 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03001751 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001752 break;
1753 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03001754 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001755 break;
1756 default:
1757 return( NULL );
1758 }
mohammad1603f4f0d612018-06-03 15:04:51 +03001759 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03001760 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001761
Jaeden Amero23bbb752018-06-26 14:16:54 +01001762 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
1763 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01001764}
1765
Gilles Peskinea05219c2018-11-16 16:02:56 +01001766#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001767static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03001768{
Gilles Peskine2d277862018-06-18 15:41:12 +02001769 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03001770 {
1771 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001772 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001773 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001774 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001775 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001776 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001777 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001778 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001779 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001780 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001781 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001782 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001783 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001784 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001785 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03001786 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001787 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02001788 return( 128 );
1789 default:
1790 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03001791 }
1792}
Gilles Peskinea05219c2018-11-16 16:02:56 +01001793#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03001794
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001795/* Initialize the MAC operation structure. Once this function has been
1796 * called, psa_mac_abort can run and will do the right thing. */
1797static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
1798 psa_algorithm_t alg )
1799{
1800 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
1801
1802 operation->alg = alg;
1803 operation->key_set = 0;
1804 operation->iv_set = 0;
1805 operation->iv_required = 0;
1806 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02001807 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001808
1809#if defined(MBEDTLS_CMAC_C)
1810 if( alg == PSA_ALG_CMAC )
1811 {
1812 operation->iv_required = 0;
1813 mbedtls_cipher_init( &operation->ctx.cmac );
1814 status = PSA_SUCCESS;
1815 }
1816 else
1817#endif /* MBEDTLS_CMAC_C */
1818#if defined(MBEDTLS_MD_C)
1819 if( PSA_ALG_IS_HMAC( operation->alg ) )
1820 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02001821 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
1822 operation->ctx.hmac.hash_ctx.alg = 0;
1823 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001824 }
1825 else
1826#endif /* MBEDTLS_MD_C */
1827 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02001828 if( ! PSA_ALG_IS_MAC( alg ) )
1829 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001830 }
1831
1832 if( status != PSA_SUCCESS )
1833 memset( operation, 0, sizeof( *operation ) );
1834 return( status );
1835}
1836
Gilles Peskine01126fa2018-07-12 17:04:55 +02001837#if defined(MBEDTLS_MD_C)
1838static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
1839{
Gilles Peskine3f108122018-12-07 18:14:53 +01001840 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02001841 return( psa_hash_abort( &hmac->hash_ctx ) );
1842}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01001843
1844static void psa_hmac_init_internal( psa_hmac_internal_data *hmac )
1845{
1846 /* Instances of psa_hash_operation_s can be initialized by zeroization. */
1847 memset( hmac, 0, sizeof( *hmac ) );
1848}
Gilles Peskine01126fa2018-07-12 17:04:55 +02001849#endif /* MBEDTLS_MD_C */
1850
Gilles Peskine8c9def32018-02-08 10:02:12 +01001851psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
1852{
Gilles Peskinefbfac682018-07-08 20:51:54 +02001853 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01001854 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02001855 /* The object has (apparently) been initialized but it is not
1856 * in use. It's ok to call abort on such an object, and there's
1857 * nothing to do. */
1858 return( PSA_SUCCESS );
1859 }
1860 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01001861#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02001862 if( operation->alg == PSA_ALG_CMAC )
1863 {
1864 mbedtls_cipher_free( &operation->ctx.cmac );
1865 }
1866 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01001867#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01001868#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02001869 if( PSA_ALG_IS_HMAC( operation->alg ) )
1870 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02001871 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02001872 }
1873 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01001874#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02001875 {
1876 /* Sanity check (shouldn't happen: operation->alg should
1877 * always have been initialized to a valid value). */
1878 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001879 }
Moran Peker41deec42018-04-04 15:43:05 +03001880
Gilles Peskine8c9def32018-02-08 10:02:12 +01001881 operation->alg = 0;
1882 operation->key_set = 0;
1883 operation->iv_set = 0;
1884 operation->iv_required = 0;
1885 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02001886 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03001887
Gilles Peskine8c9def32018-02-08 10:02:12 +01001888 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02001889
1890bad_state:
1891 /* If abort is called on an uninitialized object, we can't trust
1892 * anything. Wipe the object in case it contains confidential data.
1893 * This may result in a memory leak if a pointer gets overwritten,
1894 * but it's too late to do anything about this. */
1895 memset( operation, 0, sizeof( *operation ) );
1896 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01001897}
1898
Gilles Peskinee3b07d82018-06-19 11:57:35 +02001899#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02001900static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001901 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001902 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001903 const mbedtls_cipher_info_t *cipher_info )
1904{
1905 int ret;
1906
1907 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001908
1909 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
1910 if( ret != 0 )
1911 return( ret );
1912
1913 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
1914 slot->data.raw.data,
1915 key_bits );
1916 return( ret );
1917}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02001918#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001919
Gilles Peskine248051a2018-06-20 16:09:38 +02001920#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02001921static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
1922 const uint8_t *key,
1923 size_t key_length,
1924 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001925{
Gilles Peskineb3e6e5d2018-06-18 22:16:43 +02001926 unsigned char ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001927 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02001928 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02001929 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001930 psa_status_t status;
1931
Gilles Peskine9aa369e2018-07-16 00:36:29 +02001932 /* Sanity checks on block_size, to guarantee that there won't be a buffer
1933 * overflow below. This should never trigger if the hash algorithm
1934 * is implemented correctly. */
1935 /* The size checks against the ipad and opad buffers cannot be written
1936 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
1937 * because that triggers -Wlogical-op on GCC 7.3. */
1938 if( block_size > sizeof( ipad ) )
1939 return( PSA_ERROR_NOT_SUPPORTED );
1940 if( block_size > sizeof( hmac->opad ) )
1941 return( PSA_ERROR_NOT_SUPPORTED );
1942 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001943 return( PSA_ERROR_NOT_SUPPORTED );
1944
Gilles Peskined223b522018-06-11 18:12:58 +02001945 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001946 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02001947 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001948 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02001949 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02001950 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001951 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02001952 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02001953 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02001954 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001955 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02001956 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001957 }
Gilles Peskine96889972018-07-12 17:07:03 +02001958 /* A 0-length key is not commonly used in HMAC when used as a MAC,
1959 * but it is permitted. It is common when HMAC is used in HKDF, for
1960 * example. Don't call `memcpy` in the 0-length because `key` could be
1961 * an invalid pointer which would make the behavior undefined. */
1962 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02001963 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001964
Gilles Peskined223b522018-06-11 18:12:58 +02001965 /* ipad contains the key followed by garbage. Xor and fill with 0x36
1966 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001967 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02001968 ipad[i] ^= 0x36;
1969 memset( ipad + key_length, 0x36, block_size - key_length );
1970
1971 /* Copy the key material from ipad to opad, flipping the requisite bits,
1972 * and filling the rest of opad with the requisite constant. */
1973 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02001974 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
1975 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001976
Gilles Peskine01126fa2018-07-12 17:04:55 +02001977 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001978 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02001979 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001980
Gilles Peskine01126fa2018-07-12 17:04:55 +02001981 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02001982
1983cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01001984 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02001985
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001986 return( status );
1987}
Gilles Peskine248051a2018-06-20 16:09:38 +02001988#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02001989
Gilles Peskine89167cb2018-07-08 20:12:23 +02001990static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01001991 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02001992 psa_algorithm_t alg,
1993 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01001994{
Gilles Peskine8c9def32018-02-08 10:02:12 +01001995 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001996 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001997 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02001998 psa_key_usage_t usage =
1999 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskined911eb72018-08-14 15:18:45 +02002000 unsigned char truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002001 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002002
Gilles Peskined911eb72018-08-14 15:18:45 +02002003 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002004 if( status != PSA_SUCCESS )
2005 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002006 if( is_sign )
2007 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002008
Gilles Peskinec5487a82018-12-03 18:08:14 +01002009 status = psa_get_key_from_slot( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002010 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002011 goto exit;
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002012 key_bits = psa_get_key_bits( slot );
2013
Gilles Peskine8c9def32018-02-08 10:02:12 +01002014#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002015 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002016 {
2017 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002018 mbedtls_cipher_info_from_psa( full_length_alg,
2019 slot->type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002020 int ret;
2021 if( cipher_info == NULL )
2022 {
2023 status = PSA_ERROR_NOT_SUPPORTED;
2024 goto exit;
2025 }
2026 operation->mac_size = cipher_info->block_size;
2027 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2028 status = mbedtls_to_psa_error( ret );
2029 }
2030 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002031#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002032#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002033 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002034 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002035 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002036 if( hash_alg == 0 )
2037 {
2038 status = PSA_ERROR_NOT_SUPPORTED;
2039 goto exit;
2040 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002041
2042 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2043 /* Sanity check. This shouldn't fail on a valid configuration. */
2044 if( operation->mac_size == 0 ||
2045 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2046 {
2047 status = PSA_ERROR_NOT_SUPPORTED;
2048 goto exit;
2049 }
2050
Gilles Peskine01126fa2018-07-12 17:04:55 +02002051 if( slot->type != PSA_KEY_TYPE_HMAC )
2052 {
2053 status = PSA_ERROR_INVALID_ARGUMENT;
2054 goto exit;
2055 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002056
Gilles Peskine01126fa2018-07-12 17:04:55 +02002057 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2058 slot->data.raw.data,
2059 slot->data.raw.bytes,
2060 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002061 }
2062 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002063#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002064 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002065 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002066 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002067 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002068
Gilles Peskined911eb72018-08-14 15:18:45 +02002069 if( truncated == 0 )
2070 {
2071 /* The "normal" case: untruncated algorithm. Nothing to do. */
2072 }
2073 else if( truncated < 4 )
2074 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002075 /* A very short MAC is too short for security since it can be
2076 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2077 * so we make this our minimum, even though 32 bits is still
2078 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002079 status = PSA_ERROR_NOT_SUPPORTED;
2080 }
2081 else if( truncated > operation->mac_size )
2082 {
2083 /* It's impossible to "truncate" to a larger length. */
2084 status = PSA_ERROR_INVALID_ARGUMENT;
2085 }
2086 else
2087 operation->mac_size = truncated;
2088
Gilles Peskinefbfac682018-07-08 20:51:54 +02002089exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002090 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002091 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002092 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002093 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002094 else
2095 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002096 operation->key_set = 1;
2097 }
2098 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002099}
2100
Gilles Peskine89167cb2018-07-08 20:12:23 +02002101psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002102 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002103 psa_algorithm_t alg )
2104{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002105 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002106}
2107
2108psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002109 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002110 psa_algorithm_t alg )
2111{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002112 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002113}
2114
Gilles Peskine8c9def32018-02-08 10:02:12 +01002115psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2116 const uint8_t *input,
2117 size_t input_length )
2118{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002119 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002120 if( ! operation->key_set )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002121 goto cleanup;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002122 if( operation->iv_required && ! operation->iv_set )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002123 goto cleanup;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002124 operation->has_input = 1;
2125
Gilles Peskine8c9def32018-02-08 10:02:12 +01002126#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002127 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002128 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002129 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2130 input, input_length );
2131 status = mbedtls_to_psa_error( ret );
2132 }
2133 else
2134#endif /* MBEDTLS_CMAC_C */
2135#if defined(MBEDTLS_MD_C)
2136 if( PSA_ALG_IS_HMAC( operation->alg ) )
2137 {
2138 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2139 input_length );
2140 }
2141 else
2142#endif /* MBEDTLS_MD_C */
2143 {
2144 /* This shouldn't happen if `operation` was initialized by
2145 * a setup function. */
2146 status = PSA_ERROR_BAD_STATE;
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002147 }
2148
Gilles Peskinefbfac682018-07-08 20:51:54 +02002149cleanup:
2150 if( status != PSA_SUCCESS )
2151 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002152 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002153}
2154
Gilles Peskine01126fa2018-07-12 17:04:55 +02002155#if defined(MBEDTLS_MD_C)
2156static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2157 uint8_t *mac,
2158 size_t mac_size )
2159{
2160 unsigned char tmp[MBEDTLS_MD_MAX_SIZE];
2161 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2162 size_t hash_size = 0;
2163 size_t block_size = psa_get_hash_block_size( hash_alg );
2164 psa_status_t status;
2165
Gilles Peskine01126fa2018-07-12 17:04:55 +02002166 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2167 if( status != PSA_SUCCESS )
2168 return( status );
2169 /* From here on, tmp needs to be wiped. */
2170
2171 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2172 if( status != PSA_SUCCESS )
2173 goto exit;
2174
2175 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2176 if( status != PSA_SUCCESS )
2177 goto exit;
2178
2179 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2180 if( status != PSA_SUCCESS )
2181 goto exit;
2182
Gilles Peskined911eb72018-08-14 15:18:45 +02002183 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2184 if( status != PSA_SUCCESS )
2185 goto exit;
2186
2187 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002188
2189exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002190 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002191 return( status );
2192}
2193#endif /* MBEDTLS_MD_C */
2194
mohammad16036df908f2018-04-02 08:34:15 -07002195static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002196 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002197 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002198{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002199 if( ! operation->key_set )
2200 return( PSA_ERROR_BAD_STATE );
2201 if( operation->iv_required && ! operation->iv_set )
2202 return( PSA_ERROR_BAD_STATE );
2203
Gilles Peskine8c9def32018-02-08 10:02:12 +01002204 if( mac_size < operation->mac_size )
2205 return( PSA_ERROR_BUFFER_TOO_SMALL );
2206
Gilles Peskine8c9def32018-02-08 10:02:12 +01002207#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002208 if( operation->alg == PSA_ALG_CMAC )
2209 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002210 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2211 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2212 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002213 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002214 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002215 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002216 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002217 else
2218#endif /* MBEDTLS_CMAC_C */
2219#if defined(MBEDTLS_MD_C)
2220 if( PSA_ALG_IS_HMAC( operation->alg ) )
2221 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002222 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002223 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002224 }
2225 else
2226#endif /* MBEDTLS_MD_C */
2227 {
2228 /* This shouldn't happen if `operation` was initialized by
2229 * a setup function. */
2230 return( PSA_ERROR_BAD_STATE );
2231 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002232}
2233
Gilles Peskineacd4be32018-07-08 19:56:25 +02002234psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2235 uint8_t *mac,
2236 size_t mac_size,
2237 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002238{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002239 psa_status_t status;
2240
2241 /* Fill the output buffer with something that isn't a valid mac
2242 * (barring an attack on the mac and deliberately-crafted input),
2243 * in case the caller doesn't check the return status properly. */
2244 *mac_length = mac_size;
2245 /* If mac_size is 0 then mac may be NULL and then the
2246 * call to memset would have undefined behavior. */
2247 if( mac_size != 0 )
2248 memset( mac, '!', mac_size );
2249
Gilles Peskine89167cb2018-07-08 20:12:23 +02002250 if( ! operation->is_sign )
2251 {
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002252 status = PSA_ERROR_BAD_STATE;
2253 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002254 }
mohammad16036df908f2018-04-02 08:34:15 -07002255
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002256 status = psa_mac_finish_internal( operation, mac, mac_size );
2257
2258cleanup:
2259 if( status == PSA_SUCCESS )
2260 {
2261 status = psa_mac_abort( operation );
2262 if( status == PSA_SUCCESS )
2263 *mac_length = operation->mac_size;
2264 else
2265 memset( mac, '!', mac_size );
2266 }
2267 else
2268 psa_mac_abort( operation );
2269 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002270}
2271
Gilles Peskineacd4be32018-07-08 19:56:25 +02002272psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2273 const uint8_t *mac,
2274 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002275{
Gilles Peskine828ed142018-06-18 23:25:51 +02002276 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002277 psa_status_t status;
2278
Gilles Peskine89167cb2018-07-08 20:12:23 +02002279 if( operation->is_sign )
2280 {
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002281 status = PSA_ERROR_BAD_STATE;
2282 goto cleanup;
2283 }
2284 if( operation->mac_size != mac_length )
2285 {
2286 status = PSA_ERROR_INVALID_SIGNATURE;
2287 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002288 }
mohammad16036df908f2018-04-02 08:34:15 -07002289
2290 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002291 actual_mac, sizeof( actual_mac ) );
2292
2293 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2294 status = PSA_ERROR_INVALID_SIGNATURE;
2295
2296cleanup:
2297 if( status == PSA_SUCCESS )
2298 status = psa_mac_abort( operation );
2299 else
2300 psa_mac_abort( operation );
2301
Gilles Peskine3f108122018-12-07 18:14:53 +01002302 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002303
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002304 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002305}
2306
2307
Gilles Peskine20035e32018-02-03 22:44:14 +01002308
Gilles Peskine20035e32018-02-03 22:44:14 +01002309/****************************************************************/
2310/* Asymmetric cryptography */
2311/****************************************************************/
2312
Gilles Peskine2b450e32018-06-27 15:42:46 +02002313#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002314/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002315 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002316static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
2317 size_t hash_length,
2318 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002319{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02002320 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002321 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002322 *md_alg = mbedtls_md_get_type( md_info );
2323
2324 /* The Mbed TLS RSA module uses an unsigned int for hash length
2325 * parameters. Validate that it fits so that we don't risk an
2326 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002327#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002328 if( hash_length > UINT_MAX )
2329 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002330#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002331
2332#if defined(MBEDTLS_PKCS1_V15)
2333 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
2334 * must be correct. */
2335 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
2336 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002337 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002338 if( md_info == NULL )
2339 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002340 if( mbedtls_md_get_size( md_info ) != hash_length )
2341 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002342 }
2343#endif /* MBEDTLS_PKCS1_V15 */
2344
2345#if defined(MBEDTLS_PKCS1_V21)
2346 /* PSS requires a hash internally. */
2347 if( PSA_ALG_IS_RSA_PSS( alg ) )
2348 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02002349 if( md_info == NULL )
2350 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002351 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002352#endif /* MBEDTLS_PKCS1_V21 */
2353
Gilles Peskine61b91d42018-06-08 16:09:36 +02002354 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002355}
2356
Gilles Peskine2b450e32018-06-27 15:42:46 +02002357static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
2358 psa_algorithm_t alg,
2359 const uint8_t *hash,
2360 size_t hash_length,
2361 uint8_t *signature,
2362 size_t signature_size,
2363 size_t *signature_length )
2364{
2365 psa_status_t status;
2366 int ret;
2367 mbedtls_md_type_t md_alg;
2368
2369 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
2370 if( status != PSA_SUCCESS )
2371 return( status );
2372
Gilles Peskine630a18a2018-06-29 17:49:35 +02002373 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02002374 return( PSA_ERROR_BUFFER_TOO_SMALL );
2375
2376#if defined(MBEDTLS_PKCS1_V15)
2377 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
2378 {
2379 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
2380 MBEDTLS_MD_NONE );
2381 ret = mbedtls_rsa_pkcs1_sign( rsa,
2382 mbedtls_ctr_drbg_random,
2383 &global_data.ctr_drbg,
2384 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002385 md_alg,
2386 (unsigned int) hash_length,
2387 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002388 signature );
2389 }
2390 else
2391#endif /* MBEDTLS_PKCS1_V15 */
2392#if defined(MBEDTLS_PKCS1_V21)
2393 if( PSA_ALG_IS_RSA_PSS( alg ) )
2394 {
2395 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2396 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
2397 mbedtls_ctr_drbg_random,
2398 &global_data.ctr_drbg,
2399 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002400 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002401 (unsigned int) hash_length,
2402 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002403 signature );
2404 }
2405 else
2406#endif /* MBEDTLS_PKCS1_V21 */
2407 {
2408 return( PSA_ERROR_INVALID_ARGUMENT );
2409 }
2410
2411 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02002412 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02002413 return( mbedtls_to_psa_error( ret ) );
2414}
2415
2416static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
2417 psa_algorithm_t alg,
2418 const uint8_t *hash,
2419 size_t hash_length,
2420 const uint8_t *signature,
2421 size_t signature_length )
2422{
2423 psa_status_t status;
2424 int ret;
2425 mbedtls_md_type_t md_alg;
2426
2427 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
2428 if( status != PSA_SUCCESS )
2429 return( status );
2430
Gilles Peskine630a18a2018-06-29 17:49:35 +02002431 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02002432 return( PSA_ERROR_BUFFER_TOO_SMALL );
2433
2434#if defined(MBEDTLS_PKCS1_V15)
2435 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
2436 {
2437 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
2438 MBEDTLS_MD_NONE );
2439 ret = mbedtls_rsa_pkcs1_verify( rsa,
2440 mbedtls_ctr_drbg_random,
2441 &global_data.ctr_drbg,
2442 MBEDTLS_RSA_PUBLIC,
2443 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002444 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002445 hash,
2446 signature );
2447 }
2448 else
2449#endif /* MBEDTLS_PKCS1_V15 */
2450#if defined(MBEDTLS_PKCS1_V21)
2451 if( PSA_ALG_IS_RSA_PSS( alg ) )
2452 {
2453 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2454 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
2455 mbedtls_ctr_drbg_random,
2456 &global_data.ctr_drbg,
2457 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002458 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002459 (unsigned int) hash_length,
2460 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002461 signature );
2462 }
2463 else
2464#endif /* MBEDTLS_PKCS1_V21 */
2465 {
2466 return( PSA_ERROR_INVALID_ARGUMENT );
2467 }
Gilles Peskineef12c632018-09-13 20:37:48 +02002468
2469 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
2470 * the rest of the signature is invalid". This has little use in
2471 * practice and PSA doesn't report this distinction. */
2472 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
2473 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02002474 return( mbedtls_to_psa_error( ret ) );
2475}
2476#endif /* MBEDTLS_RSA_C */
2477
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002478#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002479/* `ecp` cannot be const because `ecp->grp` needs to be non-const
2480 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
2481 * (even though these functions don't modify it). */
2482static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
2483 psa_algorithm_t alg,
2484 const uint8_t *hash,
2485 size_t hash_length,
2486 uint8_t *signature,
2487 size_t signature_size,
2488 size_t *signature_length )
2489{
2490 int ret;
2491 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002492 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002493 mbedtls_mpi_init( &r );
2494 mbedtls_mpi_init( &s );
2495
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002496 if( signature_size < 2 * curve_bytes )
2497 {
2498 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
2499 goto cleanup;
2500 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002501
Gilles Peskinea05219c2018-11-16 16:02:56 +01002502#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002503 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
2504 {
2505 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
2506 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2507 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
2508 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det( &ecp->grp, &r, &s, &ecp->d,
2509 hash, hash_length,
2510 md_alg ) );
2511 }
2512 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01002513#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002514 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01002515 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002516 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
2517 hash, hash_length,
2518 mbedtls_ctr_drbg_random,
2519 &global_data.ctr_drbg ) );
2520 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002521
2522 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
2523 signature,
2524 curve_bytes ) );
2525 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
2526 signature + curve_bytes,
2527 curve_bytes ) );
2528
2529cleanup:
2530 mbedtls_mpi_free( &r );
2531 mbedtls_mpi_free( &s );
2532 if( ret == 0 )
2533 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002534 return( mbedtls_to_psa_error( ret ) );
2535}
2536
2537static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
2538 const uint8_t *hash,
2539 size_t hash_length,
2540 const uint8_t *signature,
2541 size_t signature_length )
2542{
2543 int ret;
2544 mbedtls_mpi r, s;
2545 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
2546 mbedtls_mpi_init( &r );
2547 mbedtls_mpi_init( &s );
2548
2549 if( signature_length != 2 * curve_bytes )
2550 return( PSA_ERROR_INVALID_SIGNATURE );
2551
2552 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
2553 signature,
2554 curve_bytes ) );
2555 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
2556 signature + curve_bytes,
2557 curve_bytes ) );
2558
2559 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
2560 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002561
2562cleanup:
2563 mbedtls_mpi_free( &r );
2564 mbedtls_mpi_free( &s );
2565 return( mbedtls_to_psa_error( ret ) );
2566}
2567#endif /* MBEDTLS_ECDSA_C */
2568
Gilles Peskinec5487a82018-12-03 18:08:14 +01002569psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002570 psa_algorithm_t alg,
2571 const uint8_t *hash,
2572 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002573 uint8_t *signature,
2574 size_t signature_size,
2575 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002576{
Gilles Peskine2f060a82018-12-04 17:12:32 +01002577 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002578 psa_status_t status;
2579
2580 *signature_length = signature_size;
2581
Gilles Peskinec5487a82018-12-03 18:08:14 +01002582 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002583 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002584 goto exit;
Gilles Peskine20035e32018-02-03 22:44:14 +01002585 if( ! PSA_KEY_TYPE_IS_KEYPAIR( slot->type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002586 {
2587 status = PSA_ERROR_INVALID_ARGUMENT;
2588 goto exit;
2589 }
Gilles Peskine20035e32018-02-03 22:44:14 +01002590
Gilles Peskine20035e32018-02-03 22:44:14 +01002591#if defined(MBEDTLS_RSA_C)
2592 if( slot->type == PSA_KEY_TYPE_RSA_KEYPAIR )
2593 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002594 status = psa_rsa_sign( slot->data.rsa,
2595 alg,
2596 hash, hash_length,
2597 signature, signature_size,
2598 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01002599 }
2600 else
2601#endif /* defined(MBEDTLS_RSA_C) */
2602#if defined(MBEDTLS_ECP_C)
2603 if( PSA_KEY_TYPE_IS_ECC( slot->type ) )
2604 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002605#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01002606 if(
2607#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
2608 PSA_ALG_IS_ECDSA( alg )
2609#else
2610 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
2611#endif
2612 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002613 status = psa_ecdsa_sign( slot->data.ecp,
2614 alg,
2615 hash, hash_length,
2616 signature, signature_size,
2617 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002618 else
2619#endif /* defined(MBEDTLS_ECDSA_C) */
2620 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002621 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002622 }
itayzafrir5c753392018-05-08 11:18:38 +03002623 }
2624 else
2625#endif /* defined(MBEDTLS_ECP_C) */
2626 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002627 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01002628 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002629
2630exit:
2631 /* Fill the unused part of the output buffer (the whole buffer on error,
2632 * the trailing part on success) with something that isn't a valid mac
2633 * (barring an attack on the mac and deliberately-crafted input),
2634 * in case the caller doesn't check the return status properly. */
2635 if( status == PSA_SUCCESS )
2636 memset( signature + *signature_length, '!',
2637 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002638 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002639 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002640 /* If signature_size is 0 then we have nothing to do. We must not call
2641 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002642 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03002643}
2644
Gilles Peskinec5487a82018-12-03 18:08:14 +01002645psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03002646 psa_algorithm_t alg,
2647 const uint8_t *hash,
2648 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02002649 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02002650 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002651{
Gilles Peskine2f060a82018-12-04 17:12:32 +01002652 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002653 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02002654
Gilles Peskinec5487a82018-12-03 18:08:14 +01002655 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002656 if( status != PSA_SUCCESS )
2657 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03002658
Gilles Peskine61b91d42018-06-08 16:09:36 +02002659#if defined(MBEDTLS_RSA_C)
Gilles Peskined8008d62018-06-29 19:51:51 +02002660 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002661 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02002662 return( psa_rsa_verify( slot->data.rsa,
2663 alg,
2664 hash, hash_length,
2665 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002666 }
2667 else
2668#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03002669#if defined(MBEDTLS_ECP_C)
2670 if( PSA_KEY_TYPE_IS_ECC( slot->type ) )
2671 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002672#if defined(MBEDTLS_ECDSA_C)
2673 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002674 return( psa_ecdsa_verify( slot->data.ecp,
2675 hash, hash_length,
2676 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002677 else
2678#endif /* defined(MBEDTLS_ECDSA_C) */
2679 {
2680 return( PSA_ERROR_INVALID_ARGUMENT );
2681 }
itayzafrir5c753392018-05-08 11:18:38 +03002682 }
Gilles Peskine20035e32018-02-03 22:44:14 +01002683 else
2684#endif /* defined(MBEDTLS_ECP_C) */
2685 {
2686 return( PSA_ERROR_NOT_SUPPORTED );
2687 }
2688}
2689
Gilles Peskine072ac562018-06-30 00:21:29 +02002690#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
2691static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2692 mbedtls_rsa_context *rsa )
2693{
2694 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2695 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2696 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
2697 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2698}
2699#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
2700
Gilles Peskinec5487a82018-12-03 18:08:14 +01002701psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002702 psa_algorithm_t alg,
2703 const uint8_t *input,
2704 size_t input_length,
2705 const uint8_t *salt,
2706 size_t salt_length,
2707 uint8_t *output,
2708 size_t output_size,
2709 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002710{
Gilles Peskine2f060a82018-12-04 17:12:32 +01002711 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002712 psa_status_t status;
2713
Darryl Green5cc689a2018-07-24 15:34:10 +01002714 (void) input;
2715 (void) input_length;
2716 (void) salt;
2717 (void) output;
2718 (void) output_size;
2719
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03002720 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002721
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002722 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2723 return( PSA_ERROR_INVALID_ARGUMENT );
2724
Gilles Peskinec5487a82018-12-03 18:08:14 +01002725 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002726 if( status != PSA_SUCCESS )
2727 return( status );
Gilles Peskine35da9a22018-06-29 19:17:49 +02002728 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->type ) ||
2729 PSA_KEY_TYPE_IS_KEYPAIR( slot->type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002730 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002731
2732#if defined(MBEDTLS_RSA_C)
Gilles Peskined8008d62018-06-29 19:51:51 +02002733 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002734 {
2735 mbedtls_rsa_context *rsa = slot->data.rsa;
2736 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02002737 if( output_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine61b91d42018-06-08 16:09:36 +02002738 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002739#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02002740 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002741 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02002742 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
2743 mbedtls_ctr_drbg_random,
2744 &global_data.ctr_drbg,
2745 MBEDTLS_RSA_PUBLIC,
2746 input_length,
2747 input,
2748 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002749 }
2750 else
2751#endif /* MBEDTLS_PKCS1_V15 */
2752#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02002753 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002754 {
Gilles Peskine072ac562018-06-30 00:21:29 +02002755 psa_rsa_oaep_set_padding_mode( alg, rsa );
2756 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
2757 mbedtls_ctr_drbg_random,
2758 &global_data.ctr_drbg,
2759 MBEDTLS_RSA_PUBLIC,
2760 salt, salt_length,
2761 input_length,
2762 input,
2763 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002764 }
2765 else
2766#endif /* MBEDTLS_PKCS1_V21 */
2767 {
2768 return( PSA_ERROR_INVALID_ARGUMENT );
2769 }
2770 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02002771 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002772 return( mbedtls_to_psa_error( ret ) );
2773 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002774 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02002775#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002776 {
2777 return( PSA_ERROR_NOT_SUPPORTED );
2778 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002779}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002780
Gilles Peskinec5487a82018-12-03 18:08:14 +01002781psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002782 psa_algorithm_t alg,
2783 const uint8_t *input,
2784 size_t input_length,
2785 const uint8_t *salt,
2786 size_t salt_length,
2787 uint8_t *output,
2788 size_t output_size,
2789 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002790{
Gilles Peskine2f060a82018-12-04 17:12:32 +01002791 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002792 psa_status_t status;
2793
Darryl Green5cc689a2018-07-24 15:34:10 +01002794 (void) input;
2795 (void) input_length;
2796 (void) salt;
2797 (void) output;
2798 (void) output_size;
2799
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03002800 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002801
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002802 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2803 return( PSA_ERROR_INVALID_ARGUMENT );
2804
Gilles Peskinec5487a82018-12-03 18:08:14 +01002805 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002806 if( status != PSA_SUCCESS )
2807 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002808 if( ! PSA_KEY_TYPE_IS_KEYPAIR( slot->type ) )
2809 return( PSA_ERROR_INVALID_ARGUMENT );
2810
2811#if defined(MBEDTLS_RSA_C)
2812 if( slot->type == PSA_KEY_TYPE_RSA_KEYPAIR )
2813 {
2814 mbedtls_rsa_context *rsa = slot->data.rsa;
2815 int ret;
2816
Gilles Peskine630a18a2018-06-29 17:49:35 +02002817 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002818 return( PSA_ERROR_INVALID_ARGUMENT );
2819
2820#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02002821 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002822 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02002823 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
2824 mbedtls_ctr_drbg_random,
2825 &global_data.ctr_drbg,
2826 MBEDTLS_RSA_PRIVATE,
2827 output_length,
2828 input,
2829 output,
2830 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002831 }
2832 else
2833#endif /* MBEDTLS_PKCS1_V15 */
2834#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02002835 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002836 {
Gilles Peskine072ac562018-06-30 00:21:29 +02002837 psa_rsa_oaep_set_padding_mode( alg, rsa );
2838 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
2839 mbedtls_ctr_drbg_random,
2840 &global_data.ctr_drbg,
2841 MBEDTLS_RSA_PRIVATE,
2842 salt, salt_length,
2843 output_length,
2844 input,
2845 output,
2846 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002847 }
2848 else
2849#endif /* MBEDTLS_PKCS1_V21 */
2850 {
2851 return( PSA_ERROR_INVALID_ARGUMENT );
2852 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03002853
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002854 return( mbedtls_to_psa_error( ret ) );
2855 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002856 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02002857#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002858 {
2859 return( PSA_ERROR_NOT_SUPPORTED );
2860 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002861}
Gilles Peskine20035e32018-02-03 22:44:14 +01002862
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002863
2864
mohammad1603503973b2018-03-12 15:59:30 +02002865/****************************************************************/
2866/* Symmetric cryptography */
2867/****************************************************************/
2868
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002869/* Initialize the cipher operation structure. Once this function has been
2870 * called, psa_cipher_abort can run and will do the right thing. */
2871static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
2872 psa_algorithm_t alg )
2873{
Gilles Peskinec06e0712018-06-20 16:21:04 +02002874 if( ! PSA_ALG_IS_CIPHER( alg ) )
2875 {
2876 memset( operation, 0, sizeof( *operation ) );
2877 return( PSA_ERROR_INVALID_ARGUMENT );
2878 }
2879
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002880 operation->alg = alg;
2881 operation->key_set = 0;
2882 operation->iv_set = 0;
2883 operation->iv_required = 1;
2884 operation->iv_size = 0;
2885 operation->block_size = 0;
2886 mbedtls_cipher_init( &operation->ctx.cipher );
2887 return( PSA_SUCCESS );
2888}
2889
Gilles Peskinee553c652018-06-04 16:22:46 +02002890static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002891 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02002892 psa_algorithm_t alg,
2893 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02002894{
2895 int ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
2896 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002897 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02002898 size_t key_bits;
2899 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002900 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
2901 PSA_KEY_USAGE_ENCRYPT :
2902 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02002903
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002904 status = psa_cipher_init( operation, alg );
2905 if( status != PSA_SUCCESS )
2906 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02002907
Gilles Peskinec5487a82018-12-03 18:08:14 +01002908 status = psa_get_key_from_slot( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002909 if( status != PSA_SUCCESS )
2910 return( status );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002911 key_bits = psa_get_key_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02002912
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002913 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02002914 if( cipher_info == NULL )
2915 return( PSA_ERROR_NOT_SUPPORTED );
2916
mohammad1603503973b2018-03-12 15:59:30 +02002917 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03002918 if( ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02002919 {
2920 psa_cipher_abort( operation );
2921 return( mbedtls_to_psa_error( ret ) );
2922 }
2923
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002924#if defined(MBEDTLS_DES_C)
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002925 if( slot->type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002926 {
2927 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
2928 unsigned char keys[24];
2929 memcpy( keys, slot->data.raw.data, 16 );
2930 memcpy( keys + 16, slot->data.raw.data, 8 );
2931 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
2932 keys,
2933 192, cipher_operation );
2934 }
2935 else
2936#endif
2937 {
2938 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
2939 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01002940 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002941 }
Moran Peker41deec42018-04-04 15:43:05 +03002942 if( ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02002943 {
2944 psa_cipher_abort( operation );
2945 return( mbedtls_to_psa_error( ret ) );
2946 }
2947
mohammad16038481e742018-03-18 13:57:31 +02002948#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002949 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02002950 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002951 case PSA_ALG_CBC_NO_PADDING:
2952 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
2953 MBEDTLS_PADDING_NONE );
2954 break;
2955 case PSA_ALG_CBC_PKCS7:
2956 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
2957 MBEDTLS_PADDING_PKCS7 );
2958 break;
2959 default:
2960 /* The algorithm doesn't involve padding. */
2961 ret = 0;
2962 break;
2963 }
2964 if( ret != 0 )
2965 {
2966 psa_cipher_abort( operation );
2967 return( mbedtls_to_psa_error( ret ) );
mohammad16038481e742018-03-18 13:57:31 +02002968 }
2969#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
2970
mohammad1603503973b2018-03-12 15:59:30 +02002971 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002972 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
2973 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->type ) );
2974 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02002975 {
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002976 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->type );
mohammad16038481e742018-03-18 13:57:31 +02002977 }
mohammad1603503973b2018-03-12 15:59:30 +02002978
Moran Peker395db872018-05-31 14:07:14 +03002979 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02002980}
2981
Gilles Peskinefe119512018-07-08 21:39:34 +02002982psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002983 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02002984 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02002985{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002986 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02002987}
2988
Gilles Peskinefe119512018-07-08 21:39:34 +02002989psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002990 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02002991 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02002992{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002993 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02002994}
2995
Gilles Peskinefe119512018-07-08 21:39:34 +02002996psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
2997 unsigned char *iv,
2998 size_t iv_size,
2999 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003000{
itayzafrir534bd7c2018-08-02 13:56:32 +03003001 psa_status_t status;
3002 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003003 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003004 {
3005 status = PSA_ERROR_BAD_STATE;
3006 goto exit;
3007 }
Moran Peker41deec42018-04-04 15:43:05 +03003008 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003009 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003010 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003011 goto exit;
3012 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003013 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3014 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003015 if( ret != 0 )
3016 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003017 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003018 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003019 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003020
mohammad16038481e742018-03-18 13:57:31 +02003021 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003022 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003023
Moran Peker395db872018-05-31 14:07:14 +03003024exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003025 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003026 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003027 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003028}
3029
Gilles Peskinefe119512018-07-08 21:39:34 +02003030psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
3031 const unsigned char *iv,
3032 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003033{
itayzafrir534bd7c2018-08-02 13:56:32 +03003034 psa_status_t status;
3035 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003036 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003037 {
3038 status = PSA_ERROR_BAD_STATE;
3039 goto exit;
3040 }
Moran Pekera28258c2018-05-29 16:25:04 +03003041 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003042 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003043 status = PSA_ERROR_INVALID_ARGUMENT;
3044 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003045 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003046 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3047 status = mbedtls_to_psa_error( ret );
3048exit:
3049 if( status == PSA_SUCCESS )
3050 operation->iv_set = 1;
3051 else
mohammad1603503973b2018-03-12 15:59:30 +02003052 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003053 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003054}
3055
Gilles Peskinee553c652018-06-04 16:22:46 +02003056psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3057 const uint8_t *input,
3058 size_t input_length,
3059 unsigned char *output,
3060 size_t output_size,
3061 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003062{
itayzafrir534bd7c2018-08-02 13:56:32 +03003063 psa_status_t status;
3064 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003065 size_t expected_output_size;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003066 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003067 {
3068 /* Take the unprocessed partial block left over from previous
3069 * update calls, if any, plus the input to this call. Remove
3070 * the last partial block, if any. You get the data that will be
3071 * output in this call. */
3072 expected_output_size =
3073 ( operation->ctx.cipher.unprocessed_len + input_length )
3074 / operation->block_size * operation->block_size;
3075 }
3076 else
3077 {
3078 expected_output_size = input_length;
3079 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003080
Gilles Peskine89d789c2018-06-04 17:17:16 +02003081 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003082 {
3083 status = PSA_ERROR_BUFFER_TOO_SMALL;
3084 goto exit;
3085 }
mohammad160382759612018-03-12 18:16:40 +02003086
mohammad1603503973b2018-03-12 15:59:30 +02003087 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003088 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003089 status = mbedtls_to_psa_error( ret );
3090exit:
3091 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003092 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003093 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003094}
3095
Gilles Peskinee553c652018-06-04 16:22:46 +02003096psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3097 uint8_t *output,
3098 size_t output_size,
3099 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003100{
Janos Follath315b51c2018-07-09 16:04:51 +01003101 psa_status_t status = PSA_ERROR_UNKNOWN_ERROR;
3102 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003103 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003104
mohammad1603503973b2018-03-12 15:59:30 +02003105 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003106 {
Janos Follath315b51c2018-07-09 16:04:51 +01003107 status = PSA_ERROR_BAD_STATE;
3108 goto error;
Moran Peker7cb22b82018-06-05 11:40:02 +03003109 }
3110 if( operation->iv_required && ! operation->iv_set )
3111 {
Janos Follath315b51c2018-07-09 16:04:51 +01003112 status = PSA_ERROR_BAD_STATE;
3113 goto error;
Moran Peker7cb22b82018-06-05 11:40:02 +03003114 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003115
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003116 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003117 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3118 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003119 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003120 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003121 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003122 }
3123
Janos Follath315b51c2018-07-09 16:04:51 +01003124 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3125 temp_output_buffer,
3126 output_length );
3127 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003128 {
Janos Follath315b51c2018-07-09 16:04:51 +01003129 status = mbedtls_to_psa_error( cipher_ret );
3130 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003131 }
Janos Follath315b51c2018-07-09 16:04:51 +01003132
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003133 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003134 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003135 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003136 memcpy( output, temp_output_buffer, *output_length );
3137 else
3138 {
Janos Follath315b51c2018-07-09 16:04:51 +01003139 status = PSA_ERROR_BUFFER_TOO_SMALL;
3140 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003141 }
mohammad1603503973b2018-03-12 15:59:30 +02003142
Gilles Peskine3f108122018-12-07 18:14:53 +01003143 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003144 status = psa_cipher_abort( operation );
3145
3146 return( status );
3147
3148error:
3149
3150 *output_length = 0;
3151
Gilles Peskine3f108122018-12-07 18:14:53 +01003152 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003153 (void) psa_cipher_abort( operation );
3154
3155 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003156}
3157
Gilles Peskinee553c652018-06-04 16:22:46 +02003158psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3159{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003160 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003161 {
3162 /* The object has (apparently) been initialized but it is not
3163 * in use. It's ok to call abort on such an object, and there's
3164 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003165 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003166 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003167
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003168 /* Sanity check (shouldn't happen: operation->alg should
3169 * always have been initialized to a valid value). */
3170 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3171 return( PSA_ERROR_BAD_STATE );
3172
mohammad1603503973b2018-03-12 15:59:30 +02003173 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003174
Moran Peker41deec42018-04-04 15:43:05 +03003175 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003176 operation->key_set = 0;
3177 operation->iv_set = 0;
3178 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003179 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003180 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003181
Moran Peker395db872018-05-31 14:07:14 +03003182 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003183}
3184
Gilles Peskinea0655c32018-04-30 17:06:50 +02003185
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003186
mohammad16038cc1cee2018-03-28 01:21:33 +03003187/****************************************************************/
3188/* Key Policy */
3189/****************************************************************/
Mohammad Abo Mokha5c7b7d2018-07-04 15:57:00 +03003190
mohammad160327010052018-07-03 13:16:15 +03003191#if !defined(MBEDTLS_PSA_CRYPTO_SPM)
Gilles Peskine2d277862018-06-18 15:41:12 +02003192void psa_key_policy_set_usage( psa_key_policy_t *policy,
3193 psa_key_usage_t usage,
3194 psa_algorithm_t alg )
mohammad16038cc1cee2018-03-28 01:21:33 +03003195{
mohammad16034eed7572018-03-28 05:14:59 -07003196 policy->usage = usage;
3197 policy->alg = alg;
mohammad16038cc1cee2018-03-28 01:21:33 +03003198}
3199
Gilles Peskineaa7bc472018-07-12 00:54:56 +02003200psa_key_usage_t psa_key_policy_get_usage( const psa_key_policy_t *policy )
mohammad16038cc1cee2018-03-28 01:21:33 +03003201{
mohammad16036df908f2018-04-02 08:34:15 -07003202 return( policy->usage );
mohammad16038cc1cee2018-03-28 01:21:33 +03003203}
3204
Gilles Peskineaa7bc472018-07-12 00:54:56 +02003205psa_algorithm_t psa_key_policy_get_algorithm( const psa_key_policy_t *policy )
mohammad16038cc1cee2018-03-28 01:21:33 +03003206{
mohammad16036df908f2018-04-02 08:34:15 -07003207 return( policy->alg );
mohammad16038cc1cee2018-03-28 01:21:33 +03003208}
mohammad160327010052018-07-03 13:16:15 +03003209#endif /* !defined(MBEDTLS_PSA_CRYPTO_SPM) */
Mohammad Abo Mokha5c7b7d2018-07-04 15:57:00 +03003210
Gilles Peskinec5487a82018-12-03 18:08:14 +01003211psa_status_t psa_set_key_policy( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02003212 const psa_key_policy_t *policy )
mohammad16038cc1cee2018-03-28 01:21:33 +03003213{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003214 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003215 psa_status_t status;
mohammad16038cc1cee2018-03-28 01:21:33 +03003216
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003217 if( policy == NULL )
mohammad16038cc1cee2018-03-28 01:21:33 +03003218 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003219
Gilles Peskinec5487a82018-12-03 18:08:14 +01003220 status = psa_get_empty_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003221 if( status != PSA_SUCCESS )
3222 return( status );
mohammad16038cc1cee2018-03-28 01:21:33 +03003223
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003224 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
3225 PSA_KEY_USAGE_ENCRYPT |
3226 PSA_KEY_USAGE_DECRYPT |
3227 PSA_KEY_USAGE_SIGN |
Gilles Peskineea0fb492018-07-12 17:17:20 +02003228 PSA_KEY_USAGE_VERIFY |
3229 PSA_KEY_USAGE_DERIVE ) ) != 0 )
mohammad16035feda722018-04-16 04:38:57 -07003230 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad16038cc1cee2018-03-28 01:21:33 +03003231
mohammad16036df908f2018-04-02 08:34:15 -07003232 slot->policy = *policy;
mohammad16038cc1cee2018-03-28 01:21:33 +03003233
3234 return( PSA_SUCCESS );
3235}
3236
Gilles Peskinec5487a82018-12-03 18:08:14 +01003237psa_status_t psa_get_key_policy( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02003238 psa_key_policy_t *policy )
mohammad16038cc1cee2018-03-28 01:21:33 +03003239{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003240 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003241 psa_status_t status;
mohammad16038cc1cee2018-03-28 01:21:33 +03003242
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003243 if( policy == NULL )
mohammad16038cc1cee2018-03-28 01:21:33 +03003244 return( PSA_ERROR_INVALID_ARGUMENT );
3245
Gilles Peskinec5487a82018-12-03 18:08:14 +01003246 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003247 if( status != PSA_SUCCESS )
3248 return( status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003249
mohammad16036df908f2018-04-02 08:34:15 -07003250 *policy = slot->policy;
mohammad16038cc1cee2018-03-28 01:21:33 +03003251
3252 return( PSA_SUCCESS );
3253}
Gilles Peskine20035e32018-02-03 22:44:14 +01003254
Gilles Peskinea0655c32018-04-30 17:06:50 +02003255
3256
mohammad1603804cd712018-03-20 22:44:08 +02003257/****************************************************************/
3258/* Key Lifetime */
3259/****************************************************************/
3260
Gilles Peskinec5487a82018-12-03 18:08:14 +01003261psa_status_t psa_get_key_lifetime( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02003262 psa_key_lifetime_t *lifetime )
mohammad1603804cd712018-03-20 22:44:08 +02003263{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003264 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003265 psa_status_t status;
mohammad1603804cd712018-03-20 22:44:08 +02003266
Gilles Peskinec5487a82018-12-03 18:08:14 +01003267 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003268 if( status != PSA_SUCCESS )
3269 return( status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003270
mohammad1603804cd712018-03-20 22:44:08 +02003271 *lifetime = slot->lifetime;
3272
3273 return( PSA_SUCCESS );
3274}
3275
Gilles Peskine20035e32018-02-03 22:44:14 +01003276
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003277
mohammad16035955c982018-04-26 00:53:03 +03003278/****************************************************************/
3279/* AEAD */
3280/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003281
Gilles Peskineedf9a652018-08-17 18:11:56 +02003282typedef struct
3283{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003284 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003285 const mbedtls_cipher_info_t *cipher_info;
3286 union
3287 {
3288#if defined(MBEDTLS_CCM_C)
3289 mbedtls_ccm_context ccm;
3290#endif /* MBEDTLS_CCM_C */
3291#if defined(MBEDTLS_GCM_C)
3292 mbedtls_gcm_context gcm;
3293#endif /* MBEDTLS_GCM_C */
3294 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003295 psa_algorithm_t core_alg;
3296 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003297 uint8_t tag_length;
3298} aead_operation_t;
3299
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003300static void psa_aead_abort( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003301{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003302 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003303 {
3304#if defined(MBEDTLS_CCM_C)
3305 case PSA_ALG_CCM:
3306 mbedtls_ccm_free( &operation->ctx.ccm );
3307 break;
3308#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003309#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003310 case PSA_ALG_GCM:
3311 mbedtls_gcm_free( &operation->ctx.gcm );
3312 break;
3313#endif /* MBEDTLS_GCM_C */
3314 }
3315}
3316
3317static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003318 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003319 psa_key_usage_t usage,
3320 psa_algorithm_t alg )
3321{
3322 psa_status_t status;
3323 size_t key_bits;
3324 mbedtls_cipher_id_t cipher_id;
3325
Gilles Peskinec5487a82018-12-03 18:08:14 +01003326 status = psa_get_key_from_slot( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003327 if( status != PSA_SUCCESS )
3328 return( status );
3329
3330 key_bits = psa_get_key_bits( operation->slot );
3331
3332 operation->cipher_info =
3333 mbedtls_cipher_info_from_psa( alg, operation->slot->type, key_bits,
3334 &cipher_id );
3335 if( operation->cipher_info == NULL )
3336 return( PSA_ERROR_NOT_SUPPORTED );
3337
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003338 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003339 {
3340#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003341 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
3342 operation->core_alg = PSA_ALG_CCM;
3343 operation->full_tag_length = 16;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003344 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->type ) != 16 )
3345 return( PSA_ERROR_INVALID_ARGUMENT );
3346 mbedtls_ccm_init( &operation->ctx.ccm );
3347 status = mbedtls_to_psa_error(
3348 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
3349 operation->slot->data.raw.data,
3350 (unsigned int) key_bits ) );
3351 if( status != 0 )
3352 goto cleanup;
3353 break;
3354#endif /* MBEDTLS_CCM_C */
3355
3356#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003357 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
3358 operation->core_alg = PSA_ALG_GCM;
3359 operation->full_tag_length = 16;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003360 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->type ) != 16 )
3361 return( PSA_ERROR_INVALID_ARGUMENT );
3362 mbedtls_gcm_init( &operation->ctx.gcm );
3363 status = mbedtls_to_psa_error(
3364 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
3365 operation->slot->data.raw.data,
3366 (unsigned int) key_bits ) );
3367 break;
3368#endif /* MBEDTLS_GCM_C */
3369
3370 default:
3371 return( PSA_ERROR_NOT_SUPPORTED );
3372 }
3373
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003374 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
3375 {
3376 status = PSA_ERROR_INVALID_ARGUMENT;
3377 goto cleanup;
3378 }
3379 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
3380 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3381 * GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3382 * In both cases, mbedtls_xxx will validate the tag length below. */
3383
Gilles Peskineedf9a652018-08-17 18:11:56 +02003384 return( PSA_SUCCESS );
3385
3386cleanup:
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003387 psa_aead_abort( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003388 return( status );
3389}
3390
Gilles Peskinec5487a82018-12-03 18:08:14 +01003391psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03003392 psa_algorithm_t alg,
3393 const uint8_t *nonce,
3394 size_t nonce_length,
3395 const uint8_t *additional_data,
3396 size_t additional_data_length,
3397 const uint8_t *plaintext,
3398 size_t plaintext_length,
3399 uint8_t *ciphertext,
3400 size_t ciphertext_size,
3401 size_t *ciphertext_length )
3402{
mohammad16035955c982018-04-26 00:53:03 +03003403 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003404 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03003405 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02003406
mohammad1603f08a5502018-06-03 15:05:47 +03003407 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003408
Gilles Peskinec5487a82018-12-03 18:08:14 +01003409 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003410 if( status != PSA_SUCCESS )
3411 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003412
Gilles Peskineedf9a652018-08-17 18:11:56 +02003413 /* For all currently supported modes, the tag is at the end of the
3414 * ciphertext. */
3415 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
3416 {
3417 status = PSA_ERROR_BUFFER_TOO_SMALL;
3418 goto exit;
3419 }
3420 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03003421
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003422#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003423 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03003424 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003425 status = mbedtls_to_psa_error(
3426 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
3427 MBEDTLS_GCM_ENCRYPT,
3428 plaintext_length,
3429 nonce, nonce_length,
3430 additional_data, additional_data_length,
3431 plaintext, ciphertext,
3432 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03003433 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003434 else
3435#endif /* MBEDTLS_GCM_C */
3436#if defined(MBEDTLS_CCM_C)
3437 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03003438 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003439 status = mbedtls_to_psa_error(
3440 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
3441 plaintext_length,
3442 nonce, nonce_length,
3443 additional_data,
3444 additional_data_length,
3445 plaintext, ciphertext,
3446 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03003447 }
mohammad16035c8845f2018-05-09 05:40:09 -07003448 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003449#endif /* MBEDTLS_CCM_C */
mohammad16035c8845f2018-05-09 05:40:09 -07003450 {
mohammad1603554faad2018-06-03 15:07:38 +03003451 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07003452 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003453
Gilles Peskineedf9a652018-08-17 18:11:56 +02003454 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3455 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003456
Gilles Peskineedf9a652018-08-17 18:11:56 +02003457exit:
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003458 psa_aead_abort( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003459 if( status == PSA_SUCCESS )
3460 *ciphertext_length = plaintext_length + operation.tag_length;
3461 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003462}
3463
Gilles Peskineee652a32018-06-01 19:23:52 +02003464/* Locate the tag in a ciphertext buffer containing the encrypted data
3465 * followed by the tag. Return the length of the part preceding the tag in
3466 * *plaintext_length. This is the size of the plaintext in modes where
3467 * the encrypted data has the same size as the plaintext, such as
3468 * CCM and GCM. */
3469static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
3470 const uint8_t *ciphertext,
3471 size_t ciphertext_length,
3472 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02003473 const uint8_t **p_tag )
3474{
3475 size_t payload_length;
3476 if( tag_length > ciphertext_length )
3477 return( PSA_ERROR_INVALID_ARGUMENT );
3478 payload_length = ciphertext_length - tag_length;
3479 if( payload_length > plaintext_size )
3480 return( PSA_ERROR_BUFFER_TOO_SMALL );
3481 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02003482 return( PSA_SUCCESS );
3483}
3484
Gilles Peskinec5487a82018-12-03 18:08:14 +01003485psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03003486 psa_algorithm_t alg,
3487 const uint8_t *nonce,
3488 size_t nonce_length,
3489 const uint8_t *additional_data,
3490 size_t additional_data_length,
3491 const uint8_t *ciphertext,
3492 size_t ciphertext_length,
3493 uint8_t *plaintext,
3494 size_t plaintext_size,
3495 size_t *plaintext_length )
3496{
mohammad16035955c982018-04-26 00:53:03 +03003497 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003498 aead_operation_t operation;
3499 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02003500
Gilles Peskineee652a32018-06-01 19:23:52 +02003501 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003502
Gilles Peskinec5487a82018-12-03 18:08:14 +01003503 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003504 if( status != PSA_SUCCESS )
3505 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003506
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003507#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003508 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03003509 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003510 status = psa_aead_unpadded_locate_tag( operation.tag_length,
Gilles Peskineee652a32018-06-01 19:23:52 +02003511 ciphertext, ciphertext_length,
mohammad160360a64d02018-06-03 17:20:42 +03003512 plaintext_size, &tag );
Gilles Peskineee652a32018-06-01 19:23:52 +02003513 if( status != PSA_SUCCESS )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003514 goto exit;
Gilles Peskineee652a32018-06-01 19:23:52 +02003515
Gilles Peskineedf9a652018-08-17 18:11:56 +02003516 status = mbedtls_to_psa_error(
3517 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
3518 ciphertext_length - operation.tag_length,
3519 nonce, nonce_length,
3520 additional_data,
3521 additional_data_length,
3522 tag, operation.tag_length,
3523 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03003524 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003525 else
3526#endif /* MBEDTLS_GCM_C */
3527#if defined(MBEDTLS_CCM_C)
3528 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03003529 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003530 status = psa_aead_unpadded_locate_tag( operation.tag_length,
mohammad16039375f842018-06-03 14:28:24 +03003531 ciphertext, ciphertext_length,
mohammad160360a64d02018-06-03 17:20:42 +03003532 plaintext_size, &tag );
mohammad16039375f842018-06-03 14:28:24 +03003533 if( status != PSA_SUCCESS )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003534 goto exit;
mohammad16039375f842018-06-03 14:28:24 +03003535
Gilles Peskineedf9a652018-08-17 18:11:56 +02003536 status = mbedtls_to_psa_error(
3537 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
3538 ciphertext_length - operation.tag_length,
3539 nonce, nonce_length,
3540 additional_data,
3541 additional_data_length,
3542 ciphertext, plaintext,
3543 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03003544 }
mohammad160339574652018-06-01 04:39:53 -07003545 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003546#endif /* MBEDTLS_CCM_C */
mohammad160339574652018-06-01 04:39:53 -07003547 {
mohammad1603554faad2018-06-03 15:07:38 +03003548 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07003549 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02003550
Gilles Peskineedf9a652018-08-17 18:11:56 +02003551 if( status != PSA_SUCCESS && plaintext_size != 0 )
3552 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003553
Gilles Peskineedf9a652018-08-17 18:11:56 +02003554exit:
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003555 psa_aead_abort( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003556 if( status == PSA_SUCCESS )
3557 *plaintext_length = ciphertext_length - operation.tag_length;
3558 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003559}
3560
Gilles Peskinea0655c32018-04-30 17:06:50 +02003561
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003562
Gilles Peskine20035e32018-02-03 22:44:14 +01003563/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003564/* Generators */
3565/****************************************************************/
3566
3567psa_status_t psa_generator_abort( psa_crypto_generator_t *generator )
3568{
3569 psa_status_t status = PSA_SUCCESS;
3570 if( generator->alg == 0 )
3571 {
3572 /* The object has (apparently) been initialized but it is not
3573 * in use. It's ok to call abort on such an object, and there's
3574 * nothing to do. */
3575 }
3576 else
Gilles Peskine751d9652018-09-18 12:05:44 +02003577 if( generator->alg == PSA_ALG_SELECT_RAW )
3578 {
3579 if( generator->ctx.buffer.data != NULL )
3580 {
Gilles Peskine3f108122018-12-07 18:14:53 +01003581 mbedtls_platform_zeroize( generator->ctx.buffer.data,
Gilles Peskine751d9652018-09-18 12:05:44 +02003582 generator->ctx.buffer.size );
3583 mbedtls_free( generator->ctx.buffer.data );
3584 }
3585 }
3586 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02003587#if defined(MBEDTLS_MD_C)
3588 if( PSA_ALG_IS_HKDF( generator->alg ) )
3589 {
3590 mbedtls_free( generator->ctx.hkdf.info );
3591 status = psa_hmac_abort_internal( &generator->ctx.hkdf.hmac );
3592 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00003593 else if( PSA_ALG_IS_TLS12_PRF( generator->alg ) ||
3594 /* TLS-1.2 PSK-to-MS KDF uses the same generator as TLS-1.2 PRF */
3595 PSA_ALG_IS_TLS12_PSK_TO_MS( generator->alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003596 {
3597 if( generator->ctx.tls12_prf.key != NULL )
3598 {
Gilles Peskine3f108122018-12-07 18:14:53 +01003599 mbedtls_platform_zeroize( generator->ctx.tls12_prf.key,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003600 generator->ctx.tls12_prf.key_len );
3601 mbedtls_free( generator->ctx.tls12_prf.key );
3602 }
Hanno Becker580fba12018-11-13 20:50:45 +00003603
3604 if( generator->ctx.tls12_prf.Ai_with_seed != NULL )
3605 {
Gilles Peskine3f108122018-12-07 18:14:53 +01003606 mbedtls_platform_zeroize( generator->ctx.tls12_prf.Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00003607 generator->ctx.tls12_prf.Ai_with_seed_len );
3608 mbedtls_free( generator->ctx.tls12_prf.Ai_with_seed );
3609 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003610 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003611 else
3612#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003613 {
3614 status = PSA_ERROR_BAD_STATE;
3615 }
3616 memset( generator, 0, sizeof( *generator ) );
3617 return( status );
3618}
3619
3620
3621psa_status_t psa_get_generator_capacity(const psa_crypto_generator_t *generator,
3622 size_t *capacity)
3623{
3624 *capacity = generator->capacity;
3625 return( PSA_SUCCESS );
3626}
3627
Gilles Peskinebef7f142018-07-12 17:22:21 +02003628#if defined(MBEDTLS_MD_C)
3629/* Read some bytes from an HKDF-based generator. This performs a chunk
3630 * of the expand phase of the HKDF algorithm. */
3631static psa_status_t psa_generator_hkdf_read( psa_hkdf_generator_t *hkdf,
3632 psa_algorithm_t hash_alg,
3633 uint8_t *output,
3634 size_t output_length )
3635{
3636 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
3637 psa_status_t status;
3638
3639 while( output_length != 0 )
3640 {
3641 /* Copy what remains of the current block */
3642 uint8_t n = hash_length - hkdf->offset_in_block;
3643 if( n > output_length )
3644 n = (uint8_t) output_length;
3645 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3646 output += n;
3647 output_length -= n;
3648 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003649 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003650 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003651 /* We can't be wanting more output after block 0xff, otherwise
3652 * the capacity check in psa_generator_read() would have
3653 * prevented this call. It could happen only if the generator
3654 * object was corrupted or if this function is called directly
3655 * inside the library. */
3656 if( hkdf->block_number == 0xff )
3657 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003658
3659 /* We need a new block */
3660 ++hkdf->block_number;
3661 hkdf->offset_in_block = 0;
3662 status = psa_hmac_setup_internal( &hkdf->hmac,
3663 hkdf->prk, hash_length,
3664 hash_alg );
3665 if( status != PSA_SUCCESS )
3666 return( status );
3667 if( hkdf->block_number != 1 )
3668 {
3669 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3670 hkdf->output_block,
3671 hash_length );
3672 if( status != PSA_SUCCESS )
3673 return( status );
3674 }
3675 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3676 hkdf->info,
3677 hkdf->info_length );
3678 if( status != PSA_SUCCESS )
3679 return( status );
3680 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3681 &hkdf->block_number, 1 );
3682 if( status != PSA_SUCCESS )
3683 return( status );
3684 status = psa_hmac_finish_internal( &hkdf->hmac,
3685 hkdf->output_block,
3686 sizeof( hkdf->output_block ) );
3687 if( status != PSA_SUCCESS )
3688 return( status );
3689 }
3690
3691 return( PSA_SUCCESS );
3692}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003693
3694static psa_status_t psa_generator_tls12_prf_generate_next_block(
3695 psa_tls12_prf_generator_t *tls12_prf,
3696 psa_algorithm_t alg )
3697{
3698 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
3699 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
3700 psa_hmac_internal_data hmac;
3701 psa_status_t status, cleanup_status;
3702
Hanno Becker3b339e22018-11-13 20:56:14 +00003703 unsigned char *Ai;
3704 size_t Ai_len;
3705
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003706 /* We can't be wanting more output after block 0xff, otherwise
3707 * the capacity check in psa_generator_read() would have
3708 * prevented this call. It could happen only if the generator
3709 * object was corrupted or if this function is called directly
3710 * inside the library. */
3711 if( tls12_prf->block_number == 0xff )
3712 return( PSA_ERROR_BAD_STATE );
3713
3714 /* We need a new block */
3715 ++tls12_prf->block_number;
3716 tls12_prf->offset_in_block = 0;
3717
3718 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3719 *
3720 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3721 *
3722 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3723 * HMAC_hash(secret, A(2) + seed) +
3724 * HMAC_hash(secret, A(3) + seed) + ...
3725 *
3726 * A(0) = seed
3727 * A(i) = HMAC_hash( secret, A(i-1) )
3728 *
3729 * The `psa_tls12_prf_generator` structures saves the block
3730 * `HMAC_hash(secret, A(i) + seed)` from which the output
3731 * is currently extracted as `output_block`, while
3732 * `A(i) + seed` is stored in `Ai_with_seed`.
3733 *
3734 * Generating a new block means recalculating `Ai_with_seed`
3735 * from the A(i)-part of it, and afterwards recalculating
3736 * `output_block`.
3737 *
3738 * A(0) is computed at setup time.
3739 *
3740 */
3741
3742 psa_hmac_init_internal( &hmac );
3743
3744 /* We must distinguish the calculation of A(1) from those
3745 * of A(2) and higher, because A(0)=seed has a different
3746 * length than the other A(i). */
3747 if( tls12_prf->block_number == 1 )
3748 {
Hanno Becker3b339e22018-11-13 20:56:14 +00003749 Ai = tls12_prf->Ai_with_seed + hash_length;
3750 Ai_len = tls12_prf->Ai_with_seed_len - hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003751 }
3752 else
3753 {
Hanno Becker3b339e22018-11-13 20:56:14 +00003754 Ai = tls12_prf->Ai_with_seed;
3755 Ai_len = hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003756 }
3757
Hanno Becker3b339e22018-11-13 20:56:14 +00003758 /* Compute A(i+1) = HMAC_hash(secret, A(i)) */
3759 status = psa_hmac_setup_internal( &hmac,
3760 tls12_prf->key,
3761 tls12_prf->key_len,
3762 hash_alg );
3763 if( status != PSA_SUCCESS )
3764 goto cleanup;
3765
3766 status = psa_hash_update( &hmac.hash_ctx,
3767 Ai, Ai_len );
3768 if( status != PSA_SUCCESS )
3769 goto cleanup;
3770
3771 status = psa_hmac_finish_internal( &hmac,
3772 tls12_prf->Ai_with_seed,
3773 hash_length );
3774 if( status != PSA_SUCCESS )
3775 goto cleanup;
3776
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003777 /* Compute the next block `HMAC_hash(secret, A(i+1) + seed)`. */
3778 status = psa_hmac_setup_internal( &hmac,
3779 tls12_prf->key,
3780 tls12_prf->key_len,
3781 hash_alg );
3782 if( status != PSA_SUCCESS )
3783 goto cleanup;
3784
3785 status = psa_hash_update( &hmac.hash_ctx,
3786 tls12_prf->Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00003787 tls12_prf->Ai_with_seed_len );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003788 if( status != PSA_SUCCESS )
3789 goto cleanup;
3790
3791 status = psa_hmac_finish_internal( &hmac,
3792 tls12_prf->output_block,
3793 hash_length );
3794 if( status != PSA_SUCCESS )
3795 goto cleanup;
3796
3797cleanup:
3798
3799 cleanup_status = psa_hmac_abort_internal( &hmac );
3800 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3801 status = cleanup_status;
3802
3803 return( status );
3804}
3805
3806/* Read some bytes from an TLS-1.2-PRF-based generator.
3807 * See Section 5 of RFC 5246. */
3808static psa_status_t psa_generator_tls12_prf_read(
3809 psa_tls12_prf_generator_t *tls12_prf,
3810 psa_algorithm_t alg,
3811 uint8_t *output,
3812 size_t output_length )
3813{
3814 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
3815 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
3816 psa_status_t status;
3817
3818 while( output_length != 0 )
3819 {
3820 /* Copy what remains of the current block */
3821 uint8_t n = hash_length - tls12_prf->offset_in_block;
3822
3823 /* Check if we have fully processed the current block. */
3824 if( n == 0 )
3825 {
3826 status = psa_generator_tls12_prf_generate_next_block( tls12_prf,
3827 alg );
3828 if( status != PSA_SUCCESS )
3829 return( status );
3830
3831 continue;
3832 }
3833
3834 if( n > output_length )
3835 n = (uint8_t) output_length;
3836 memcpy( output, tls12_prf->output_block + tls12_prf->offset_in_block,
3837 n );
3838 output += n;
3839 output_length -= n;
3840 tls12_prf->offset_in_block += n;
3841 }
3842
3843 return( PSA_SUCCESS );
3844}
Gilles Peskinebef7f142018-07-12 17:22:21 +02003845#endif /* MBEDTLS_MD_C */
3846
Gilles Peskineeab56e42018-07-12 17:12:33 +02003847psa_status_t psa_generator_read( psa_crypto_generator_t *generator,
3848 uint8_t *output,
3849 size_t output_length )
3850{
3851 psa_status_t status;
3852
3853 if( output_length > generator->capacity )
3854 {
3855 generator->capacity = 0;
3856 /* Go through the error path to wipe all confidential data now
3857 * that the generator object is useless. */
3858 status = PSA_ERROR_INSUFFICIENT_CAPACITY;
3859 goto exit;
3860 }
3861 if( output_length == 0 &&
3862 generator->capacity == 0 && generator->alg == 0 )
3863 {
3864 /* Edge case: this is a blank or finished generator, and 0
3865 * bytes were requested. The right error in this case could
3866 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3867 * INSUFFICIENT_CAPACITY, which is right for a finished
3868 * generator, for consistency with the case when
3869 * output_length > 0. */
3870 return( PSA_ERROR_INSUFFICIENT_CAPACITY );
3871 }
3872 generator->capacity -= output_length;
3873
Gilles Peskine751d9652018-09-18 12:05:44 +02003874 if( generator->alg == PSA_ALG_SELECT_RAW )
3875 {
Gilles Peskine211a4362018-10-25 22:22:31 +02003876 /* Initially, the capacity of a selection generator is always
3877 * the size of the buffer, i.e. `generator->ctx.buffer.size`,
3878 * abbreviated in this comment as `size`. When the remaining
3879 * capacity is `c`, the next bytes to serve start `c` bytes
3880 * from the end of the buffer, i.e. `size - c` from the
3881 * beginning of the buffer. Since `generator->capacity` was just
3882 * decremented above, we need to serve the bytes from
3883 * `size - generator->capacity - output_length` to
3884 * `size - generator->capacity`. */
Gilles Peskine751d9652018-09-18 12:05:44 +02003885 size_t offset =
3886 generator->ctx.buffer.size - generator->capacity - output_length;
3887 memcpy( output, generator->ctx.buffer.data + offset, output_length );
3888 status = PSA_SUCCESS;
3889 }
3890 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02003891#if defined(MBEDTLS_MD_C)
3892 if( PSA_ALG_IS_HKDF( generator->alg ) )
3893 {
3894 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( generator->alg );
3895 status = psa_generator_hkdf_read( &generator->ctx.hkdf, hash_alg,
3896 output, output_length );
3897 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00003898 else if( PSA_ALG_IS_TLS12_PRF( generator->alg ) ||
3899 PSA_ALG_IS_TLS12_PSK_TO_MS( generator->alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003900 {
3901 status = psa_generator_tls12_prf_read( &generator->ctx.tls12_prf,
3902 generator->alg, output,
3903 output_length );
3904 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003905 else
3906#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003907 {
3908 return( PSA_ERROR_BAD_STATE );
3909 }
3910
3911exit:
3912 if( status != PSA_SUCCESS )
3913 {
3914 psa_generator_abort( generator );
3915 memset( output, '!', output_length );
3916 }
3917 return( status );
3918}
3919
Gilles Peskine08542d82018-07-19 17:05:42 +02003920#if defined(MBEDTLS_DES_C)
3921static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3922{
3923 if( data_size >= 8 )
3924 mbedtls_des_key_set_parity( data );
3925 if( data_size >= 16 )
3926 mbedtls_des_key_set_parity( data + 8 );
3927 if( data_size >= 24 )
3928 mbedtls_des_key_set_parity( data + 16 );
3929}
3930#endif /* MBEDTLS_DES_C */
3931
Gilles Peskinec5487a82018-12-03 18:08:14 +01003932psa_status_t psa_generator_import_key( psa_key_handle_t handle,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003933 psa_key_type_t type,
3934 size_t bits,
3935 psa_crypto_generator_t *generator )
3936{
3937 uint8_t *data = NULL;
3938 size_t bytes = PSA_BITS_TO_BYTES( bits );
3939 psa_status_t status;
3940
3941 if( ! key_type_is_raw_bytes( type ) )
3942 return( PSA_ERROR_INVALID_ARGUMENT );
3943 if( bits % 8 != 0 )
3944 return( PSA_ERROR_INVALID_ARGUMENT );
3945 data = mbedtls_calloc( 1, bytes );
3946 if( data == NULL )
3947 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3948
3949 status = psa_generator_read( generator, data, bytes );
3950 if( status != PSA_SUCCESS )
3951 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02003952#if defined(MBEDTLS_DES_C)
3953 if( type == PSA_KEY_TYPE_DES )
3954 psa_des_set_key_parity( data, bytes );
3955#endif /* MBEDTLS_DES_C */
Gilles Peskinec5487a82018-12-03 18:08:14 +01003956 status = psa_import_key( handle, type, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003957
3958exit:
3959 mbedtls_free( data );
3960 return( status );
3961}
3962
3963
3964
3965/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02003966/* Key derivation */
3967/****************************************************************/
3968
Gilles Peskinea05219c2018-11-16 16:02:56 +01003969#if defined(MBEDTLS_MD_C)
Gilles Peskinebef7f142018-07-12 17:22:21 +02003970/* Set up an HKDF-based generator. This is exactly the extract phase
Gilles Peskine346797d2018-11-16 16:05:06 +01003971 * of the HKDF algorithm.
3972 *
3973 * Note that if this function fails, you must call psa_generator_abort()
3974 * to potentially free embedded data structures and wipe confidential data.
3975 */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003976static psa_status_t psa_generator_hkdf_setup( psa_hkdf_generator_t *hkdf,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02003977 const uint8_t *secret,
3978 size_t secret_length,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003979 psa_algorithm_t hash_alg,
3980 const uint8_t *salt,
3981 size_t salt_length,
3982 const uint8_t *label,
3983 size_t label_length )
3984{
3985 psa_status_t status;
3986 status = psa_hmac_setup_internal( &hkdf->hmac,
3987 salt, salt_length,
Gilles Peskine00709fa2018-08-22 18:25:41 +02003988 PSA_ALG_HMAC_GET_HASH( hash_alg ) );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003989 if( status != PSA_SUCCESS )
3990 return( status );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02003991 status = psa_hash_update( &hkdf->hmac.hash_ctx, secret, secret_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003992 if( status != PSA_SUCCESS )
3993 return( status );
3994 status = psa_hmac_finish_internal( &hkdf->hmac,
3995 hkdf->prk,
3996 sizeof( hkdf->prk ) );
3997 if( status != PSA_SUCCESS )
3998 return( status );
3999 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4000 hkdf->block_number = 0;
4001 hkdf->info_length = label_length;
4002 if( label_length != 0 )
4003 {
4004 hkdf->info = mbedtls_calloc( 1, label_length );
4005 if( hkdf->info == NULL )
4006 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4007 memcpy( hkdf->info, label, label_length );
4008 }
4009 return( PSA_SUCCESS );
4010}
Gilles Peskinea05219c2018-11-16 16:02:56 +01004011#endif /* MBEDTLS_MD_C */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004012
Gilles Peskinea05219c2018-11-16 16:02:56 +01004013#if defined(MBEDTLS_MD_C)
Gilles Peskine346797d2018-11-16 16:05:06 +01004014/* Set up a TLS-1.2-prf-based generator (see RFC 5246, Section 5).
4015 *
4016 * Note that if this function fails, you must call psa_generator_abort()
4017 * to potentially free embedded data structures and wipe confidential data.
4018 */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004019static psa_status_t psa_generator_tls12_prf_setup(
4020 psa_tls12_prf_generator_t *tls12_prf,
4021 const unsigned char *key,
4022 size_t key_len,
4023 psa_algorithm_t hash_alg,
4024 const uint8_t *salt,
4025 size_t salt_length,
4026 const uint8_t *label,
4027 size_t label_length )
4028{
4029 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Hanno Becker580fba12018-11-13 20:50:45 +00004030 size_t Ai_with_seed_len = hash_length + salt_length + label_length;
4031 int overflow;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004032
4033 tls12_prf->key = mbedtls_calloc( 1, key_len );
4034 if( tls12_prf->key == NULL )
4035 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4036 tls12_prf->key_len = key_len;
4037 memcpy( tls12_prf->key, key, key_len );
4038
Hanno Becker580fba12018-11-13 20:50:45 +00004039 overflow = ( salt_length + label_length < salt_length ) ||
4040 ( salt_length + label_length + hash_length < hash_length );
4041 if( overflow )
4042 return( PSA_ERROR_INVALID_ARGUMENT );
4043
4044 tls12_prf->Ai_with_seed = mbedtls_calloc( 1, Ai_with_seed_len );
4045 if( tls12_prf->Ai_with_seed == NULL )
4046 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4047 tls12_prf->Ai_with_seed_len = Ai_with_seed_len;
4048
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004049 /* Write `label + seed' at the end of the `A(i) + seed` buffer,
4050 * leaving the initial `hash_length` bytes unspecified for now. */
Hanno Becker353e4532018-11-15 09:53:57 +00004051 if( label_length != 0 )
4052 {
4053 memcpy( tls12_prf->Ai_with_seed + hash_length,
4054 label, label_length );
4055 }
4056
4057 if( salt_length != 0 )
4058 {
4059 memcpy( tls12_prf->Ai_with_seed + hash_length + label_length,
4060 salt, salt_length );
4061 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004062
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004063 /* The first block gets generated when
4064 * psa_generator_read() is called. */
4065 tls12_prf->block_number = 0;
4066 tls12_prf->offset_in_block = hash_length;
4067
4068 return( PSA_SUCCESS );
4069}
Hanno Becker1aaedc02018-11-16 11:35:34 +00004070
4071/* Set up a TLS-1.2-PSK-to-MS-based generator. */
4072static psa_status_t psa_generator_tls12_psk_to_ms_setup(
4073 psa_tls12_prf_generator_t *tls12_prf,
4074 const unsigned char *psk,
4075 size_t psk_len,
4076 psa_algorithm_t hash_alg,
4077 const uint8_t *salt,
4078 size_t salt_length,
4079 const uint8_t *label,
4080 size_t label_length )
4081{
4082 psa_status_t status;
4083 unsigned char pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
4084
4085 if( psk_len > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4086 return( PSA_ERROR_INVALID_ARGUMENT );
4087
4088 /* Quoting RFC 4279, Section 2:
4089 *
4090 * The premaster secret is formed as follows: if the PSK is N octets
4091 * long, concatenate a uint16 with the value N, N zero octets, a second
4092 * uint16 with the value N, and the PSK itself.
4093 */
4094
4095 pms[0] = ( psk_len >> 8 ) & 0xff;
4096 pms[1] = ( psk_len >> 0 ) & 0xff;
4097 memset( pms + 2, 0, psk_len );
4098 pms[2 + psk_len + 0] = pms[0];
4099 pms[2 + psk_len + 1] = pms[1];
4100 memcpy( pms + 4 + psk_len, psk, psk_len );
4101
4102 status = psa_generator_tls12_prf_setup( tls12_prf,
4103 pms, 4 + 2 * psk_len,
4104 hash_alg,
4105 salt, salt_length,
4106 label, label_length );
4107
Gilles Peskine3f108122018-12-07 18:14:53 +01004108 mbedtls_platform_zeroize( pms, sizeof( pms ) );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004109 return( status );
4110}
Gilles Peskinea05219c2018-11-16 16:02:56 +01004111#endif /* MBEDTLS_MD_C */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004112
Gilles Peskine346797d2018-11-16 16:05:06 +01004113/* Note that if this function fails, you must call psa_generator_abort()
4114 * to potentially free embedded data structures and wipe confidential data.
4115 */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004116static psa_status_t psa_key_derivation_internal(
4117 psa_crypto_generator_t *generator,
4118 const uint8_t *secret, size_t secret_length,
4119 psa_algorithm_t alg,
4120 const uint8_t *salt, size_t salt_length,
4121 const uint8_t *label, size_t label_length,
4122 size_t capacity )
4123{
4124 psa_status_t status;
4125 size_t max_capacity;
4126
4127 /* Set generator->alg even on failure so that abort knows what to do. */
4128 generator->alg = alg;
4129
Gilles Peskine751d9652018-09-18 12:05:44 +02004130 if( alg == PSA_ALG_SELECT_RAW )
4131 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01004132 (void) salt;
Gilles Peskine751d9652018-09-18 12:05:44 +02004133 if( salt_length != 0 )
4134 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea05219c2018-11-16 16:02:56 +01004135 (void) label;
Gilles Peskine751d9652018-09-18 12:05:44 +02004136 if( label_length != 0 )
4137 return( PSA_ERROR_INVALID_ARGUMENT );
4138 generator->ctx.buffer.data = mbedtls_calloc( 1, secret_length );
4139 if( generator->ctx.buffer.data == NULL )
4140 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4141 memcpy( generator->ctx.buffer.data, secret, secret_length );
4142 generator->ctx.buffer.size = secret_length;
4143 max_capacity = secret_length;
4144 status = PSA_SUCCESS;
4145 }
4146 else
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004147#if defined(MBEDTLS_MD_C)
4148 if( PSA_ALG_IS_HKDF( alg ) )
4149 {
4150 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4151 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4152 if( hash_size == 0 )
4153 return( PSA_ERROR_NOT_SUPPORTED );
4154 max_capacity = 255 * hash_size;
4155 status = psa_generator_hkdf_setup( &generator->ctx.hkdf,
4156 secret, secret_length,
4157 hash_alg,
4158 salt, salt_length,
4159 label, label_length );
4160 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00004161 /* TLS-1.2 PRF and TLS-1.2 PSK-to-MS are very similar, so share code. */
4162 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
4163 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004164 {
4165 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4166 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4167
4168 /* TLS-1.2 PRF supports only SHA-256 and SHA-384. */
4169 if( hash_alg != PSA_ALG_SHA_256 &&
4170 hash_alg != PSA_ALG_SHA_384 )
4171 {
4172 return( PSA_ERROR_NOT_SUPPORTED );
4173 }
4174
4175 max_capacity = 255 * hash_size;
Hanno Becker1aaedc02018-11-16 11:35:34 +00004176
4177 if( PSA_ALG_IS_TLS12_PRF( alg ) )
4178 {
4179 status = psa_generator_tls12_prf_setup( &generator->ctx.tls12_prf,
4180 secret, secret_length,
4181 hash_alg, salt, salt_length,
4182 label, label_length );
4183 }
4184 else
4185 {
4186 status = psa_generator_tls12_psk_to_ms_setup(
4187 &generator->ctx.tls12_prf,
4188 secret, secret_length,
4189 hash_alg, salt, salt_length,
4190 label, label_length );
4191 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004192 }
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004193 else
4194#endif
4195 {
4196 return( PSA_ERROR_NOT_SUPPORTED );
4197 }
4198
4199 if( status != PSA_SUCCESS )
4200 return( status );
4201
4202 if( capacity <= max_capacity )
4203 generator->capacity = capacity;
Gilles Peskine8feb3a82018-09-18 12:06:11 +02004204 else if( capacity == PSA_GENERATOR_UNBRIDLED_CAPACITY )
4205 generator->capacity = max_capacity;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004206 else
4207 return( PSA_ERROR_INVALID_ARGUMENT );
4208
4209 return( PSA_SUCCESS );
4210}
4211
Gilles Peskineea0fb492018-07-12 17:17:20 +02004212psa_status_t psa_key_derivation( psa_crypto_generator_t *generator,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004213 psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +02004214 psa_algorithm_t alg,
4215 const uint8_t *salt,
4216 size_t salt_length,
4217 const uint8_t *label,
4218 size_t label_length,
4219 size_t capacity )
4220{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004221 psa_key_slot_t *slot;
Gilles Peskineea0fb492018-07-12 17:17:20 +02004222 psa_status_t status;
4223
4224 if( generator->alg != 0 )
4225 return( PSA_ERROR_BAD_STATE );
4226
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004227 /* Make sure that alg is a key derivation algorithm. This prevents
4228 * key selection algorithms, which psa_key_derivation_internal
4229 * accepts for the sake of key agreement. */
Gilles Peskineea0fb492018-07-12 17:17:20 +02004230 if( ! PSA_ALG_IS_KEY_DERIVATION( alg ) )
4231 return( PSA_ERROR_INVALID_ARGUMENT );
4232
Gilles Peskinec5487a82018-12-03 18:08:14 +01004233 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004234 if( status != PSA_SUCCESS )
4235 return( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004236
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004237 if( slot->type != PSA_KEY_TYPE_DERIVE )
4238 return( PSA_ERROR_INVALID_ARGUMENT );
4239
4240 status = psa_key_derivation_internal( generator,
4241 slot->data.raw.data,
4242 slot->data.raw.bytes,
4243 alg,
4244 salt, salt_length,
4245 label, label_length,
4246 capacity );
4247 if( status != PSA_SUCCESS )
Gilles Peskineea0fb492018-07-12 17:17:20 +02004248 psa_generator_abort( generator );
4249 return( status );
4250}
4251
4252
4253
4254/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004255/* Key agreement */
4256/****************************************************************/
4257
Gilles Peskinea05219c2018-11-16 16:02:56 +01004258#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004259static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4260 size_t peer_key_length,
4261 const mbedtls_ecp_keypair *our_key,
4262 uint8_t *shared_secret,
4263 size_t shared_secret_size,
4264 size_t *shared_secret_length )
4265{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004266 mbedtls_ecp_keypair *their_key = NULL;
4267 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004268 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004269 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004270
Jaeden Ameroccdce902019-01-10 11:42:27 +00004271 status = psa_import_ec_public_key(
4272 mbedtls_ecc_group_to_psa( our_key->grp.id ),
4273 peer_key, peer_key_length,
4274 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004275 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004276 goto exit;
4277
Jaeden Amero97271b32019-01-10 19:38:51 +00004278 status = mbedtls_to_psa_error(
4279 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
4280 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004281 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004282 status = mbedtls_to_psa_error(
4283 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4284 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004285 goto exit;
4286
Jaeden Amero97271b32019-01-10 19:38:51 +00004287 status = mbedtls_to_psa_error(
4288 mbedtls_ecdh_calc_secret( &ecdh,
4289 shared_secret_length,
4290 shared_secret, shared_secret_size,
4291 mbedtls_ctr_drbg_random,
4292 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004293
4294exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004295 mbedtls_ecdh_free( &ecdh );
Jaeden Ameroccdce902019-01-10 11:42:27 +00004296 mbedtls_ecp_keypair_free( their_key );
4297 mbedtls_free( their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004298 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004299}
Gilles Peskinea05219c2018-11-16 16:02:56 +01004300#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004301
Gilles Peskine01d718c2018-09-18 12:01:02 +02004302#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4303
Gilles Peskine346797d2018-11-16 16:05:06 +01004304/* Note that if this function fails, you must call psa_generator_abort()
4305 * to potentially free embedded data structures and wipe confidential data.
4306 */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004307static psa_status_t psa_key_agreement_internal( psa_crypto_generator_t *generator,
Gilles Peskine2f060a82018-12-04 17:12:32 +01004308 psa_key_slot_t *private_key,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004309 const uint8_t *peer_key,
4310 size_t peer_key_length,
4311 psa_algorithm_t alg )
4312{
4313 psa_status_t status;
4314 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4315 size_t shared_secret_length = 0;
4316
4317 /* Step 1: run the secret agreement algorithm to generate the shared
4318 * secret. */
4319 switch( PSA_ALG_KEY_AGREEMENT_GET_BASE( alg ) )
4320 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004321#if defined(MBEDTLS_ECDH_C)
4322 case PSA_ALG_ECDH_BASE:
4323 if( ! PSA_KEY_TYPE_IS_ECC_KEYPAIR( private_key->type ) )
4324 return( PSA_ERROR_INVALID_ARGUMENT );
4325 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
4326 private_key->data.ecp,
4327 shared_secret,
4328 sizeof( shared_secret ),
4329 &shared_secret_length );
4330 break;
4331#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004332 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004333 (void) private_key;
4334 (void) peer_key;
4335 (void) peer_key_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004336 return( PSA_ERROR_NOT_SUPPORTED );
4337 }
4338 if( status != PSA_SUCCESS )
4339 goto exit;
4340
4341 /* Step 2: set up the key derivation to generate key material from
4342 * the shared secret. */
4343 status = psa_key_derivation_internal( generator,
4344 shared_secret, shared_secret_length,
4345 PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ),
4346 NULL, 0, NULL, 0,
4347 PSA_GENERATOR_UNBRIDLED_CAPACITY );
4348exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004349 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004350 return( status );
4351}
4352
4353psa_status_t psa_key_agreement( psa_crypto_generator_t *generator,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004354 psa_key_handle_t private_key,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004355 const uint8_t *peer_key,
4356 size_t peer_key_length,
4357 psa_algorithm_t alg )
4358{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004359 psa_key_slot_t *slot;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004360 psa_status_t status;
4361 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4362 return( PSA_ERROR_INVALID_ARGUMENT );
4363 status = psa_get_key_from_slot( private_key, &slot,
4364 PSA_KEY_USAGE_DERIVE, alg );
4365 if( status != PSA_SUCCESS )
4366 return( status );
Gilles Peskine346797d2018-11-16 16:05:06 +01004367 status = psa_key_agreement_internal( generator,
4368 slot,
4369 peer_key, peer_key_length,
4370 alg );
4371 if( status != PSA_SUCCESS )
4372 psa_generator_abort( generator );
4373 return( status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004374}
4375
4376
4377
4378/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004379/* Random generation */
Gilles Peskine05d69892018-06-19 22:00:52 +02004380/****************************************************************/
4381
4382psa_status_t psa_generate_random( uint8_t *output,
4383 size_t output_size )
4384{
itayzafrir0adf0fc2018-09-06 16:24:41 +03004385 int ret;
4386 GUARD_MODULE_INITIALIZED;
4387
4388 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
Gilles Peskine05d69892018-06-19 22:00:52 +02004389 return( mbedtls_to_psa_error( ret ) );
4390}
4391
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004392#if ( defined(MBEDTLS_ENTROPY_NV_SEED) && defined(MBEDTLS_PSA_HAS_ITS_IO) )
avolinski13beb102018-11-20 16:51:49 +02004393
4394/* Support function for error conversion between psa_its error codes to psa crypto */
4395static psa_status_t its_to_psa_error( psa_its_status_t ret )
4396{
4397 switch( ret )
4398 {
4399 case PSA_ITS_SUCCESS:
4400 return( PSA_SUCCESS );
4401
Oren Cohen23a67842019-01-24 14:32:11 +02004402 case PSA_ITS_ERROR_UID_NOT_FOUND:
avolinski13beb102018-11-20 16:51:49 +02004403 return( PSA_ERROR_EMPTY_SLOT );
4404
4405 case PSA_ITS_ERROR_STORAGE_FAILURE:
4406 return( PSA_ERROR_STORAGE_FAILURE );
4407
4408 case PSA_ITS_ERROR_INSUFFICIENT_SPACE:
4409 return( PSA_ERROR_INSUFFICIENT_STORAGE );
4410
Jaeden Amero58600552018-11-30 12:04:38 +00004411 case PSA_ITS_ERROR_OFFSET_INVALID:
avolinski13beb102018-11-20 16:51:49 +02004412 case PSA_ITS_ERROR_INCORRECT_SIZE:
Oren Cohen23a67842019-01-24 14:32:11 +02004413 case PSA_ITS_ERROR_INVALID_ARGUMENTS:
avolinski13beb102018-11-20 16:51:49 +02004414 return( PSA_ERROR_INVALID_ARGUMENT );
4415
4416 case PSA_ITS_ERROR_FLAGS_NOT_SUPPORTED:
4417 return( PSA_ERROR_NOT_SUPPORTED );
4418
4419 case PSA_ITS_ERROR_WRITE_ONCE:
4420 return( PSA_ERROR_OCCUPIED_SLOT );
4421
4422 default:
4423 return( PSA_ERROR_UNKNOWN_ERROR );
4424 }
4425}
4426
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004427psa_status_t mbedtls_psa_inject_entropy( const unsigned char *seed,
4428 size_t seed_size )
4429{
4430 psa_status_t status;
avolinski13beb102018-11-20 16:51:49 +02004431 psa_its_status_t its_status;
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004432 struct psa_its_info_t p_info;
4433 if( global_data.initialized )
4434 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004435
4436 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4437 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4438 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4439 return( PSA_ERROR_INVALID_ARGUMENT );
4440
avolinski0d2c2662018-11-21 17:31:07 +02004441 its_status = psa_its_get_info( PSA_CRYPTO_ITS_RANDOM_SEED_UID, &p_info );
avolinski13beb102018-11-20 16:51:49 +02004442 status = its_to_psa_error( its_status );
4443
Oren Cohen23a67842019-01-24 14:32:11 +02004444 if( PSA_ITS_ERROR_UID_NOT_FOUND == its_status ) /* No seed exists */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004445 {
avolinski0d2c2662018-11-21 17:31:07 +02004446 its_status = psa_its_set( PSA_CRYPTO_ITS_RANDOM_SEED_UID, seed_size, seed, 0 );
avolinski13beb102018-11-20 16:51:49 +02004447 status = its_to_psa_error( its_status );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004448 }
avolinski13beb102018-11-20 16:51:49 +02004449 else if( PSA_ITS_SUCCESS == its_status )
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004450 {
4451 /* You should not be here. Seed needs to be injected only once */
4452 status = PSA_ERROR_NOT_PERMITTED;
4453 }
4454 return( status );
4455}
4456#endif
4457
Gilles Peskinec5487a82018-12-03 18:08:14 +01004458psa_status_t psa_generate_key( psa_key_handle_t handle,
Gilles Peskine05d69892018-06-19 22:00:52 +02004459 psa_key_type_t type,
4460 size_t bits,
Gilles Peskine53d991e2018-07-12 01:14:59 +02004461 const void *extra,
4462 size_t extra_size )
Gilles Peskine05d69892018-06-19 22:00:52 +02004463{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004464 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004465 psa_status_t status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02004466
Gilles Peskine53d991e2018-07-12 01:14:59 +02004467 if( extra == NULL && extra_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004468 return( PSA_ERROR_INVALID_ARGUMENT );
4469
Gilles Peskinec5487a82018-12-03 18:08:14 +01004470 status = psa_get_empty_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004471 if( status != PSA_SUCCESS )
4472 return( status );
4473
Gilles Peskine48c0ea12018-06-21 14:15:31 +02004474 if( key_type_is_raw_bytes( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004475 {
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004476 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004477 if( status != PSA_SUCCESS )
4478 return( status );
4479 status = psa_generate_random( slot->data.raw.data,
4480 slot->data.raw.bytes );
4481 if( status != PSA_SUCCESS )
4482 {
4483 mbedtls_free( slot->data.raw.data );
4484 return( status );
4485 }
4486#if defined(MBEDTLS_DES_C)
4487 if( type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004488 psa_des_set_key_parity( slot->data.raw.data,
4489 slot->data.raw.bytes );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004490#endif /* MBEDTLS_DES_C */
4491 }
4492 else
4493
4494#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
4495 if ( type == PSA_KEY_TYPE_RSA_KEYPAIR )
4496 {
4497 mbedtls_rsa_context *rsa;
4498 int ret;
4499 int exponent = 65537;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004500 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4501 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine86a440b2018-11-12 18:39:40 +01004502 /* Accept only byte-aligned keys, for the same reasons as
4503 * in psa_import_rsa_key(). */
4504 if( bits % 8 != 0 )
4505 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004506 if( extra != NULL )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004507 {
Gilles Peskine4c317f42018-07-12 01:24:09 +02004508 const psa_generate_key_extra_rsa *p = extra;
Gilles Peskine53d991e2018-07-12 01:14:59 +02004509 if( extra_size != sizeof( *p ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004510 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine4c317f42018-07-12 01:24:09 +02004511#if INT_MAX < 0xffffffff
4512 /* Check that the uint32_t value passed by the caller fits
4513 * in the range supported by this implementation. */
4514 if( p->e > INT_MAX )
4515 return( PSA_ERROR_NOT_SUPPORTED );
4516#endif
4517 exponent = p->e;
Gilles Peskine12313cd2018-06-20 00:20:32 +02004518 }
4519 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
4520 if( rsa == NULL )
4521 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4522 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
4523 ret = mbedtls_rsa_gen_key( rsa,
4524 mbedtls_ctr_drbg_random,
4525 &global_data.ctr_drbg,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004526 (unsigned int) bits,
Gilles Peskine12313cd2018-06-20 00:20:32 +02004527 exponent );
4528 if( ret != 0 )
4529 {
4530 mbedtls_rsa_free( rsa );
4531 mbedtls_free( rsa );
4532 return( mbedtls_to_psa_error( ret ) );
4533 }
4534 slot->data.rsa = rsa;
4535 }
4536 else
4537#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
4538
4539#if defined(MBEDTLS_ECP_C)
4540 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEYPAIR( type ) )
4541 {
4542 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
4543 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
4544 const mbedtls_ecp_curve_info *curve_info =
4545 mbedtls_ecp_curve_info_from_grp_id( grp_id );
4546 mbedtls_ecp_keypair *ecp;
4547 int ret;
Gilles Peskine53d991e2018-07-12 01:14:59 +02004548 if( extra != NULL )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004549 return( PSA_ERROR_NOT_SUPPORTED );
4550 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
4551 return( PSA_ERROR_NOT_SUPPORTED );
4552 if( curve_info->bit_size != bits )
4553 return( PSA_ERROR_INVALID_ARGUMENT );
4554 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
4555 if( ecp == NULL )
4556 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4557 mbedtls_ecp_keypair_init( ecp );
4558 ret = mbedtls_ecp_gen_key( grp_id, ecp,
4559 mbedtls_ctr_drbg_random,
4560 &global_data.ctr_drbg );
4561 if( ret != 0 )
4562 {
4563 mbedtls_ecp_keypair_free( ecp );
4564 mbedtls_free( ecp );
4565 return( mbedtls_to_psa_error( ret ) );
4566 }
4567 slot->data.ecp = ecp;
4568 }
4569 else
4570#endif /* MBEDTLS_ECP_C */
4571
4572 return( PSA_ERROR_NOT_SUPPORTED );
4573
4574 slot->type = type;
Darryl Green0c6575a2018-11-07 16:05:30 +00004575
4576#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
4577 if( slot->lifetime == PSA_KEY_LIFETIME_PERSISTENT )
4578 {
Gilles Peskine69f976b2018-11-30 18:46:56 +01004579 return( psa_save_generated_persistent_key( slot, bits ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00004580 }
4581#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
4582
4583 return( status );
Gilles Peskine05d69892018-06-19 22:00:52 +02004584}
4585
4586
4587/****************************************************************/
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01004588/* Module setup */
4589/****************************************************************/
4590
Gilles Peskine5e769522018-11-20 21:59:56 +01004591psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
4592 void (* entropy_init )( mbedtls_entropy_context *ctx ),
4593 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
4594{
4595 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4596 return( PSA_ERROR_BAD_STATE );
4597 global_data.entropy_init = entropy_init;
4598 global_data.entropy_free = entropy_free;
4599 return( PSA_SUCCESS );
4600}
4601
Gilles Peskinee59236f2018-01-27 23:32:46 +01004602void mbedtls_psa_crypto_free( void )
4603{
Gilles Peskine66fb1262018-12-10 16:29:04 +01004604 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004605 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4606 {
4607 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01004608 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004609 }
4610 /* Wipe all remaining data, including configuration.
4611 * In particular, this sets all state indicator to the value
4612 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01004613 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004614}
4615
4616psa_status_t psa_crypto_init( void )
4617{
Gilles Peskine66fb1262018-12-10 16:29:04 +01004618 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004619 const unsigned char drbg_seed[] = "PSA";
4620
Gilles Peskinec6b69072018-11-20 21:42:52 +01004621 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004622 if( global_data.initialized != 0 )
4623 return( PSA_SUCCESS );
4624
Gilles Peskine5e769522018-11-20 21:59:56 +01004625 /* Set default configuration if
4626 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4627 if( global_data.entropy_init == NULL )
4628 global_data.entropy_init = mbedtls_entropy_init;
4629 if( global_data.entropy_free == NULL )
4630 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004631
Gilles Peskinec6b69072018-11-20 21:42:52 +01004632 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01004633 global_data.entropy_init( &global_data.entropy );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004634 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004635 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01004636 status = mbedtls_to_psa_error(
4637 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
4638 mbedtls_entropy_func,
4639 &global_data.entropy,
4640 drbg_seed, sizeof( drbg_seed ) - 1 ) );
4641 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004642 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01004643 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004644
Gilles Peskine66fb1262018-12-10 16:29:04 +01004645 status = psa_initialize_key_slots( );
4646 if( status != PSA_SUCCESS )
4647 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01004648
4649 /* All done. */
Gilles Peskinee4ebc122018-03-07 14:16:44 +01004650 global_data.initialized = 1;
4651
Gilles Peskinee59236f2018-01-27 23:32:46 +01004652exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01004653 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004654 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01004655 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004656}
4657
4658#endif /* MBEDTLS_PSA_CRYPTO_C */