blob: dacb80e79a8bc6094ee93acacc97bb8c00ffbffa [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
4/* Copyright (C) 2018, ARM Limited, All Rights Reserved
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS (https://tls.mbed.org)
20 */
21
22#if !defined(MBEDTLS_CONFIG_FILE)
23#include "mbedtls/config.h"
24#else
25#include MBEDTLS_CONFIG_FILE
26#endif
27
28#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030029
itayzafrir7723ab12019-02-14 10:28:02 +020030#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031#include "psa/crypto.h"
32
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020036#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010038#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010039/* Include internal declarations that are useful for implementing persistently
40 * stored keys. */
41#include "psa_crypto_storage.h"
42
Gilles Peskineb46bef22019-07-30 21:32:04 +020043#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include <stdlib.h>
45#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010046#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020047#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#define mbedtls_calloc calloc
49#define mbedtls_free free
50#endif
51
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020053#include "mbedtls/asn1.h"
Jaeden Amero6b196002019-01-10 10:23:21 +000054#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020055#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/blowfish.h"
57#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020058#include "mbedtls/chacha20.h"
59#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/cipher.h"
61#include "mbedtls/ccm.h"
62#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020065#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010067#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/error.h"
69#include "mbedtls/gcm.h"
70#include "mbedtls/md2.h"
71#include "mbedtls/md4.h"
72#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010073#include "mbedtls/md.h"
74#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010075#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010077#include "mbedtls/platform_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010078#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010079#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010080#include "mbedtls/sha1.h"
81#include "mbedtls/sha256.h"
82#include "mbedtls/sha512.h"
83#include "mbedtls/xtea.h"
84
Gilles Peskine996deb12018-08-01 15:45:45 +020085#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
86
Gilles Peskine9ef733f2018-02-07 21:05:37 +010087/* constant-time buffer comparison */
88static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
89{
90 size_t i;
91 unsigned char diff = 0;
92
93 for( i = 0; i < n; i++ )
94 diff |= a[i] ^ b[i];
95
96 return( diff );
97}
98
99
100
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100101/****************************************************************/
102/* Global data, support functions and library management */
103/****************************************************************/
104
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105static int key_type_is_raw_bytes( psa_key_type_t type )
106{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200107 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200108}
109
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100110/* Values for psa_global_data_t::rng_state */
111#define RNG_NOT_INITIALIZED 0
112#define RNG_INITIALIZED 1
113#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100114
Gilles Peskine2d277862018-06-18 15:41:12 +0200115typedef struct
116{
Gilles Peskine5e769522018-11-20 21:59:56 +0100117 void (* entropy_init )( mbedtls_entropy_context *ctx );
118 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100119 mbedtls_entropy_context entropy;
120 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100121 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100122 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123} psa_global_data_t;
124
125static psa_global_data_t global_data;
126
itayzafrir0adf0fc2018-09-06 16:24:41 +0300127#define GUARD_MODULE_INITIALIZED \
128 if( global_data.initialized == 0 ) \
129 return( PSA_ERROR_BAD_STATE );
130
Gilles Peskinee59236f2018-01-27 23:32:46 +0100131static psa_status_t mbedtls_to_psa_error( int ret )
132{
Gilles Peskinea5905292018-02-07 20:59:33 +0100133 /* If there's both a high-level code and low-level code, dispatch on
134 * the high-level code. */
135 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100136 {
137 case 0:
138 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100139
140 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
141 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
142 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
143 return( PSA_ERROR_NOT_SUPPORTED );
144 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
147 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
148 return( PSA_ERROR_HARDWARE_FAILURE );
149
Gilles Peskine9a944802018-06-21 09:35:35 +0200150 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
151 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
152 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
153 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
154 case MBEDTLS_ERR_ASN1_INVALID_DATA:
155 return( PSA_ERROR_INVALID_ARGUMENT );
156 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
157 return( PSA_ERROR_INSUFFICIENT_MEMORY );
158 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
159 return( PSA_ERROR_BUFFER_TOO_SMALL );
160
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000162 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000163#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
Gilles Peskinea5905292018-02-07 20:59:33 +0100164 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
Jaeden Amero93e21112019-02-20 13:57:28 +0000165#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
169 return( PSA_ERROR_HARDWARE_FAILURE );
170
Jaeden Amero93e21112019-02-20 13:57:28 +0000171#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000172 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
Jaeden Amero93e21112019-02-20 13:57:28 +0000175#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
177 return( PSA_ERROR_NOT_SUPPORTED );
178 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
179 return( PSA_ERROR_HARDWARE_FAILURE );
180
181 case MBEDTLS_ERR_CCM_BAD_INPUT:
182 return( PSA_ERROR_INVALID_ARGUMENT );
183 case MBEDTLS_ERR_CCM_AUTH_FAILED:
184 return( PSA_ERROR_INVALID_SIGNATURE );
185 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
186 return( PSA_ERROR_HARDWARE_FAILURE );
187
Gilles Peskine26869f22019-05-06 15:25:00 +0200188 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
189 return( PSA_ERROR_INVALID_ARGUMENT );
190
191 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
192 return( PSA_ERROR_BAD_STATE );
193 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
194 return( PSA_ERROR_INVALID_SIGNATURE );
195
Gilles Peskinea5905292018-02-07 20:59:33 +0100196 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
197 return( PSA_ERROR_NOT_SUPPORTED );
198 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
199 return( PSA_ERROR_INVALID_ARGUMENT );
200 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
201 return( PSA_ERROR_INSUFFICIENT_MEMORY );
202 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
203 return( PSA_ERROR_INVALID_PADDING );
204 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
205 return( PSA_ERROR_BAD_STATE );
206 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
207 return( PSA_ERROR_INVALID_SIGNATURE );
208 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200209 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100210 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
214 return( PSA_ERROR_HARDWARE_FAILURE );
215
216 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
219 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
220 return( PSA_ERROR_NOT_SUPPORTED );
221 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
222 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
223
224 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
225 return( PSA_ERROR_NOT_SUPPORTED );
226 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
227 return( PSA_ERROR_HARDWARE_FAILURE );
228
Gilles Peskinee59236f2018-01-27 23:32:46 +0100229 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
230 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
231 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
232 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100233
234 case MBEDTLS_ERR_GCM_AUTH_FAILED:
235 return( PSA_ERROR_INVALID_SIGNATURE );
236 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200237 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100238 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
239 return( PSA_ERROR_HARDWARE_FAILURE );
240
241 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
242 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
243 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
244 return( PSA_ERROR_HARDWARE_FAILURE );
245
246 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
247 return( PSA_ERROR_NOT_SUPPORTED );
248 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
249 return( PSA_ERROR_INVALID_ARGUMENT );
250 case MBEDTLS_ERR_MD_ALLOC_FAILED:
251 return( PSA_ERROR_INSUFFICIENT_MEMORY );
252 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
253 return( PSA_ERROR_STORAGE_FAILURE );
254 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
255 return( PSA_ERROR_HARDWARE_FAILURE );
256
Gilles Peskinef76aa772018-10-29 19:24:33 +0100257 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
258 return( PSA_ERROR_STORAGE_FAILURE );
259 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
260 return( PSA_ERROR_INVALID_ARGUMENT );
261 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
264 return( PSA_ERROR_BUFFER_TOO_SMALL );
265 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
266 return( PSA_ERROR_INVALID_ARGUMENT );
267 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
268 return( PSA_ERROR_INVALID_ARGUMENT );
269 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
270 return( PSA_ERROR_INVALID_ARGUMENT );
271 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100274 case MBEDTLS_ERR_PK_ALLOC_FAILED:
275 return( PSA_ERROR_INSUFFICIENT_MEMORY );
276 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
277 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100281 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
282 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
283 return( PSA_ERROR_INVALID_ARGUMENT );
284 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
285 return( PSA_ERROR_NOT_SUPPORTED );
286 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
287 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
288 return( PSA_ERROR_NOT_PERMITTED );
289 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
290 return( PSA_ERROR_INVALID_ARGUMENT );
291 case MBEDTLS_ERR_PK_INVALID_ALG:
292 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
293 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
294 return( PSA_ERROR_NOT_SUPPORTED );
295 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
296 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100297 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299
Gilles Peskineff2d2002019-05-06 15:26:23 +0200300 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
301 return( PSA_ERROR_HARDWARE_FAILURE );
302 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
303 return( PSA_ERROR_NOT_SUPPORTED );
304
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
306 return( PSA_ERROR_HARDWARE_FAILURE );
307
308 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
309 return( PSA_ERROR_INVALID_ARGUMENT );
310 case MBEDTLS_ERR_RSA_INVALID_PADDING:
311 return( PSA_ERROR_INVALID_PADDING );
312 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
313 return( PSA_ERROR_HARDWARE_FAILURE );
314 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
315 return( PSA_ERROR_INVALID_ARGUMENT );
316 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
317 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200318 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100319 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
320 return( PSA_ERROR_INVALID_SIGNATURE );
321 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
322 return( PSA_ERROR_BUFFER_TOO_SMALL );
323 case MBEDTLS_ERR_RSA_RNG_FAILED:
324 return( PSA_ERROR_INSUFFICIENT_MEMORY );
325 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
326 return( PSA_ERROR_NOT_SUPPORTED );
327 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
328 return( PSA_ERROR_HARDWARE_FAILURE );
329
330 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
331 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
332 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
333 return( PSA_ERROR_HARDWARE_FAILURE );
334
335 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
336 return( PSA_ERROR_INVALID_ARGUMENT );
337 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
338 return( PSA_ERROR_HARDWARE_FAILURE );
339
itayzafrir5c753392018-05-08 11:18:38 +0300340 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300341 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300342 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300343 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
344 return( PSA_ERROR_BUFFER_TOO_SMALL );
345 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
346 return( PSA_ERROR_NOT_SUPPORTED );
347 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
348 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
349 return( PSA_ERROR_INVALID_SIGNATURE );
350 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
351 return( PSA_ERROR_INSUFFICIENT_MEMORY );
352 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
353 return( PSA_ERROR_HARDWARE_FAILURE );
itayzafrir5c753392018-05-08 11:18:38 +0300354
Gilles Peskinee59236f2018-01-27 23:32:46 +0100355 default:
David Saadab4ecc272019-02-14 13:48:10 +0200356 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100357 }
358}
359
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200360
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200361
362
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100363/****************************************************************/
364/* Key management */
365/****************************************************************/
366
Gilles Peskine73167e12019-07-12 23:44:37 +0200367#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
368static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
369{
Gilles Peskine8e338702019-07-30 20:06:31 +0200370 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200371}
372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
373
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100374#if defined(MBEDTLS_ECP_C)
Gilles Peskine34ef7f52018-06-18 20:47:51 +0200375static psa_ecc_curve_t mbedtls_ecc_group_to_psa( mbedtls_ecp_group_id grpid )
376{
377 switch( grpid )
378 {
379 case MBEDTLS_ECP_DP_SECP192R1:
380 return( PSA_ECC_CURVE_SECP192R1 );
381 case MBEDTLS_ECP_DP_SECP224R1:
382 return( PSA_ECC_CURVE_SECP224R1 );
383 case MBEDTLS_ECP_DP_SECP256R1:
384 return( PSA_ECC_CURVE_SECP256R1 );
385 case MBEDTLS_ECP_DP_SECP384R1:
386 return( PSA_ECC_CURVE_SECP384R1 );
387 case MBEDTLS_ECP_DP_SECP521R1:
388 return( PSA_ECC_CURVE_SECP521R1 );
389 case MBEDTLS_ECP_DP_BP256R1:
390 return( PSA_ECC_CURVE_BRAINPOOL_P256R1 );
391 case MBEDTLS_ECP_DP_BP384R1:
392 return( PSA_ECC_CURVE_BRAINPOOL_P384R1 );
393 case MBEDTLS_ECP_DP_BP512R1:
394 return( PSA_ECC_CURVE_BRAINPOOL_P512R1 );
395 case MBEDTLS_ECP_DP_CURVE25519:
396 return( PSA_ECC_CURVE_CURVE25519 );
397 case MBEDTLS_ECP_DP_SECP192K1:
398 return( PSA_ECC_CURVE_SECP192K1 );
399 case MBEDTLS_ECP_DP_SECP224K1:
400 return( PSA_ECC_CURVE_SECP224K1 );
401 case MBEDTLS_ECP_DP_SECP256K1:
402 return( PSA_ECC_CURVE_SECP256K1 );
403 case MBEDTLS_ECP_DP_CURVE448:
404 return( PSA_ECC_CURVE_CURVE448 );
405 default:
406 return( 0 );
407 }
408}
409
Gilles Peskine12313cd2018-06-20 00:20:32 +0200410static mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_curve_t curve )
411{
412 switch( curve )
413 {
414 case PSA_ECC_CURVE_SECP192R1:
415 return( MBEDTLS_ECP_DP_SECP192R1 );
416 case PSA_ECC_CURVE_SECP224R1:
417 return( MBEDTLS_ECP_DP_SECP224R1 );
418 case PSA_ECC_CURVE_SECP256R1:
419 return( MBEDTLS_ECP_DP_SECP256R1 );
420 case PSA_ECC_CURVE_SECP384R1:
421 return( MBEDTLS_ECP_DP_SECP384R1 );
422 case PSA_ECC_CURVE_SECP521R1:
423 return( MBEDTLS_ECP_DP_SECP521R1 );
424 case PSA_ECC_CURVE_BRAINPOOL_P256R1:
425 return( MBEDTLS_ECP_DP_BP256R1 );
426 case PSA_ECC_CURVE_BRAINPOOL_P384R1:
427 return( MBEDTLS_ECP_DP_BP384R1 );
428 case PSA_ECC_CURVE_BRAINPOOL_P512R1:
429 return( MBEDTLS_ECP_DP_BP512R1 );
430 case PSA_ECC_CURVE_CURVE25519:
431 return( MBEDTLS_ECP_DP_CURVE25519 );
432 case PSA_ECC_CURVE_SECP192K1:
433 return( MBEDTLS_ECP_DP_SECP192K1 );
434 case PSA_ECC_CURVE_SECP224K1:
435 return( MBEDTLS_ECP_DP_SECP224K1 );
436 case PSA_ECC_CURVE_SECP256K1:
437 return( MBEDTLS_ECP_DP_SECP256K1 );
438 case PSA_ECC_CURVE_CURVE448:
439 return( MBEDTLS_ECP_DP_CURVE448 );
440 default:
441 return( MBEDTLS_ECP_DP_NONE );
442 }
443}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100444#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200445
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446static psa_status_t prepare_raw_data_slot( psa_key_type_t type,
447 size_t bits,
448 struct raw_data *raw )
449{
450 /* Check that the bit size is acceptable for the key type */
451 switch( type )
452 {
453 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200454 if( bits == 0 )
455 {
456 raw->bytes = 0;
457 raw->data = NULL;
458 return( PSA_SUCCESS );
459 }
460 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200461#if defined(MBEDTLS_MD_C)
462 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200463#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200464 case PSA_KEY_TYPE_DERIVE:
465 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200466#if defined(MBEDTLS_AES_C)
467 case PSA_KEY_TYPE_AES:
468 if( bits != 128 && bits != 192 && bits != 256 )
469 return( PSA_ERROR_INVALID_ARGUMENT );
470 break;
471#endif
472#if defined(MBEDTLS_CAMELLIA_C)
473 case PSA_KEY_TYPE_CAMELLIA:
474 if( bits != 128 && bits != 192 && bits != 256 )
475 return( PSA_ERROR_INVALID_ARGUMENT );
476 break;
477#endif
478#if defined(MBEDTLS_DES_C)
479 case PSA_KEY_TYPE_DES:
480 if( bits != 64 && bits != 128 && bits != 192 )
481 return( PSA_ERROR_INVALID_ARGUMENT );
482 break;
483#endif
484#if defined(MBEDTLS_ARC4_C)
485 case PSA_KEY_TYPE_ARC4:
486 if( bits < 8 || bits > 2048 )
487 return( PSA_ERROR_INVALID_ARGUMENT );
488 break;
489#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200490#if defined(MBEDTLS_CHACHA20_C)
491 case PSA_KEY_TYPE_CHACHA20:
492 if( bits != 256 )
493 return( PSA_ERROR_INVALID_ARGUMENT );
494 break;
495#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200496 default:
497 return( PSA_ERROR_NOT_SUPPORTED );
498 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200499 if( bits % 8 != 0 )
500 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200501
502 /* Allocate memory for the key */
503 raw->bytes = PSA_BITS_TO_BYTES( bits );
504 raw->data = mbedtls_calloc( 1, raw->bytes );
505 if( raw->data == NULL )
506 {
507 raw->bytes = 0;
508 return( PSA_ERROR_INSUFFICIENT_MEMORY );
509 }
510 return( PSA_SUCCESS );
511}
512
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200513#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100514/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
515 * that are not a multiple of 8) well. For example, there is only
516 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
517 * way to return the exact bit size of a key.
518 * To keep things simple, reject non-byte-aligned key sizes. */
519static psa_status_t psa_check_rsa_key_byte_aligned(
520 const mbedtls_rsa_context *rsa )
521{
522 mbedtls_mpi n;
523 psa_status_t status;
524 mbedtls_mpi_init( &n );
525 status = mbedtls_to_psa_error(
526 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
527 if( status == PSA_SUCCESS )
528 {
529 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
530 status = PSA_ERROR_NOT_SUPPORTED;
531 }
532 mbedtls_mpi_free( &n );
533 return( status );
534}
535
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000536static psa_status_t psa_import_rsa_key( psa_key_type_t type,
537 const uint8_t *data,
538 size_t data_length,
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200539 mbedtls_rsa_context **p_rsa )
540{
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000541 psa_status_t status;
542 mbedtls_pk_context pk;
543 mbedtls_rsa_context *rsa;
544 size_t bits;
545
546 mbedtls_pk_init( &pk );
547
548 /* Parse the data. */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200549 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000550 status = mbedtls_to_psa_error(
551 mbedtls_pk_parse_key( &pk, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200552 else
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000553 status = mbedtls_to_psa_error(
554 mbedtls_pk_parse_public_key( &pk, data, data_length ) );
555 if( status != PSA_SUCCESS )
556 goto exit;
557
558 /* We have something that the pkparse module recognizes. If it is a
559 * valid RSA key, store it. */
560 if( mbedtls_pk_get_type( &pk ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200561 {
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000562 status = PSA_ERROR_INVALID_ARGUMENT;
563 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200564 }
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000565
566 rsa = mbedtls_pk_rsa( pk );
567 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
568 * supports non-byte-aligned key sizes, but not well. For example,
569 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
570 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
571 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
572 {
573 status = PSA_ERROR_NOT_SUPPORTED;
574 goto exit;
575 }
576 status = psa_check_rsa_key_byte_aligned( rsa );
577
578exit:
579 /* Free the content of the pk object only on error. */
580 if( status != PSA_SUCCESS )
581 {
582 mbedtls_pk_free( &pk );
583 return( status );
584 }
585
586 /* On success, store the content of the object in the RSA context. */
587 *p_rsa = rsa;
588
589 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200590}
591#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
592
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000593#if defined(MBEDTLS_ECP_C)
594
595/* Import a public key given as the uncompressed representation defined by SEC1
596 * 2.3.3 as the content of an ECPoint. */
597static psa_status_t psa_import_ec_public_key( psa_ecc_curve_t curve,
598 const uint8_t *data,
599 size_t data_length,
600 mbedtls_ecp_keypair **p_ecp )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200601{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200602 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000603 mbedtls_ecp_keypair *ecp = NULL;
604 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
605
606 *p_ecp = NULL;
607 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
608 if( ecp == NULL )
609 return( PSA_ERROR_INSUFFICIENT_MEMORY );
610 mbedtls_ecp_keypair_init( ecp );
611
612 /* Load the group. */
613 status = mbedtls_to_psa_error(
614 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
615 if( status != PSA_SUCCESS )
616 goto exit;
617 /* Load the public value. */
618 status = mbedtls_to_psa_error(
619 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
620 data, data_length ) );
621 if( status != PSA_SUCCESS )
622 goto exit;
623
624 /* Check that the point is on the curve. */
625 status = mbedtls_to_psa_error(
626 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
627 if( status != PSA_SUCCESS )
628 goto exit;
629
630 *p_ecp = ecp;
631 return( PSA_SUCCESS );
632
633exit:
634 if( ecp != NULL )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200635 {
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000636 mbedtls_ecp_keypair_free( ecp );
637 mbedtls_free( ecp );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200638 }
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000639 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200640}
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000641#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200642
Gilles Peskinef76aa772018-10-29 19:24:33 +0100643#if defined(MBEDTLS_ECP_C)
644/* Import a private key given as a byte string which is the private value
645 * in big-endian order. */
646static psa_status_t psa_import_ec_private_key( psa_ecc_curve_t curve,
647 const uint8_t *data,
648 size_t data_length,
649 mbedtls_ecp_keypair **p_ecp )
650{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100652 mbedtls_ecp_keypair *ecp = NULL;
653 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
654
Gilles Peskinec9d910b2019-05-13 14:21:57 +0200655 if( PSA_BITS_TO_BYTES( PSA_ECC_CURVE_BITS( curve ) ) != data_length )
656 return( PSA_ERROR_INVALID_ARGUMENT );
657
Gilles Peskinef76aa772018-10-29 19:24:33 +0100658 *p_ecp = NULL;
659 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
660 if( ecp == NULL )
661 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Jaeden Amero83d29392019-01-10 20:17:42 +0000662 mbedtls_ecp_keypair_init( ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100663
664 /* Load the group. */
665 status = mbedtls_to_psa_error(
666 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
667 if( status != PSA_SUCCESS )
668 goto exit;
669 /* Load the secret value. */
670 status = mbedtls_to_psa_error(
671 mbedtls_mpi_read_binary( &ecp->d, data, data_length ) );
672 if( status != PSA_SUCCESS )
673 goto exit;
674 /* Validate the private key. */
675 status = mbedtls_to_psa_error(
676 mbedtls_ecp_check_privkey( &ecp->grp, &ecp->d ) );
677 if( status != PSA_SUCCESS )
678 goto exit;
679 /* Calculate the public key from the private key. */
680 status = mbedtls_to_psa_error(
681 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
682 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
683 if( status != PSA_SUCCESS )
684 goto exit;
685
686 *p_ecp = ecp;
687 return( PSA_SUCCESS );
688
689exit:
690 if( ecp != NULL )
691 {
692 mbedtls_ecp_keypair_free( ecp );
693 mbedtls_free( ecp );
694 }
695 return( status );
696}
697#endif /* defined(MBEDTLS_ECP_C) */
698
Gilles Peskineb46bef22019-07-30 21:32:04 +0200699
700/** Return the size of the key in the given slot, in bits.
701 *
702 * \param[in] slot A key slot.
703 *
704 * \return The key size in bits, read from the metadata in the slot.
705 */
706static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
707{
708 return( slot->attr.bits );
709}
710
711/** Calculate the size of the key in the given slot, in bits.
712 *
713 * \param[in] slot A key slot containing a transparent key.
714 *
715 * \return The key size in bits, calculated from the key data.
716 */
717static size_t psa_calculate_key_bits( const psa_key_slot_t *slot )
718{
719 if( key_type_is_raw_bytes( slot->attr.type ) )
720 return( slot->data.raw.bytes * 8 );
721#if defined(MBEDTLS_RSA_C)
722 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
723 return( PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) ) );
724#endif /* defined(MBEDTLS_RSA_C) */
725#if defined(MBEDTLS_ECP_C)
726 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
727 return( slot->data.ecp->grp.pbits );
728#endif /* defined(MBEDTLS_ECP_C) */
729 /* Shouldn't happen except on an empty slot. */
730 return( 0 );
731}
732
Gilles Peskine8e338702019-07-30 20:06:31 +0200733/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100734 * previously. This function assumes that the slot does not contain
735 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100736psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
737 const uint8_t *data,
738 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100739{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200740 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100741
Gilles Peskine8e338702019-07-30 20:06:31 +0200742 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100743 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200744 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
745 /* Ensure that the bytes-to-bit conversion doesn't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100746 if( data_length > SIZE_MAX / 8 )
747 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine68cc433b2019-07-30 17:42:47 +0200748 /* Ensure that the bit size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200749 if( bit_size > PSA_MAX_KEY_BITS )
750 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine8e338702019-07-30 20:06:31 +0200751 status = prepare_raw_data_slot( slot->attr.type, bit_size,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200752 &slot->data.raw );
753 if( status != PSA_SUCCESS )
754 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200755 if( data_length != 0 )
756 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100757 }
758 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100759#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200760 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100761 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200762 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100763 data, data_length,
764 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100765 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200766 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000767 {
768 status = psa_import_ec_public_key(
Gilles Peskine8e338702019-07-30 20:06:31 +0200769 PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000770 data, data_length,
771 &slot->data.ecp );
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000772 }
Gilles Peskinef76aa772018-10-29 19:24:33 +0100773 else
774#endif /* MBEDTLS_ECP_C */
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000775#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200776 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100777 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200778 status = psa_import_rsa_key( slot->attr.type,
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000779 data, data_length,
780 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100781 }
782 else
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000783#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100784 {
785 return( PSA_ERROR_NOT_SUPPORTED );
786 }
Gilles Peskineb46bef22019-07-30 21:32:04 +0200787
788 if( status == PSA_SUCCESS )
789 {
790 /* Write the actual key size to the slot.
791 * psa_start_key_creation() wrote the size declared by the
792 * caller, which may be 0 (meaning unspecified) or wrong. */
793 slot->attr.bits = psa_calculate_key_bits( slot );
794 }
Jaeden Amero08ad3272019-01-14 13:12:39 +0000795 return( status );
Darryl Green940d72c2018-07-13 13:18:51 +0100796}
797
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100798/** Calculate the intersection of two algorithm usage policies.
799 *
800 * Return 0 (which allows no operation) on incompatibility.
801 */
802static psa_algorithm_t psa_key_policy_algorithm_intersection(
803 psa_algorithm_t alg1,
804 psa_algorithm_t alg2 )
805{
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200806 /* Common case: both sides actually specify the same policy. */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100807 if( alg1 == alg2 )
808 return( alg1 );
809 /* If the policies are from the same hash-and-sign family, check
Gilles Peskinef603c712019-01-19 13:40:11 +0100810 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100811 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
812 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
813 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
814 {
815 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
816 return( alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100817 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100818 return( alg1 );
819 }
820 /* If the policies are incompatible, allow nothing. */
821 return( 0 );
822}
823
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200824static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
825 psa_algorithm_t requested_alg )
826{
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200827 /* Common case: the policy only allows requested_alg. */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200828 if( requested_alg == policy_alg )
829 return( 1 );
830 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200831 * and requested_alg is the same hash-and-sign family with any hash,
832 * then requested_alg is compliant with policy_alg. */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200833 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
834 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
835 {
836 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
837 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
838 }
839 /* If it isn't permitted, it's forbidden. */
840 return( 0 );
841}
842
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100843/** Test whether a policy permits an algorithm.
844 *
845 * The caller must test usage flags separately.
846 */
847static int psa_key_policy_permits( const psa_key_policy_t *policy,
848 psa_algorithm_t alg )
849{
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200850 return( psa_key_algorithm_permits( policy->alg, alg ) ||
851 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100852}
853
Gilles Peskinef603c712019-01-19 13:40:11 +0100854/** Restrict a key policy based on a constraint.
855 *
856 * \param[in,out] policy The policy to restrict.
857 * \param[in] constraint The policy constraint to apply.
858 *
859 * \retval #PSA_SUCCESS
860 * \c *policy contains the intersection of the original value of
861 * \c *policy and \c *constraint.
862 * \retval #PSA_ERROR_INVALID_ARGUMENT
863 * \c *policy and \c *constraint are incompatible.
864 * \c *policy is unchanged.
865 */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100866static psa_status_t psa_restrict_key_policy(
867 psa_key_policy_t *policy,
868 const psa_key_policy_t *constraint )
869{
870 psa_algorithm_t intersection_alg =
871 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200872 psa_algorithm_t intersection_alg2 =
873 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100874 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
875 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200876 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
877 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100878 policy->usage &= constraint->usage;
Gilles Peskinef603c712019-01-19 13:40:11 +0100879 policy->alg = intersection_alg;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200880 policy->alg2 = intersection_alg2;
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100881 return( PSA_SUCCESS );
882}
883
Darryl Green06fd18d2018-07-16 11:21:11 +0100884/** Retrieve a slot which must contain a key. The key must have allow all the
885 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
886 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100887static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100888 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100889 psa_key_usage_t usage,
890 psa_algorithm_t alg )
891{
892 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100893 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100894
895 *p_slot = NULL;
896
Gilles Peskinec5487a82018-12-03 18:08:14 +0100897 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100898 if( status != PSA_SUCCESS )
899 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +0200900 if( slot->attr.type == PSA_KEY_TYPE_NONE )
David Saadab4ecc272019-02-14 13:48:10 +0200901 return( PSA_ERROR_DOES_NOT_EXIST );
Darryl Green06fd18d2018-07-16 11:21:11 +0100902
903 /* Enforce that usage policy for the key slot contains all the flags
904 * required by the usage parameter. There is one exception: public
905 * keys can always be exported, so we treat public key objects as
906 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200907 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +0200909 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +0100910 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100911
912 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200913 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100914 return( PSA_ERROR_NOT_PERMITTED );
915
916 *p_slot = slot;
917 return( PSA_SUCCESS );
918}
Darryl Green940d72c2018-07-13 13:18:51 +0100919
Gilles Peskine28f8f302019-07-24 13:30:31 +0200920/** Retrieve a slot which must contain a transparent key.
921 *
922 * A transparent key is a key for which the key material is directly
923 * available, as opposed to a key in a secure element.
924 *
Gilles Peskine60450a42019-07-25 11:32:45 +0200925 * This is a temporary function to use instead of psa_get_key_from_slot()
926 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200927 */
928#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
929static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
930 psa_key_slot_t **p_slot,
931 psa_key_usage_t usage,
932 psa_algorithm_t alg )
933{
934 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
935 if( status != PSA_SUCCESS )
936 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +0200937 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200938 {
939 *p_slot = NULL;
940 return( PSA_ERROR_NOT_SUPPORTED );
941 }
942 return( PSA_SUCCESS );
943}
944#else /* MBEDTLS_PSA_CRYPTO_SE_C */
945/* With no secure element support, all keys are transparent. */
946#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
947 psa_get_key_from_slot( handle, p_slot, usage, alg )
948#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
949
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100950/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100951static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000952{
Gilles Peskine73167e12019-07-12 23:44:37 +0200953#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
954 if( psa_key_slot_is_external( slot ) )
955 {
956 /* No key material to clean. */
957 }
958 else
959#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine8e338702019-07-30 20:06:31 +0200960 if( slot->attr.type == PSA_KEY_TYPE_NONE )
Darryl Green40225ba2018-11-15 14:48:15 +0000961 {
962 /* No key material to clean. */
963 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200964 else if( key_type_is_raw_bytes( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000965 {
966 mbedtls_free( slot->data.raw.data );
967 }
968 else
969#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200970 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000971 {
972 mbedtls_rsa_free( slot->data.rsa );
973 mbedtls_free( slot->data.rsa );
974 }
975 else
976#endif /* defined(MBEDTLS_RSA_C) */
977#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200978 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000979 {
980 mbedtls_ecp_keypair_free( slot->data.ecp );
981 mbedtls_free( slot->data.ecp );
982 }
983 else
984#endif /* defined(MBEDTLS_ECP_C) */
985 {
986 /* Shouldn't happen: the key type is not any type that we
987 * put in. */
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200988 return( PSA_ERROR_CORRUPTION_DETECTED );
Darryl Green40225ba2018-11-15 14:48:15 +0000989 }
990
991 return( PSA_SUCCESS );
992}
993
Gilles Peskine5f25dd02019-01-14 18:24:53 +0100994static void psa_abort_operations_using_key( psa_key_slot_t *slot )
995{
Gilles Peskinec88644d2019-04-12 15:03:38 +0200996 /*FIXME how to implement this?*/
Gilles Peskine5f25dd02019-01-14 18:24:53 +0100997 (void) slot;
998}
999
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001000/** Completely wipe a slot in memory, including its policy.
1001 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001002psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001003{
1004 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine5f25dd02019-01-14 18:24:53 +01001005 psa_abort_operations_using_key( slot );
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001006 /* At this point, key material and other type-specific content has
1007 * been wiped. Clear remaining metadata. We can call memset and not
1008 * zeroize because the metadata is not particularly sensitive. */
1009 memset( slot, 0, sizeof( *slot ) );
1010 return( status );
1011}
1012
Gilles Peskinec5487a82018-12-03 18:08:14 +01001013psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001014{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001015 psa_key_slot_t *slot;
Darryl Greend49a4992018-06-18 17:27:26 +01001016 psa_status_t status = PSA_SUCCESS;
1017 psa_status_t storage_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001018#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1019 psa_se_drv_table_entry_t *driver;
1020#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001021
Gilles Peskinec5487a82018-12-03 18:08:14 +01001022 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001023 if( status != PSA_SUCCESS )
1024 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001025
1026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001027 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001028 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001029 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001030 /* For a key in a secure element, we need to do three things:
1031 * remove the key file in internal storage, destroy the
1032 * key inside the secure element, and update the driver's
1033 * persistent data. Start a transaction that will encompass these
1034 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001035 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001036 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001037 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001038 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001039 status = psa_crypto_save_transaction( );
1040 if( status != PSA_SUCCESS )
1041 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001042 (void) psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02001043 /* TOnogrepDO: destroy what can be destroyed anyway */
1044 return( status );
1045 }
1046
Gilles Peskine354f7672019-07-12 23:46:38 +02001047 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskinefc762652019-07-22 19:30:34 +02001048 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001049#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1050
Darryl Greend49a4992018-06-18 17:27:26 +01001051#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001052 if( slot->attr.lifetime == PSA_KEY_LIFETIME_PERSISTENT )
Darryl Greend49a4992018-06-18 17:27:26 +01001053 {
Gilles Peskine69f976b2018-11-30 18:46:56 +01001054 storage_status =
Gilles Peskine8e338702019-07-30 20:06:31 +02001055 psa_destroy_persistent_key( slot->attr.id );
Darryl Greend49a4992018-06-18 17:27:26 +01001056 }
1057#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001058
Gilles Peskinefc762652019-07-22 19:30:34 +02001059#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1060 if( driver != NULL )
1061 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001062 psa_status_t status2;
1063 status = psa_save_se_persistent_data( driver );
1064 status2 = psa_crypto_stop_transaction( );
1065 if( status == PSA_SUCCESS )
1066 status = status2;
Gilles Peskinefc762652019-07-22 19:30:34 +02001067 if( status != PSA_SUCCESS )
1068 {
1069 /* TOnogrepDO: destroy what can be destroyed anyway */
1070 return( status );
1071 }
1072 }
1073#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1074
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001075 status = psa_wipe_key_slot( slot );
Darryl Greend49a4992018-06-18 17:27:26 +01001076 if( status != PSA_SUCCESS )
1077 return( status );
1078 return( storage_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001079}
1080
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001081void psa_reset_key_attributes( psa_key_attributes_t *attributes )
1082{
Gilles Peskineb699f072019-04-26 16:06:02 +02001083 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001084 memset( attributes, 0, sizeof( *attributes ) );
1085}
1086
Gilles Peskineb699f072019-04-26 16:06:02 +02001087psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1088 psa_key_type_t type,
1089 const uint8_t *data,
1090 size_t data_length )
1091{
1092 uint8_t *copy = NULL;
1093
1094 if( data_length != 0 )
1095 {
1096 copy = mbedtls_calloc( 1, data_length );
1097 if( copy == NULL )
1098 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1099 memcpy( copy, data, data_length );
1100 }
1101 /* After this point, this function is guaranteed to succeed, so it
1102 * can start modifying `*attributes`. */
1103
1104 if( attributes->domain_parameters != NULL )
1105 {
1106 mbedtls_free( attributes->domain_parameters );
1107 attributes->domain_parameters = NULL;
1108 attributes->domain_parameters_size = 0;
1109 }
1110
1111 attributes->domain_parameters = copy;
1112 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001113 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001114 return( PSA_SUCCESS );
1115}
1116
1117psa_status_t psa_get_key_domain_parameters(
1118 const psa_key_attributes_t *attributes,
1119 uint8_t *data, size_t data_size, size_t *data_length )
1120{
1121 if( attributes->domain_parameters_size > data_size )
1122 return( PSA_ERROR_BUFFER_TOO_SMALL );
1123 *data_length = attributes->domain_parameters_size;
1124 if( attributes->domain_parameters_size != 0 )
1125 memcpy( data, attributes->domain_parameters,
1126 attributes->domain_parameters_size );
1127 return( PSA_SUCCESS );
1128}
1129
1130#if defined(MBEDTLS_RSA_C)
1131static psa_status_t psa_get_rsa_public_exponent(
1132 const mbedtls_rsa_context *rsa,
1133 psa_key_attributes_t *attributes )
1134{
1135 mbedtls_mpi mpi;
1136 int ret;
1137 uint8_t *buffer = NULL;
1138 size_t buflen;
1139 mbedtls_mpi_init( &mpi );
1140
1141 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1142 if( ret != 0 )
1143 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001144 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1145 {
1146 /* It's the default value, which is reported as an empty string,
1147 * so there's nothing to do. */
1148 goto exit;
1149 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001150
1151 buflen = mbedtls_mpi_size( &mpi );
1152 buffer = mbedtls_calloc( 1, buflen );
1153 if( buffer == NULL )
1154 {
1155 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1156 goto exit;
1157 }
1158 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1159 if( ret != 0 )
1160 goto exit;
1161 attributes->domain_parameters = buffer;
1162 attributes->domain_parameters_size = buflen;
1163
1164exit:
1165 mbedtls_mpi_free( &mpi );
1166 if( ret != 0 )
1167 mbedtls_free( buffer );
1168 return( mbedtls_to_psa_error( ret ) );
1169}
1170#endif /* MBEDTLS_RSA_C */
1171
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001172/** Retrieve the generic attributes of a key in a slot.
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001173 *
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001174 * This function does not retrieve domain parameters, which require
1175 * additional memory management.
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001176 */
1177static void psa_get_key_slot_attributes( psa_key_slot_t *slot,
1178 psa_key_attributes_t *attributes )
1179{
Gilles Peskine8e338702019-07-30 20:06:31 +02001180 attributes->core.id = slot->attr.id;
1181 attributes->core.lifetime = slot->attr.lifetime;
1182 attributes->core.policy = slot->attr.policy;
1183 attributes->core.type = slot->attr.type;
Gilles Peskineb46bef22019-07-30 21:32:04 +02001184 attributes->core.bits = slot->attr.bits;
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001185}
1186
1187/** Retrieve all the publicly-accessible attributes of a key.
1188 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001189psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1190 psa_key_attributes_t *attributes )
1191{
1192 psa_key_slot_t *slot;
1193 psa_status_t status;
1194
1195 psa_reset_key_attributes( attributes );
1196
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001197 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001198 if( status != PSA_SUCCESS )
1199 return( status );
1200
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001201 psa_get_key_slot_attributes( slot, attributes );
Gilles Peskineb699f072019-04-26 16:06:02 +02001202
Gilles Peskine8e338702019-07-30 20:06:31 +02001203 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001204 {
1205#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001206 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001207 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001208#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1209 /* TOnogrepDO: reporting the public exponent for opaque keys
1210 * is not yet implemented. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001211 if( psa_get_se_driver( slot->attr.lifetime, NULL, NULL ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001212 break;
1213#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001214 status = psa_get_rsa_public_exponent( slot->data.rsa, attributes );
1215 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001216#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001217 default:
1218 /* Nothing else to do. */
1219 break;
1220 }
1221
1222 if( status != PSA_SUCCESS )
1223 psa_reset_key_attributes( attributes );
1224 return( status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001225}
1226
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001227#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero6b196002019-01-10 10:23:21 +00001228static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1229 unsigned char *buf, size_t size )
1230{
1231 int ret;
1232 unsigned char *c;
1233 size_t len = 0;
1234
1235 c = buf + size;
1236
1237 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1238
1239 return( (int) len );
1240}
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001241#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero6b196002019-01-10 10:23:21 +00001242
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001243static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1244 uint8_t *data,
1245 size_t data_size,
1246 size_t *data_length,
1247 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001248{
Gilles Peskine5d309672019-07-12 23:47:28 +02001249#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1250 const psa_drv_se_t *drv;
1251 psa_drv_se_context_t *drv_context;
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1253
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001254 *data_length = 0;
1255
Gilles Peskine8e338702019-07-30 20:06:31 +02001256 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001257 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001258
Gilles Peskine5d309672019-07-12 23:47:28 +02001259#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001260 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001261 {
1262 psa_drv_se_export_key_t method;
1263 if( drv->key_management == NULL )
1264 return( PSA_ERROR_NOT_SUPPORTED );
1265 method = ( export_public_key ?
1266 drv->key_management->p_export_public :
1267 drv->key_management->p_export );
1268 if( method == NULL )
1269 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001270 return( method( drv_context,
1271 slot->data.se.slot_number,
1272 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001273 }
1274#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1275
Gilles Peskine8e338702019-07-30 20:06:31 +02001276 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001277 {
1278 if( slot->data.raw.bytes > data_size )
1279 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine52b90182018-10-29 19:26:27 +01001280 if( data_size != 0 )
1281 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001282 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
Gilles Peskine52b90182018-10-29 19:26:27 +01001283 memset( data + slot->data.raw.bytes, 0,
1284 data_size - slot->data.raw.bytes );
1285 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001286 *data_length = slot->data.raw.bytes;
1287 return( PSA_SUCCESS );
1288 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001289#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001290 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) && !export_public_key )
Gilles Peskine188c71e2018-10-29 19:26:02 +01001291 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001292 psa_status_t status;
1293
Gilles Peskineb46bef22019-07-30 21:32:04 +02001294 size_t bytes = PSA_BITS_TO_BYTES( slot->attr.bits );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001295 if( bytes > data_size )
1296 return( PSA_ERROR_BUFFER_TOO_SMALL );
1297 status = mbedtls_to_psa_error(
1298 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1299 if( status != PSA_SUCCESS )
1300 return( status );
1301 memset( data + bytes, 0, data_size - bytes );
1302 *data_length = bytes;
1303 return( PSA_SUCCESS );
1304 }
1305#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001306 else
Moran Peker17e36e12018-05-02 12:55:20 +03001307 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001308#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001309 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1310 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001311 {
Moran Pekera998bc62018-04-16 18:16:20 +03001312 mbedtls_pk_context pk;
1313 int ret;
Gilles Peskine8e338702019-07-30 20:06:31 +02001314 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001315 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001316#if defined(MBEDTLS_RSA_C)
1317 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001318 pk.pk_info = &mbedtls_rsa_info;
1319 pk.pk_ctx = slot->data.rsa;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001320#else
1321 return( PSA_ERROR_NOT_SUPPORTED );
1322#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001323 }
1324 else
1325 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001326#if defined(MBEDTLS_ECP_C)
1327 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001328 pk.pk_info = &mbedtls_eckey_info;
1329 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001330#else
1331 return( PSA_ERROR_NOT_SUPPORTED );
1332#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001333 }
Gilles Peskine8e338702019-07-30 20:06:31 +02001334 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero6b196002019-01-10 10:23:21 +00001335 {
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001336 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero6b196002019-01-10 10:23:21 +00001337 }
Moran Peker17e36e12018-05-02 12:55:20 +03001338 else
Jaeden Amero6b196002019-01-10 10:23:21 +00001339 {
Moran Peker17e36e12018-05-02 12:55:20 +03001340 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero6b196002019-01-10 10:23:21 +00001341 }
Moran Peker60364322018-04-29 11:34:58 +03001342 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001343 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001344 /* If data_size is 0 then data may be NULL and then the
1345 * call to memset would have undefined behavior. */
1346 if( data_size != 0 )
1347 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001348 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001349 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001350 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1351 * Move the data to the beginning and erase remaining data
1352 * at the original location. */
1353 if( 2 * (size_t) ret <= data_size )
1354 {
1355 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001356 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001357 }
1358 else if( (size_t) ret < data_size )
1359 {
1360 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001361 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001362 }
Moran Pekera998bc62018-04-16 18:16:20 +03001363 *data_length = ret;
1364 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001365 }
1366 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001367#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001368 {
1369 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001370 it is valid for a special-purpose implementation to omit
1371 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001372 return( PSA_ERROR_NOT_SUPPORTED );
1373 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001374 }
1375}
1376
Gilles Peskinec5487a82018-12-03 18:08:14 +01001377psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001378 uint8_t *data,
1379 size_t data_size,
1380 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001381{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001382 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001383 psa_status_t status;
1384
1385 /* Set the key to empty now, so that even when there are errors, we always
1386 * set data_length to a value between 0 and data_size. On error, setting
1387 * the key to empty is a good choice because an empty key representation is
1388 * unlikely to be accepted anywhere. */
1389 *data_length = 0;
1390
1391 /* Export requires the EXPORT flag. There is an exception for public keys,
1392 * which don't require any flag, but psa_get_key_from_slot takes
1393 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001394 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001395 if( status != PSA_SUCCESS )
1396 return( status );
1397 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001398 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001399}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001400
Gilles Peskinec5487a82018-12-03 18:08:14 +01001401psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001402 uint8_t *data,
1403 size_t data_size,
1404 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001405{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001406 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001407 psa_status_t status;
1408
1409 /* Set the key to empty now, so that even when there are errors, we always
1410 * set data_length to a value between 0 and data_size. On error, setting
1411 * the key to empty is a good choice because an empty key representation is
1412 * unlikely to be accepted anywhere. */
1413 *data_length = 0;
1414
1415 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001416 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001417 if( status != PSA_SUCCESS )
1418 return( status );
1419 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001420 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001421}
1422
Gilles Peskine4747d192019-04-17 15:05:45 +02001423static psa_status_t psa_set_key_policy_internal(
1424 psa_key_slot_t *slot,
1425 const psa_key_policy_t *policy )
1426{
1427 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001428 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001429 PSA_KEY_USAGE_ENCRYPT |
1430 PSA_KEY_USAGE_DECRYPT |
1431 PSA_KEY_USAGE_SIGN |
1432 PSA_KEY_USAGE_VERIFY |
1433 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1434 return( PSA_ERROR_INVALID_ARGUMENT );
1435
Gilles Peskine8e338702019-07-30 20:06:31 +02001436 slot->attr.policy = *policy;
Gilles Peskine4747d192019-04-17 15:05:45 +02001437 return( PSA_SUCCESS );
1438}
1439
1440/** Prepare a key slot to receive key material.
1441 *
1442 * This function allocates a key slot and sets its metadata.
1443 *
1444 * If this function fails, call psa_fail_key_creation().
1445 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001446 * This function is intended to be used as follows:
1447 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1448 * it with the specified attributes, and assign it a handle.
1449 * -# Populate the slot with the key material.
1450 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1451 * In case of failure at any step, stop the sequence and call
1452 * psa_fail_key_creation().
1453 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001454 * \param[in] attributes Key attributes for the new key.
1455 * \param[out] handle On success, a handle for the allocated slot.
1456 * \param[out] p_slot On success, a pointer to the prepared slot.
1457 * \param[out] p_drv On any return, the driver for the key, if any.
1458 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001459 *
1460 * \retval #PSA_SUCCESS
1461 * The key slot is ready to receive key material.
1462 * \return If this function fails, the key slot is an invalid state.
1463 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001464 */
1465static psa_status_t psa_start_key_creation(
1466 const psa_key_attributes_t *attributes,
1467 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001468 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001469 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001470{
1471 psa_status_t status;
1472 psa_key_slot_t *slot;
1473
Gilles Peskine011e4282019-06-26 18:34:38 +02001474 *p_drv = NULL;
1475
Gilles Peskine267c6562019-05-27 19:01:54 +02001476 status = psa_internal_allocate_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001477 if( status != PSA_SUCCESS )
1478 return( status );
1479 slot = *p_slot;
1480
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001481 status = psa_set_key_policy_internal( slot, &attributes->core.policy );
Gilles Peskine4747d192019-04-17 15:05:45 +02001482 if( status != PSA_SUCCESS )
1483 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02001484 slot->attr.lifetime = attributes->core.lifetime;
Gilles Peskine011e4282019-06-26 18:34:38 +02001485
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001486 if( attributes->core.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskined167b942019-04-19 18:19:40 +02001487 {
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001488 status = psa_validate_persistent_key_parameters( attributes->core.lifetime,
1489 attributes->core.id,
Gilles Peskine011e4282019-06-26 18:34:38 +02001490 p_drv, 1 );
Gilles Peskined167b942019-04-19 18:19:40 +02001491 if( status != PSA_SUCCESS )
1492 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02001493 slot->attr.id = attributes->core.id;
Gilles Peskined167b942019-04-19 18:19:40 +02001494 }
Gilles Peskine8e338702019-07-30 20:06:31 +02001495 slot->attr.type = attributes->core.type;
Gilles Peskine4747d192019-04-17 15:05:45 +02001496
Gilles Peskinec744d992019-07-30 17:26:54 +02001497 /* Refuse to create overly large keys.
1498 * Note that this doesn't trigger on import if the attributes don't
1499 * explicitly specify a size (so psa_get_key_bits returns 0), so
1500 * psa_import_key() needs its own checks. */
1501 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1502 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001503 /* Store the declared bit-size of the key. It's up to each creation
1504 * mechanism to verify that this information is correct. It's
1505 * automatically correct for mechanisms that use the bit-size as
1506 * an input (generate, device) but not for those where the bit-size
1507 * is optional (import, copy). */
1508 slot->attr.bits = psa_get_key_bits( attributes );
Gilles Peskinec744d992019-07-30 17:26:54 +02001509
Gilles Peskinecbaff462019-07-12 23:46:04 +02001510#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine60450a42019-07-25 11:32:45 +02001511 /* For a key in a secure element, we need to do three things:
1512 * create the key file in internal storage, create the
1513 * key inside the secure element, and update the driver's
1514 * persistent data. Start a transaction that will encompass these
1515 * three actions. */
1516 /* The first thing to do is to find a slot number for the new key.
1517 * We save the slot number in persistent storage as part of the
1518 * transaction data. It will be needed to recover if the power
1519 * fails during the key creation process, to clean up on the secure
1520 * element side after restarting. Obtaining a slot number from the
1521 * secure element driver updates its persistent state, but we do not yet
1522 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001523 * we can roll back to a state where the key doesn't exist. */
Gilles Peskinecbaff462019-07-12 23:46:04 +02001524 if( *p_drv != NULL )
1525 {
1526 status = psa_find_se_slot_for_key( attributes, *p_drv,
1527 &slot->data.se.slot_number );
1528 if( status != PSA_SUCCESS )
1529 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001530 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001531 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001532 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001533 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001534 status = psa_crypto_save_transaction( );
1535 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001536 {
1537 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001538 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001539 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001540 }
1541#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1542
Gilles Peskine4747d192019-04-17 15:05:45 +02001543 return( status );
1544}
1545
1546/** Finalize the creation of a key once its key material has been set.
1547 *
1548 * This entails writing the key to persistent storage.
1549 *
1550 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001551 * See the documentation of psa_start_key_creation() for the intended use
1552 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001553 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001554 * \param[in,out] slot Pointer to the slot with key material.
1555 * \param[in] driver The secure element driver for the key,
1556 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001557 *
1558 * \retval #PSA_SUCCESS
1559 * The key was successfully created. The handle is now valid.
1560 * \return If this function fails, the key slot is an invalid state.
1561 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001562 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001563static psa_status_t psa_finish_key_creation(
1564 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001565 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001566{
1567 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001568 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001569 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001570
1571#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001572 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001573 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001574 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1575 psa_get_key_slot_attributes( slot, &attributes );
Gilles Peskine4747d192019-04-17 15:05:45 +02001576
Gilles Peskine1df83d42019-07-23 16:13:14 +02001577#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1578 if( driver != NULL )
1579 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001580 psa_se_key_data_storage_t data;
1581#if defined(static_assert)
1582 static_assert( sizeof( slot->data.se.slot_number ) ==
1583 sizeof( data.slot_number ),
1584 "Slot number size does not match psa_se_key_data_storage_t" );
1585 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1586 "Bit-size size does not match psa_se_key_data_storage_t" );
1587#endif
1588 memcpy( &data.slot_number, &slot->data.se.slot_number,
1589 sizeof( slot->data.se.slot_number ) );
1590 memcpy( &data.bits, &slot->attr.bits,
1591 sizeof( slot->attr.bits ) );
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001592 status = psa_save_persistent_key( &attributes.core,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001593 (uint8_t*) &data,
1594 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001595 }
1596 else
1597#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1598 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001599 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001600 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001601 psa_get_key_bits( &attributes ) );
1602 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1603 size_t length = 0;
Gilles Peskine1df83d42019-07-23 16:13:14 +02001604 if( buffer == NULL && buffer_size != 0 )
1605 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1606 status = psa_internal_export_key( slot,
1607 buffer, buffer_size, &length,
1608 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001609 if( status == PSA_SUCCESS )
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001610 status = psa_save_persistent_key( &attributes.core,
1611 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001612
Gilles Peskine1df83d42019-07-23 16:13:14 +02001613 if( buffer_size != 0 )
1614 mbedtls_platform_zeroize( buffer, buffer_size );
1615 mbedtls_free( buffer );
1616 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001617 }
1618#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1619
Gilles Peskinecbaff462019-07-12 23:46:04 +02001620#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1621 if( driver != NULL )
1622 {
1623 status = psa_save_se_persistent_data( driver );
1624 if( status != PSA_SUCCESS )
1625 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001626 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001627 return( status );
1628 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001629 status = psa_crypto_stop_transaction( );
1630 if( status != PSA_SUCCESS )
1631 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001632 }
1633#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1634
Gilles Peskine4747d192019-04-17 15:05:45 +02001635 return( status );
1636}
1637
1638/** Abort the creation of a key.
1639 *
1640 * You may call this function after calling psa_start_key_creation(),
1641 * or after psa_finish_key_creation() fails. In other circumstances, this
1642 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001643 * See the documentation of psa_start_key_creation() for the intended use
1644 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001645 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001646 * \param[in,out] slot Pointer to the slot with key material.
1647 * \param[in] driver The secure element driver for the key,
1648 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001649 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001650static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001651 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001652{
Gilles Peskine011e4282019-06-26 18:34:38 +02001653 (void) driver;
1654
Gilles Peskine4747d192019-04-17 15:05:45 +02001655 if( slot == NULL )
1656 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001657
1658#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1659 /* TOnogrepDO: If the key has already been created in the secure
1660 * element, and the failure happened later (when saving metadata
1661 * to internal storage), we need to destroy the key in the secure
1662 * element. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001663
1664 /* Abort the ongoing transaction if any. We already did what it
1665 * takes to undo any partial creation. All that's left is to update
1666 * the transaction data itself. */
1667 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001668#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1669
Gilles Peskine4747d192019-04-17 15:05:45 +02001670 psa_wipe_key_slot( slot );
1671}
1672
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001673static psa_status_t psa_check_key_slot_attributes(
1674 const psa_key_slot_t *slot,
1675 const psa_key_attributes_t *attributes )
1676{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001677 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001678 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001679 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001680 return( PSA_ERROR_INVALID_ARGUMENT );
1681 }
1682
1683 if( attributes->domain_parameters_size != 0 )
1684 {
1685#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001686 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001687 {
1688 mbedtls_mpi actual, required;
1689 int ret;
1690 mbedtls_mpi_init( &actual );
1691 mbedtls_mpi_init( &required );
1692 ret = mbedtls_rsa_export( slot->data.rsa,
1693 NULL, NULL, NULL, NULL, &actual );
1694 if( ret != 0 )
1695 goto rsa_exit;
1696 ret = mbedtls_mpi_read_binary( &required,
1697 attributes->domain_parameters,
1698 attributes->domain_parameters_size );
1699 if( ret != 0 )
1700 goto rsa_exit;
1701 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1702 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1703 rsa_exit:
1704 mbedtls_mpi_free( &actual );
1705 mbedtls_mpi_free( &required );
1706 if( ret != 0)
1707 return( mbedtls_to_psa_error( ret ) );
1708 }
1709 else
1710#endif
1711 {
1712 return( PSA_ERROR_INVALID_ARGUMENT );
1713 }
1714 }
1715
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001716 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001717 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001719 return( PSA_ERROR_INVALID_ARGUMENT );
1720 }
1721
1722 return( PSA_SUCCESS );
1723}
1724
Gilles Peskine4747d192019-04-17 15:05:45 +02001725psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001727 size_t data_length,
1728 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001729{
1730 psa_status_t status;
1731 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001732 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001733
Gilles Peskine011e4282019-06-26 18:34:38 +02001734 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001735 if( status != PSA_SUCCESS )
1736 goto exit;
1737
Gilles Peskine5d309672019-07-12 23:47:28 +02001738#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1739 if( driver != NULL )
1740 {
1741 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001742 size_t bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001743 if( drv->key_management == NULL ||
1744 drv->key_management->p_import == NULL )
1745 {
1746 status = PSA_ERROR_NOT_SUPPORTED;
1747 goto exit;
1748 }
1749 status = drv->key_management->p_import(
1750 psa_get_se_driver_context( driver ),
1751 slot->data.se.slot_number,
Gilles Peskine8e338702019-07-30 20:06:31 +02001752 slot->attr.lifetime, slot->attr.type,
1753 slot->attr.policy.alg, slot->attr.policy.usage,
Gilles Peskine18017402019-07-24 20:25:59 +02001754 data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001755 &bits );
1756 if( status != PSA_SUCCESS )
1757 goto exit;
1758 if( bits > PSA_MAX_KEY_BITS )
1759 {
1760 status = PSA_ERROR_NOT_SUPPORTED;
1761 goto exit;
1762 }
1763 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001764 }
1765 else
1766#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1767 {
1768 status = psa_import_key_into_slot( slot, data, data_length );
1769 if( status != PSA_SUCCESS )
1770 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001771 }
Gilles Peskine18017402019-07-24 20:25:59 +02001772 status = psa_check_key_slot_attributes( slot, attributes );
1773 if( status != PSA_SUCCESS )
1774 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001775
Gilles Peskine011e4282019-06-26 18:34:38 +02001776 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001777exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 if( status != PSA_SUCCESS )
1779 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001780 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 *handle = 0;
1782 }
1783 return( status );
1784}
1785
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001786static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001787 psa_key_slot_t *target )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001788{
1789 psa_status_t status;
1790 uint8_t *buffer = NULL;
1791 size_t buffer_size = 0;
1792 size_t length;
1793
Gilles Peskine8e338702019-07-30 20:06:31 +02001794 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001795 psa_get_key_slot_bits( source ) );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001796 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001797 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001798 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001799 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1800 if( status != PSA_SUCCESS )
1801 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001802 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001803 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001804
1805exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001806 if( buffer_size != 0 )
1807 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001808 mbedtls_free( buffer );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001809 return( status );
1810}
1811
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001812psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1813 const psa_key_attributes_t *specified_attributes,
1814 psa_key_handle_t *target_handle )
1815{
1816 psa_status_t status;
1817 psa_key_slot_t *source_slot = NULL;
1818 psa_key_slot_t *target_slot = NULL;
1819 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001820 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001821
Gilles Peskine28f8f302019-07-24 13:30:31 +02001822 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001823 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001824 if( status != PSA_SUCCESS )
1825 goto exit;
1826
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001827 status = psa_check_key_slot_attributes( source_slot, specified_attributes );
1828 if( status != PSA_SUCCESS )
1829 goto exit;
1830
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001831 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001832 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001833 if( status != PSA_SUCCESS )
1834 goto exit;
1835
1836 status = psa_start_key_creation( &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001837 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001838 if( status != PSA_SUCCESS )
1839 goto exit;
1840
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001841#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1842 if( driver != NULL )
1843 {
1844 /* Copying to a secure element is not implemented yet. */
1845 status = PSA_ERROR_NOT_SUPPORTED;
1846 goto exit;
1847 }
1848#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1849
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001850 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001851 if( status != PSA_SUCCESS )
1852 goto exit;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001853
Gilles Peskine011e4282019-06-26 18:34:38 +02001854 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001855exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001856 if( status != PSA_SUCCESS )
1857 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001858 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001859 *target_handle = 0;
1860 }
1861 return( status );
1862}
1863
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001864
1865
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001866/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001867/* Message digests */
1868/****************************************************************/
1869
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001870static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001871{
1872 switch( alg )
1873 {
1874#if defined(MBEDTLS_MD2_C)
1875 case PSA_ALG_MD2:
1876 return( &mbedtls_md2_info );
1877#endif
1878#if defined(MBEDTLS_MD4_C)
1879 case PSA_ALG_MD4:
1880 return( &mbedtls_md4_info );
1881#endif
1882#if defined(MBEDTLS_MD5_C)
1883 case PSA_ALG_MD5:
1884 return( &mbedtls_md5_info );
1885#endif
1886#if defined(MBEDTLS_RIPEMD160_C)
1887 case PSA_ALG_RIPEMD160:
1888 return( &mbedtls_ripemd160_info );
1889#endif
1890#if defined(MBEDTLS_SHA1_C)
1891 case PSA_ALG_SHA_1:
1892 return( &mbedtls_sha1_info );
1893#endif
1894#if defined(MBEDTLS_SHA256_C)
1895 case PSA_ALG_SHA_224:
1896 return( &mbedtls_sha224_info );
1897 case PSA_ALG_SHA_256:
1898 return( &mbedtls_sha256_info );
1899#endif
1900#if defined(MBEDTLS_SHA512_C)
1901 case PSA_ALG_SHA_384:
1902 return( &mbedtls_sha384_info );
1903 case PSA_ALG_SHA_512:
1904 return( &mbedtls_sha512_info );
1905#endif
1906 default:
1907 return( NULL );
1908 }
1909}
1910
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001911psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
1912{
1913 switch( operation->alg )
1914 {
Gilles Peskine81736312018-06-26 15:04:31 +02001915 case 0:
1916 /* The object has (apparently) been initialized but it is not
1917 * in use. It's ok to call abort on such an object, and there's
1918 * nothing to do. */
1919 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001920#if defined(MBEDTLS_MD2_C)
1921 case PSA_ALG_MD2:
1922 mbedtls_md2_free( &operation->ctx.md2 );
1923 break;
1924#endif
1925#if defined(MBEDTLS_MD4_C)
1926 case PSA_ALG_MD4:
1927 mbedtls_md4_free( &operation->ctx.md4 );
1928 break;
1929#endif
1930#if defined(MBEDTLS_MD5_C)
1931 case PSA_ALG_MD5:
1932 mbedtls_md5_free( &operation->ctx.md5 );
1933 break;
1934#endif
1935#if defined(MBEDTLS_RIPEMD160_C)
1936 case PSA_ALG_RIPEMD160:
1937 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
1938 break;
1939#endif
1940#if defined(MBEDTLS_SHA1_C)
1941 case PSA_ALG_SHA_1:
1942 mbedtls_sha1_free( &operation->ctx.sha1 );
1943 break;
1944#endif
1945#if defined(MBEDTLS_SHA256_C)
1946 case PSA_ALG_SHA_224:
1947 case PSA_ALG_SHA_256:
1948 mbedtls_sha256_free( &operation->ctx.sha256 );
1949 break;
1950#endif
1951#if defined(MBEDTLS_SHA512_C)
1952 case PSA_ALG_SHA_384:
1953 case PSA_ALG_SHA_512:
1954 mbedtls_sha512_free( &operation->ctx.sha512 );
1955 break;
1956#endif
1957 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02001958 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001959 }
1960 operation->alg = 0;
1961 return( PSA_SUCCESS );
1962}
1963
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02001964psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001965 psa_algorithm_t alg )
1966{
1967 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001968
1969 /* A context must be freshly initialized before it can be set up. */
1970 if( operation->alg != 0 )
1971 {
1972 return( PSA_ERROR_BAD_STATE );
1973 }
1974
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001975 switch( alg )
1976 {
1977#if defined(MBEDTLS_MD2_C)
1978 case PSA_ALG_MD2:
1979 mbedtls_md2_init( &operation->ctx.md2 );
1980 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
1981 break;
1982#endif
1983#if defined(MBEDTLS_MD4_C)
1984 case PSA_ALG_MD4:
1985 mbedtls_md4_init( &operation->ctx.md4 );
1986 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
1987 break;
1988#endif
1989#if defined(MBEDTLS_MD5_C)
1990 case PSA_ALG_MD5:
1991 mbedtls_md5_init( &operation->ctx.md5 );
1992 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
1993 break;
1994#endif
1995#if defined(MBEDTLS_RIPEMD160_C)
1996 case PSA_ALG_RIPEMD160:
1997 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
1998 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
1999 break;
2000#endif
2001#if defined(MBEDTLS_SHA1_C)
2002 case PSA_ALG_SHA_1:
2003 mbedtls_sha1_init( &operation->ctx.sha1 );
2004 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2005 break;
2006#endif
2007#if defined(MBEDTLS_SHA256_C)
2008 case PSA_ALG_SHA_224:
2009 mbedtls_sha256_init( &operation->ctx.sha256 );
2010 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2011 break;
2012 case PSA_ALG_SHA_256:
2013 mbedtls_sha256_init( &operation->ctx.sha256 );
2014 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2015 break;
2016#endif
2017#if defined(MBEDTLS_SHA512_C)
2018 case PSA_ALG_SHA_384:
2019 mbedtls_sha512_init( &operation->ctx.sha512 );
2020 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2021 break;
2022 case PSA_ALG_SHA_512:
2023 mbedtls_sha512_init( &operation->ctx.sha512 );
2024 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2025 break;
2026#endif
2027 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002028 return( PSA_ALG_IS_HASH( alg ) ?
2029 PSA_ERROR_NOT_SUPPORTED :
2030 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002031 }
2032 if( ret == 0 )
2033 operation->alg = alg;
2034 else
2035 psa_hash_abort( operation );
2036 return( mbedtls_to_psa_error( ret ) );
2037}
2038
2039psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2040 const uint8_t *input,
2041 size_t input_length )
2042{
2043 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002044
2045 /* Don't require hash implementations to behave correctly on a
2046 * zero-length input, which may have an invalid pointer. */
2047 if( input_length == 0 )
2048 return( PSA_SUCCESS );
2049
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002050 switch( operation->alg )
2051 {
2052#if defined(MBEDTLS_MD2_C)
2053 case PSA_ALG_MD2:
2054 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2055 input, input_length );
2056 break;
2057#endif
2058#if defined(MBEDTLS_MD4_C)
2059 case PSA_ALG_MD4:
2060 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2061 input, input_length );
2062 break;
2063#endif
2064#if defined(MBEDTLS_MD5_C)
2065 case PSA_ALG_MD5:
2066 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2067 input, input_length );
2068 break;
2069#endif
2070#if defined(MBEDTLS_RIPEMD160_C)
2071 case PSA_ALG_RIPEMD160:
2072 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2073 input, input_length );
2074 break;
2075#endif
2076#if defined(MBEDTLS_SHA1_C)
2077 case PSA_ALG_SHA_1:
2078 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2079 input, input_length );
2080 break;
2081#endif
2082#if defined(MBEDTLS_SHA256_C)
2083 case PSA_ALG_SHA_224:
2084 case PSA_ALG_SHA_256:
2085 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2086 input, input_length );
2087 break;
2088#endif
2089#if defined(MBEDTLS_SHA512_C)
2090 case PSA_ALG_SHA_384:
2091 case PSA_ALG_SHA_512:
2092 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2093 input, input_length );
2094 break;
2095#endif
2096 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002097 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002098 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002099
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002100 if( ret != 0 )
2101 psa_hash_abort( operation );
2102 return( mbedtls_to_psa_error( ret ) );
2103}
2104
2105psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2106 uint8_t *hash,
2107 size_t hash_size,
2108 size_t *hash_length )
2109{
itayzafrir40835d42018-08-02 13:14:17 +03002110 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002111 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002112 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002113
2114 /* Fill the output buffer with something that isn't a valid hash
2115 * (barring an attack on the hash and deliberately-crafted input),
2116 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002117 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002118 /* If hash_size is 0 then hash may be NULL and then the
2119 * call to memset would have undefined behavior. */
2120 if( hash_size != 0 )
2121 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002122
2123 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002124 {
2125 status = PSA_ERROR_BUFFER_TOO_SMALL;
2126 goto exit;
2127 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002128
2129 switch( operation->alg )
2130 {
2131#if defined(MBEDTLS_MD2_C)
2132 case PSA_ALG_MD2:
2133 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2134 break;
2135#endif
2136#if defined(MBEDTLS_MD4_C)
2137 case PSA_ALG_MD4:
2138 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2139 break;
2140#endif
2141#if defined(MBEDTLS_MD5_C)
2142 case PSA_ALG_MD5:
2143 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2144 break;
2145#endif
2146#if defined(MBEDTLS_RIPEMD160_C)
2147 case PSA_ALG_RIPEMD160:
2148 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2149 break;
2150#endif
2151#if defined(MBEDTLS_SHA1_C)
2152 case PSA_ALG_SHA_1:
2153 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2154 break;
2155#endif
2156#if defined(MBEDTLS_SHA256_C)
2157 case PSA_ALG_SHA_224:
2158 case PSA_ALG_SHA_256:
2159 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2160 break;
2161#endif
2162#if defined(MBEDTLS_SHA512_C)
2163 case PSA_ALG_SHA_384:
2164 case PSA_ALG_SHA_512:
2165 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2166 break;
2167#endif
2168 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002169 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002170 }
itayzafrir40835d42018-08-02 13:14:17 +03002171 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002172
itayzafrir40835d42018-08-02 13:14:17 +03002173exit:
2174 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002175 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002176 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 return( psa_hash_abort( operation ) );
2178 }
2179 else
2180 {
2181 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002182 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183 }
2184}
2185
Gilles Peskine2d277862018-06-18 15:41:12 +02002186psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2187 const uint8_t *hash,
2188 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002189{
2190 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2191 size_t actual_hash_length;
2192 psa_status_t status = psa_hash_finish( operation,
2193 actual_hash, sizeof( actual_hash ),
2194 &actual_hash_length );
2195 if( status != PSA_SUCCESS )
2196 return( status );
2197 if( actual_hash_length != hash_length )
2198 return( PSA_ERROR_INVALID_SIGNATURE );
2199 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2200 return( PSA_ERROR_INVALID_SIGNATURE );
2201 return( PSA_SUCCESS );
2202}
2203
Gilles Peskineeb35d782019-01-22 17:56:16 +01002204psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2205 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002206{
2207 if( target_operation->alg != 0 )
2208 return( PSA_ERROR_BAD_STATE );
2209
2210 switch( source_operation->alg )
2211 {
2212 case 0:
2213 return( PSA_ERROR_BAD_STATE );
2214#if defined(MBEDTLS_MD2_C)
2215 case PSA_ALG_MD2:
2216 mbedtls_md2_clone( &target_operation->ctx.md2,
2217 &source_operation->ctx.md2 );
2218 break;
2219#endif
2220#if defined(MBEDTLS_MD4_C)
2221 case PSA_ALG_MD4:
2222 mbedtls_md4_clone( &target_operation->ctx.md4,
2223 &source_operation->ctx.md4 );
2224 break;
2225#endif
2226#if defined(MBEDTLS_MD5_C)
2227 case PSA_ALG_MD5:
2228 mbedtls_md5_clone( &target_operation->ctx.md5,
2229 &source_operation->ctx.md5 );
2230 break;
2231#endif
2232#if defined(MBEDTLS_RIPEMD160_C)
2233 case PSA_ALG_RIPEMD160:
2234 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2235 &source_operation->ctx.ripemd160 );
2236 break;
2237#endif
2238#if defined(MBEDTLS_SHA1_C)
2239 case PSA_ALG_SHA_1:
2240 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2241 &source_operation->ctx.sha1 );
2242 break;
2243#endif
2244#if defined(MBEDTLS_SHA256_C)
2245 case PSA_ALG_SHA_224:
2246 case PSA_ALG_SHA_256:
2247 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2248 &source_operation->ctx.sha256 );
2249 break;
2250#endif
2251#if defined(MBEDTLS_SHA512_C)
2252 case PSA_ALG_SHA_384:
2253 case PSA_ALG_SHA_512:
2254 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2255 &source_operation->ctx.sha512 );
2256 break;
2257#endif
2258 default:
2259 return( PSA_ERROR_NOT_SUPPORTED );
2260 }
2261
2262 target_operation->alg = source_operation->alg;
2263 return( PSA_SUCCESS );
2264}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265
2266
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002267/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002268/* MAC */
2269/****************************************************************/
2270
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002271static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002272 psa_algorithm_t alg,
2273 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002274 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002275 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002276{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002277 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002278 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002279
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002280 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002281 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002282
Gilles Peskine8c9def32018-02-08 10:02:12 +01002283 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2284 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002285 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002286 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002287 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002288 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002289 mode = MBEDTLS_MODE_STREAM;
2290 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002291 case PSA_ALG_CTR:
2292 mode = MBEDTLS_MODE_CTR;
2293 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002294 case PSA_ALG_CFB:
2295 mode = MBEDTLS_MODE_CFB;
2296 break;
2297 case PSA_ALG_OFB:
2298 mode = MBEDTLS_MODE_OFB;
2299 break;
2300 case PSA_ALG_CBC_NO_PADDING:
2301 mode = MBEDTLS_MODE_CBC;
2302 break;
2303 case PSA_ALG_CBC_PKCS7:
2304 mode = MBEDTLS_MODE_CBC;
2305 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002306 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002307 mode = MBEDTLS_MODE_CCM;
2308 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002309 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002310 mode = MBEDTLS_MODE_GCM;
2311 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002312 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2313 mode = MBEDTLS_MODE_CHACHAPOLY;
2314 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002315 default:
2316 return( NULL );
2317 }
2318 }
2319 else if( alg == PSA_ALG_CMAC )
2320 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002321 else
2322 return( NULL );
2323
2324 switch( key_type )
2325 {
2326 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002327 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328 break;
2329 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002330 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2331 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002332 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002333 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002334 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002335 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002336 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2337 * but two-key Triple-DES is functionally three-key Triple-DES
2338 * with K1=K3, so that's how we present it to mbedtls. */
2339 if( key_bits == 128 )
2340 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002341 break;
2342 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002343 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002344 break;
2345 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002346 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002347 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002348 case PSA_KEY_TYPE_CHACHA20:
2349 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2350 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351 default:
2352 return( NULL );
2353 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002354 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002355 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002356
Jaeden Amero23bbb752018-06-26 14:16:54 +01002357 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2358 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002359}
2360
Gilles Peskinea05219c2018-11-16 16:02:56 +01002361#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002362static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002363{
Gilles Peskine2d277862018-06-18 15:41:12 +02002364 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002365 {
2366 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002367 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002368 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002369 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002370 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002371 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002372 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002373 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002374 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002375 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002376 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002377 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002378 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002379 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002380 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002381 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002382 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002383 return( 128 );
2384 default:
2385 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002386 }
2387}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002388#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002389
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002390/* Initialize the MAC operation structure. Once this function has been
2391 * called, psa_mac_abort can run and will do the right thing. */
2392static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2393 psa_algorithm_t alg )
2394{
2395 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2396
2397 operation->alg = alg;
2398 operation->key_set = 0;
2399 operation->iv_set = 0;
2400 operation->iv_required = 0;
2401 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002402 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002403
2404#if defined(MBEDTLS_CMAC_C)
2405 if( alg == PSA_ALG_CMAC )
2406 {
2407 operation->iv_required = 0;
2408 mbedtls_cipher_init( &operation->ctx.cmac );
2409 status = PSA_SUCCESS;
2410 }
2411 else
2412#endif /* MBEDTLS_CMAC_C */
2413#if defined(MBEDTLS_MD_C)
2414 if( PSA_ALG_IS_HMAC( operation->alg ) )
2415 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002416 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2417 operation->ctx.hmac.hash_ctx.alg = 0;
2418 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002419 }
2420 else
2421#endif /* MBEDTLS_MD_C */
2422 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002423 if( ! PSA_ALG_IS_MAC( alg ) )
2424 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002425 }
2426
2427 if( status != PSA_SUCCESS )
2428 memset( operation, 0, sizeof( *operation ) );
2429 return( status );
2430}
2431
Gilles Peskine01126fa2018-07-12 17:04:55 +02002432#if defined(MBEDTLS_MD_C)
2433static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2434{
Gilles Peskine3f108122018-12-07 18:14:53 +01002435 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002436 return( psa_hash_abort( &hmac->hash_ctx ) );
2437}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002438
Janos Follath999f6482019-06-11 12:04:10 +01002439#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002440static void psa_hmac_init_internal( psa_hmac_internal_data *hmac )
2441{
2442 /* Instances of psa_hash_operation_s can be initialized by zeroization. */
2443 memset( hmac, 0, sizeof( *hmac ) );
2444}
Janos Follath999f6482019-06-11 12:04:10 +01002445#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002446#endif /* MBEDTLS_MD_C */
2447
Gilles Peskine8c9def32018-02-08 10:02:12 +01002448psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2449{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002450 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002451 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002452 /* The object has (apparently) been initialized but it is not
2453 * in use. It's ok to call abort on such an object, and there's
2454 * nothing to do. */
2455 return( PSA_SUCCESS );
2456 }
2457 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002458#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002459 if( operation->alg == PSA_ALG_CMAC )
2460 {
2461 mbedtls_cipher_free( &operation->ctx.cmac );
2462 }
2463 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002464#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002465#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002466 if( PSA_ALG_IS_HMAC( operation->alg ) )
2467 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002468 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002469 }
2470 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002471#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002472 {
2473 /* Sanity check (shouldn't happen: operation->alg should
2474 * always have been initialized to a valid value). */
2475 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002476 }
Moran Peker41deec42018-04-04 15:43:05 +03002477
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478 operation->alg = 0;
2479 operation->key_set = 0;
2480 operation->iv_set = 0;
2481 operation->iv_required = 0;
2482 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002483 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002484
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002486
2487bad_state:
2488 /* If abort is called on an uninitialized object, we can't trust
2489 * anything. Wipe the object in case it contains confidential data.
2490 * This may result in a memory leak if a pointer gets overwritten,
2491 * but it's too late to do anything about this. */
2492 memset( operation, 0, sizeof( *operation ) );
2493 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002494}
2495
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002496#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002497static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002498 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002499 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002500 const mbedtls_cipher_info_t *cipher_info )
2501{
2502 int ret;
2503
2504 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002505
2506 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2507 if( ret != 0 )
2508 return( ret );
2509
2510 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2511 slot->data.raw.data,
2512 key_bits );
2513 return( ret );
2514}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002515#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002516
Gilles Peskine248051a2018-06-20 16:09:38 +02002517#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002518static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2519 const uint8_t *key,
2520 size_t key_length,
2521 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002522{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002523 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002524 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002525 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002526 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002527 psa_status_t status;
2528
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002529 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2530 * overflow below. This should never trigger if the hash algorithm
2531 * is implemented correctly. */
2532 /* The size checks against the ipad and opad buffers cannot be written
2533 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2534 * because that triggers -Wlogical-op on GCC 7.3. */
2535 if( block_size > sizeof( ipad ) )
2536 return( PSA_ERROR_NOT_SUPPORTED );
2537 if( block_size > sizeof( hmac->opad ) )
2538 return( PSA_ERROR_NOT_SUPPORTED );
2539 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002540 return( PSA_ERROR_NOT_SUPPORTED );
2541
Gilles Peskined223b522018-06-11 18:12:58 +02002542 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002543 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002544 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002545 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002546 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002547 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002548 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002549 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002550 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002551 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002552 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002553 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002554 }
Gilles Peskine96889972018-07-12 17:07:03 +02002555 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2556 * but it is permitted. It is common when HMAC is used in HKDF, for
2557 * example. Don't call `memcpy` in the 0-length because `key` could be
2558 * an invalid pointer which would make the behavior undefined. */
2559 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002560 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002561
Gilles Peskined223b522018-06-11 18:12:58 +02002562 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2563 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002564 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002565 ipad[i] ^= 0x36;
2566 memset( ipad + key_length, 0x36, block_size - key_length );
2567
2568 /* Copy the key material from ipad to opad, flipping the requisite bits,
2569 * and filling the rest of opad with the requisite constant. */
2570 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002571 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2572 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002573
Gilles Peskine01126fa2018-07-12 17:04:55 +02002574 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002575 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002576 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002577
Gilles Peskine01126fa2018-07-12 17:04:55 +02002578 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002579
2580cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002581 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002582
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002583 return( status );
2584}
Gilles Peskine248051a2018-06-20 16:09:38 +02002585#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002586
Gilles Peskine89167cb2018-07-08 20:12:23 +02002587static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002588 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002589 psa_algorithm_t alg,
2590 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002591{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002592 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002593 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002594 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002595 psa_key_usage_t usage =
2596 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002597 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002598 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002599
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002600 /* A context must be freshly initialized before it can be set up. */
2601 if( operation->alg != 0 )
2602 {
2603 return( PSA_ERROR_BAD_STATE );
2604 }
2605
Gilles Peskined911eb72018-08-14 15:18:45 +02002606 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002607 if( status != PSA_SUCCESS )
2608 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002609 if( is_sign )
2610 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002611
Gilles Peskine28f8f302019-07-24 13:30:31 +02002612 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002613 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002614 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002615 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002616
Gilles Peskine8c9def32018-02-08 10:02:12 +01002617#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002618 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002619 {
2620 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002621 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002622 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002623 int ret;
2624 if( cipher_info == NULL )
2625 {
2626 status = PSA_ERROR_NOT_SUPPORTED;
2627 goto exit;
2628 }
2629 operation->mac_size = cipher_info->block_size;
2630 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2631 status = mbedtls_to_psa_error( ret );
2632 }
2633 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002634#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002635#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002636 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002637 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002638 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002639 if( hash_alg == 0 )
2640 {
2641 status = PSA_ERROR_NOT_SUPPORTED;
2642 goto exit;
2643 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002644
2645 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2646 /* Sanity check. This shouldn't fail on a valid configuration. */
2647 if( operation->mac_size == 0 ||
2648 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2649 {
2650 status = PSA_ERROR_NOT_SUPPORTED;
2651 goto exit;
2652 }
2653
Gilles Peskine8e338702019-07-30 20:06:31 +02002654 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002655 {
2656 status = PSA_ERROR_INVALID_ARGUMENT;
2657 goto exit;
2658 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002659
Gilles Peskine01126fa2018-07-12 17:04:55 +02002660 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2661 slot->data.raw.data,
2662 slot->data.raw.bytes,
2663 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002664 }
2665 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002666#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002667 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002668 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002669 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002670 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002671
Gilles Peskined911eb72018-08-14 15:18:45 +02002672 if( truncated == 0 )
2673 {
2674 /* The "normal" case: untruncated algorithm. Nothing to do. */
2675 }
2676 else if( truncated < 4 )
2677 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002678 /* A very short MAC is too short for security since it can be
2679 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2680 * so we make this our minimum, even though 32 bits is still
2681 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002682 status = PSA_ERROR_NOT_SUPPORTED;
2683 }
2684 else if( truncated > operation->mac_size )
2685 {
2686 /* It's impossible to "truncate" to a larger length. */
2687 status = PSA_ERROR_INVALID_ARGUMENT;
2688 }
2689 else
2690 operation->mac_size = truncated;
2691
Gilles Peskinefbfac682018-07-08 20:51:54 +02002692exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002693 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002694 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002695 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002696 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002697 else
2698 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002699 operation->key_set = 1;
2700 }
2701 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002702}
2703
Gilles Peskine89167cb2018-07-08 20:12:23 +02002704psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002705 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002706 psa_algorithm_t alg )
2707{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002708 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002709}
2710
2711psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002712 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002713 psa_algorithm_t alg )
2714{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002715 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002716}
2717
Gilles Peskine8c9def32018-02-08 10:02:12 +01002718psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2719 const uint8_t *input,
2720 size_t input_length )
2721{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002722 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002723 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002724 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002725 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002726 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727 operation->has_input = 1;
2728
Gilles Peskine8c9def32018-02-08 10:02:12 +01002729#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002730 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002731 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002732 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2733 input, input_length );
2734 status = mbedtls_to_psa_error( ret );
2735 }
2736 else
2737#endif /* MBEDTLS_CMAC_C */
2738#if defined(MBEDTLS_MD_C)
2739 if( PSA_ALG_IS_HMAC( operation->alg ) )
2740 {
2741 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2742 input_length );
2743 }
2744 else
2745#endif /* MBEDTLS_MD_C */
2746 {
2747 /* This shouldn't happen if `operation` was initialized by
2748 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002749 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002750 }
2751
Gilles Peskinefbfac682018-07-08 20:51:54 +02002752 if( status != PSA_SUCCESS )
2753 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002754 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002755}
2756
Gilles Peskine01126fa2018-07-12 17:04:55 +02002757#if defined(MBEDTLS_MD_C)
2758static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2759 uint8_t *mac,
2760 size_t mac_size )
2761{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002762 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002763 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2764 size_t hash_size = 0;
2765 size_t block_size = psa_get_hash_block_size( hash_alg );
2766 psa_status_t status;
2767
Gilles Peskine01126fa2018-07-12 17:04:55 +02002768 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2769 if( status != PSA_SUCCESS )
2770 return( status );
2771 /* From here on, tmp needs to be wiped. */
2772
2773 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2774 if( status != PSA_SUCCESS )
2775 goto exit;
2776
2777 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2778 if( status != PSA_SUCCESS )
2779 goto exit;
2780
2781 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2782 if( status != PSA_SUCCESS )
2783 goto exit;
2784
Gilles Peskined911eb72018-08-14 15:18:45 +02002785 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2786 if( status != PSA_SUCCESS )
2787 goto exit;
2788
2789 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002790
2791exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002792 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002793 return( status );
2794}
2795#endif /* MBEDTLS_MD_C */
2796
mohammad16036df908f2018-04-02 08:34:15 -07002797static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002798 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002799 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002800{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002801 if( ! operation->key_set )
2802 return( PSA_ERROR_BAD_STATE );
2803 if( operation->iv_required && ! operation->iv_set )
2804 return( PSA_ERROR_BAD_STATE );
2805
Gilles Peskine8c9def32018-02-08 10:02:12 +01002806 if( mac_size < operation->mac_size )
2807 return( PSA_ERROR_BUFFER_TOO_SMALL );
2808
Gilles Peskine8c9def32018-02-08 10:02:12 +01002809#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002810 if( operation->alg == PSA_ALG_CMAC )
2811 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002812 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2813 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2814 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002815 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002816 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002817 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002818 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002819 else
2820#endif /* MBEDTLS_CMAC_C */
2821#if defined(MBEDTLS_MD_C)
2822 if( PSA_ALG_IS_HMAC( operation->alg ) )
2823 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002824 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002825 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002826 }
2827 else
2828#endif /* MBEDTLS_MD_C */
2829 {
2830 /* This shouldn't happen if `operation` was initialized by
2831 * a setup function. */
2832 return( PSA_ERROR_BAD_STATE );
2833 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002834}
2835
Gilles Peskineacd4be32018-07-08 19:56:25 +02002836psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2837 uint8_t *mac,
2838 size_t mac_size,
2839 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002840{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002841 psa_status_t status;
2842
Jaeden Amero252ef282019-02-15 14:05:35 +00002843 if( operation->alg == 0 )
2844 {
2845 return( PSA_ERROR_BAD_STATE );
2846 }
2847
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002848 /* Fill the output buffer with something that isn't a valid mac
2849 * (barring an attack on the mac and deliberately-crafted input),
2850 * in case the caller doesn't check the return status properly. */
2851 *mac_length = mac_size;
2852 /* If mac_size is 0 then mac may be NULL and then the
2853 * call to memset would have undefined behavior. */
2854 if( mac_size != 0 )
2855 memset( mac, '!', mac_size );
2856
Gilles Peskine89167cb2018-07-08 20:12:23 +02002857 if( ! operation->is_sign )
2858 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002859 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002860 }
mohammad16036df908f2018-04-02 08:34:15 -07002861
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002862 status = psa_mac_finish_internal( operation, mac, mac_size );
2863
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002864 if( status == PSA_SUCCESS )
2865 {
2866 status = psa_mac_abort( operation );
2867 if( status == PSA_SUCCESS )
2868 *mac_length = operation->mac_size;
2869 else
2870 memset( mac, '!', mac_size );
2871 }
2872 else
2873 psa_mac_abort( operation );
2874 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002875}
2876
Gilles Peskineacd4be32018-07-08 19:56:25 +02002877psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2878 const uint8_t *mac,
2879 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002880{
Gilles Peskine828ed142018-06-18 23:25:51 +02002881 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002882 psa_status_t status;
2883
Jaeden Amero252ef282019-02-15 14:05:35 +00002884 if( operation->alg == 0 )
2885 {
2886 return( PSA_ERROR_BAD_STATE );
2887 }
2888
Gilles Peskine89167cb2018-07-08 20:12:23 +02002889 if( operation->is_sign )
2890 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002891 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002892 }
2893 if( operation->mac_size != mac_length )
2894 {
2895 status = PSA_ERROR_INVALID_SIGNATURE;
2896 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002897 }
mohammad16036df908f2018-04-02 08:34:15 -07002898
2899 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002900 actual_mac, sizeof( actual_mac ) );
2901
2902 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2903 status = PSA_ERROR_INVALID_SIGNATURE;
2904
2905cleanup:
2906 if( status == PSA_SUCCESS )
2907 status = psa_mac_abort( operation );
2908 else
2909 psa_mac_abort( operation );
2910
Gilles Peskine3f108122018-12-07 18:14:53 +01002911 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002912
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002913 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002914}
2915
2916
Gilles Peskine20035e32018-02-03 22:44:14 +01002917
Gilles Peskine20035e32018-02-03 22:44:14 +01002918/****************************************************************/
2919/* Asymmetric cryptography */
2920/****************************************************************/
2921
Gilles Peskine2b450e32018-06-27 15:42:46 +02002922#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002923/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002924 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002925static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
2926 size_t hash_length,
2927 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002928{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02002929 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002930 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002931 *md_alg = mbedtls_md_get_type( md_info );
2932
2933 /* The Mbed TLS RSA module uses an unsigned int for hash length
2934 * parameters. Validate that it fits so that we don't risk an
2935 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002936#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002937 if( hash_length > UINT_MAX )
2938 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002939#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002940
2941#if defined(MBEDTLS_PKCS1_V15)
2942 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
2943 * must be correct. */
2944 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
2945 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002946 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002947 if( md_info == NULL )
2948 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002949 if( mbedtls_md_get_size( md_info ) != hash_length )
2950 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002951 }
2952#endif /* MBEDTLS_PKCS1_V15 */
2953
2954#if defined(MBEDTLS_PKCS1_V21)
2955 /* PSS requires a hash internally. */
2956 if( PSA_ALG_IS_RSA_PSS( alg ) )
2957 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02002958 if( md_info == NULL )
2959 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002960 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002961#endif /* MBEDTLS_PKCS1_V21 */
2962
Gilles Peskine61b91d42018-06-08 16:09:36 +02002963 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002964}
2965
Gilles Peskine2b450e32018-06-27 15:42:46 +02002966static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
2967 psa_algorithm_t alg,
2968 const uint8_t *hash,
2969 size_t hash_length,
2970 uint8_t *signature,
2971 size_t signature_size,
2972 size_t *signature_length )
2973{
2974 psa_status_t status;
2975 int ret;
2976 mbedtls_md_type_t md_alg;
2977
2978 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
2979 if( status != PSA_SUCCESS )
2980 return( status );
2981
Gilles Peskine630a18a2018-06-29 17:49:35 +02002982 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02002983 return( PSA_ERROR_BUFFER_TOO_SMALL );
2984
2985#if defined(MBEDTLS_PKCS1_V15)
2986 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
2987 {
2988 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
2989 MBEDTLS_MD_NONE );
2990 ret = mbedtls_rsa_pkcs1_sign( rsa,
2991 mbedtls_ctr_drbg_random,
2992 &global_data.ctr_drbg,
2993 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002994 md_alg,
2995 (unsigned int) hash_length,
2996 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002997 signature );
2998 }
2999 else
3000#endif /* MBEDTLS_PKCS1_V15 */
3001#if defined(MBEDTLS_PKCS1_V21)
3002 if( PSA_ALG_IS_RSA_PSS( alg ) )
3003 {
3004 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3005 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3006 mbedtls_ctr_drbg_random,
3007 &global_data.ctr_drbg,
3008 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003009 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003010 (unsigned int) hash_length,
3011 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003012 signature );
3013 }
3014 else
3015#endif /* MBEDTLS_PKCS1_V21 */
3016 {
3017 return( PSA_ERROR_INVALID_ARGUMENT );
3018 }
3019
3020 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003021 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003022 return( mbedtls_to_psa_error( ret ) );
3023}
3024
3025static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3026 psa_algorithm_t alg,
3027 const uint8_t *hash,
3028 size_t hash_length,
3029 const uint8_t *signature,
3030 size_t signature_length )
3031{
3032 psa_status_t status;
3033 int ret;
3034 mbedtls_md_type_t md_alg;
3035
3036 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3037 if( status != PSA_SUCCESS )
3038 return( status );
3039
Gilles Peskine630a18a2018-06-29 17:49:35 +02003040 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003041 return( PSA_ERROR_BUFFER_TOO_SMALL );
3042
3043#if defined(MBEDTLS_PKCS1_V15)
3044 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3045 {
3046 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3047 MBEDTLS_MD_NONE );
3048 ret = mbedtls_rsa_pkcs1_verify( rsa,
3049 mbedtls_ctr_drbg_random,
3050 &global_data.ctr_drbg,
3051 MBEDTLS_RSA_PUBLIC,
3052 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003053 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003054 hash,
3055 signature );
3056 }
3057 else
3058#endif /* MBEDTLS_PKCS1_V15 */
3059#if defined(MBEDTLS_PKCS1_V21)
3060 if( PSA_ALG_IS_RSA_PSS( alg ) )
3061 {
3062 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3063 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3064 mbedtls_ctr_drbg_random,
3065 &global_data.ctr_drbg,
3066 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003067 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003068 (unsigned int) hash_length,
3069 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003070 signature );
3071 }
3072 else
3073#endif /* MBEDTLS_PKCS1_V21 */
3074 {
3075 return( PSA_ERROR_INVALID_ARGUMENT );
3076 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003077
3078 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3079 * the rest of the signature is invalid". This has little use in
3080 * practice and PSA doesn't report this distinction. */
3081 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3082 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003083 return( mbedtls_to_psa_error( ret ) );
3084}
3085#endif /* MBEDTLS_RSA_C */
3086
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003087#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003088/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3089 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3090 * (even though these functions don't modify it). */
3091static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3092 psa_algorithm_t alg,
3093 const uint8_t *hash,
3094 size_t hash_length,
3095 uint8_t *signature,
3096 size_t signature_size,
3097 size_t *signature_length )
3098{
3099 int ret;
3100 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003101 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003102 mbedtls_mpi_init( &r );
3103 mbedtls_mpi_init( &s );
3104
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003105 if( signature_size < 2 * curve_bytes )
3106 {
3107 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3108 goto cleanup;
3109 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003110
Gilles Peskinea05219c2018-11-16 16:02:56 +01003111#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003112 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3113 {
3114 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3115 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3116 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3117 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det( &ecp->grp, &r, &s, &ecp->d,
3118 hash, hash_length,
3119 md_alg ) );
3120 }
3121 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003122#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003123 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003124 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003125 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3126 hash, hash_length,
3127 mbedtls_ctr_drbg_random,
3128 &global_data.ctr_drbg ) );
3129 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003130
3131 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3132 signature,
3133 curve_bytes ) );
3134 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3135 signature + curve_bytes,
3136 curve_bytes ) );
3137
3138cleanup:
3139 mbedtls_mpi_free( &r );
3140 mbedtls_mpi_free( &s );
3141 if( ret == 0 )
3142 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003143 return( mbedtls_to_psa_error( ret ) );
3144}
3145
3146static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3147 const uint8_t *hash,
3148 size_t hash_length,
3149 const uint8_t *signature,
3150 size_t signature_length )
3151{
3152 int ret;
3153 mbedtls_mpi r, s;
3154 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3155 mbedtls_mpi_init( &r );
3156 mbedtls_mpi_init( &s );
3157
3158 if( signature_length != 2 * curve_bytes )
3159 return( PSA_ERROR_INVALID_SIGNATURE );
3160
3161 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3162 signature,
3163 curve_bytes ) );
3164 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3165 signature + curve_bytes,
3166 curve_bytes ) );
3167
3168 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3169 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003170
3171cleanup:
3172 mbedtls_mpi_free( &r );
3173 mbedtls_mpi_free( &s );
3174 return( mbedtls_to_psa_error( ret ) );
3175}
3176#endif /* MBEDTLS_ECDSA_C */
3177
Gilles Peskinec5487a82018-12-03 18:08:14 +01003178psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003179 psa_algorithm_t alg,
3180 const uint8_t *hash,
3181 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003182 uint8_t *signature,
3183 size_t signature_size,
3184 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003185{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003186 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003187 psa_status_t status;
3188
3189 *signature_length = signature_size;
3190
Gilles Peskine28f8f302019-07-24 13:30:31 +02003191 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003192 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003193 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003194 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003195 {
3196 status = PSA_ERROR_INVALID_ARGUMENT;
3197 goto exit;
3198 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003199
Gilles Peskine20035e32018-02-03 22:44:14 +01003200#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003201 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003202 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003203 status = psa_rsa_sign( slot->data.rsa,
3204 alg,
3205 hash, hash_length,
3206 signature, signature_size,
3207 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003208 }
3209 else
3210#endif /* defined(MBEDTLS_RSA_C) */
3211#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003212 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003213 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003214#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003215 if(
3216#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3217 PSA_ALG_IS_ECDSA( alg )
3218#else
3219 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3220#endif
3221 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003222 status = psa_ecdsa_sign( slot->data.ecp,
3223 alg,
3224 hash, hash_length,
3225 signature, signature_size,
3226 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003227 else
3228#endif /* defined(MBEDTLS_ECDSA_C) */
3229 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003230 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003231 }
itayzafrir5c753392018-05-08 11:18:38 +03003232 }
3233 else
3234#endif /* defined(MBEDTLS_ECP_C) */
3235 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003236 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003237 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003238
3239exit:
3240 /* Fill the unused part of the output buffer (the whole buffer on error,
3241 * the trailing part on success) with something that isn't a valid mac
3242 * (barring an attack on the mac and deliberately-crafted input),
3243 * in case the caller doesn't check the return status properly. */
3244 if( status == PSA_SUCCESS )
3245 memset( signature + *signature_length, '!',
3246 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003247 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003248 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003249 /* If signature_size is 0 then we have nothing to do. We must not call
3250 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003251 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003252}
3253
Gilles Peskinec5487a82018-12-03 18:08:14 +01003254psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03003255 psa_algorithm_t alg,
3256 const uint8_t *hash,
3257 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02003258 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02003259 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003260{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003261 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003262 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003263
Gilles Peskine28f8f302019-07-24 13:30:31 +02003264 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003265 if( status != PSA_SUCCESS )
3266 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003267
Gilles Peskine61b91d42018-06-08 16:09:36 +02003268#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003269 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003270 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003271 return( psa_rsa_verify( slot->data.rsa,
3272 alg,
3273 hash, hash_length,
3274 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003275 }
3276 else
3277#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003278#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003279 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003280 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003281#if defined(MBEDTLS_ECDSA_C)
3282 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003283 return( psa_ecdsa_verify( slot->data.ecp,
3284 hash, hash_length,
3285 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003286 else
3287#endif /* defined(MBEDTLS_ECDSA_C) */
3288 {
3289 return( PSA_ERROR_INVALID_ARGUMENT );
3290 }
itayzafrir5c753392018-05-08 11:18:38 +03003291 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003292 else
3293#endif /* defined(MBEDTLS_ECP_C) */
3294 {
3295 return( PSA_ERROR_NOT_SUPPORTED );
3296 }
3297}
3298
Gilles Peskine072ac562018-06-30 00:21:29 +02003299#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3300static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3301 mbedtls_rsa_context *rsa )
3302{
3303 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3304 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3305 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3306 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3307}
3308#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3309
Gilles Peskinec5487a82018-12-03 18:08:14 +01003310psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003311 psa_algorithm_t alg,
3312 const uint8_t *input,
3313 size_t input_length,
3314 const uint8_t *salt,
3315 size_t salt_length,
3316 uint8_t *output,
3317 size_t output_size,
3318 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003319{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003320 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003321 psa_status_t status;
3322
Darryl Green5cc689a2018-07-24 15:34:10 +01003323 (void) input;
3324 (void) input_length;
3325 (void) salt;
3326 (void) output;
3327 (void) output_size;
3328
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003329 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003330
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003331 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3332 return( PSA_ERROR_INVALID_ARGUMENT );
3333
Gilles Peskine28f8f302019-07-24 13:30:31 +02003334 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003335 if( status != PSA_SUCCESS )
3336 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003337 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3338 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003339 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003340
3341#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003342 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003343 {
3344 mbedtls_rsa_context *rsa = slot->data.rsa;
3345 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003346 if( output_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine61b91d42018-06-08 16:09:36 +02003347 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003348#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003349 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003350 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003351 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3352 mbedtls_ctr_drbg_random,
3353 &global_data.ctr_drbg,
3354 MBEDTLS_RSA_PUBLIC,
3355 input_length,
3356 input,
3357 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003358 }
3359 else
3360#endif /* MBEDTLS_PKCS1_V15 */
3361#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003362 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003363 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003364 psa_rsa_oaep_set_padding_mode( alg, rsa );
3365 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3366 mbedtls_ctr_drbg_random,
3367 &global_data.ctr_drbg,
3368 MBEDTLS_RSA_PUBLIC,
3369 salt, salt_length,
3370 input_length,
3371 input,
3372 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003373 }
3374 else
3375#endif /* MBEDTLS_PKCS1_V21 */
3376 {
3377 return( PSA_ERROR_INVALID_ARGUMENT );
3378 }
3379 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003380 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003381 return( mbedtls_to_psa_error( ret ) );
3382 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003383 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003384#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003385 {
3386 return( PSA_ERROR_NOT_SUPPORTED );
3387 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003388}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003389
Gilles Peskinec5487a82018-12-03 18:08:14 +01003390psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003391 psa_algorithm_t alg,
3392 const uint8_t *input,
3393 size_t input_length,
3394 const uint8_t *salt,
3395 size_t salt_length,
3396 uint8_t *output,
3397 size_t output_size,
3398 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003399{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003400 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003401 psa_status_t status;
3402
Darryl Green5cc689a2018-07-24 15:34:10 +01003403 (void) input;
3404 (void) input_length;
3405 (void) salt;
3406 (void) output;
3407 (void) output_size;
3408
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003409 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003410
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003411 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3412 return( PSA_ERROR_INVALID_ARGUMENT );
3413
Gilles Peskine28f8f302019-07-24 13:30:31 +02003414 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003415 if( status != PSA_SUCCESS )
3416 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003417 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003418 return( PSA_ERROR_INVALID_ARGUMENT );
3419
3420#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003421 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003422 {
3423 mbedtls_rsa_context *rsa = slot->data.rsa;
3424 int ret;
3425
Gilles Peskine630a18a2018-06-29 17:49:35 +02003426 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003427 return( PSA_ERROR_INVALID_ARGUMENT );
3428
3429#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003430 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003431 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003432 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3433 mbedtls_ctr_drbg_random,
3434 &global_data.ctr_drbg,
3435 MBEDTLS_RSA_PRIVATE,
3436 output_length,
3437 input,
3438 output,
3439 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003440 }
3441 else
3442#endif /* MBEDTLS_PKCS1_V15 */
3443#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003444 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003445 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003446 psa_rsa_oaep_set_padding_mode( alg, rsa );
3447 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3448 mbedtls_ctr_drbg_random,
3449 &global_data.ctr_drbg,
3450 MBEDTLS_RSA_PRIVATE,
3451 salt, salt_length,
3452 output_length,
3453 input,
3454 output,
3455 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003456 }
3457 else
3458#endif /* MBEDTLS_PKCS1_V21 */
3459 {
3460 return( PSA_ERROR_INVALID_ARGUMENT );
3461 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003462
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003463 return( mbedtls_to_psa_error( ret ) );
3464 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003465 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003466#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003467 {
3468 return( PSA_ERROR_NOT_SUPPORTED );
3469 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003470}
Gilles Peskine20035e32018-02-03 22:44:14 +01003471
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003472
3473
mohammad1603503973b2018-03-12 15:59:30 +02003474/****************************************************************/
3475/* Symmetric cryptography */
3476/****************************************************************/
3477
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003478/* Initialize the cipher operation structure. Once this function has been
3479 * called, psa_cipher_abort can run and will do the right thing. */
3480static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3481 psa_algorithm_t alg )
3482{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003483 if( ! PSA_ALG_IS_CIPHER( alg ) )
3484 {
3485 memset( operation, 0, sizeof( *operation ) );
3486 return( PSA_ERROR_INVALID_ARGUMENT );
3487 }
3488
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003489 operation->alg = alg;
3490 operation->key_set = 0;
3491 operation->iv_set = 0;
3492 operation->iv_required = 1;
3493 operation->iv_size = 0;
3494 operation->block_size = 0;
3495 mbedtls_cipher_init( &operation->ctx.cipher );
3496 return( PSA_SUCCESS );
3497}
3498
Gilles Peskinee553c652018-06-04 16:22:46 +02003499static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003500 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003501 psa_algorithm_t alg,
3502 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003503{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003504 int ret = 0;
3505 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003506 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003507 size_t key_bits;
3508 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003509 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3510 PSA_KEY_USAGE_ENCRYPT :
3511 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003512
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003513 /* A context must be freshly initialized before it can be set up. */
3514 if( operation->alg != 0 )
3515 {
3516 return( PSA_ERROR_BAD_STATE );
3517 }
3518
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003519 status = psa_cipher_init( operation, alg );
3520 if( status != PSA_SUCCESS )
3521 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003522
Gilles Peskine28f8f302019-07-24 13:30:31 +02003523 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003524 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003525 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003526 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003527
Gilles Peskine8e338702019-07-30 20:06:31 +02003528 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003529 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003530 {
3531 status = PSA_ERROR_NOT_SUPPORTED;
3532 goto exit;
3533 }
mohammad1603503973b2018-03-12 15:59:30 +02003534
mohammad1603503973b2018-03-12 15:59:30 +02003535 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003536 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003537 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003538
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003539#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003540 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003541 {
3542 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003543 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003544 memcpy( keys, slot->data.raw.data, 16 );
3545 memcpy( keys + 16, slot->data.raw.data, 8 );
3546 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3547 keys,
3548 192, cipher_operation );
3549 }
3550 else
3551#endif
3552 {
3553 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3554 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003555 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003556 }
Moran Peker41deec42018-04-04 15:43:05 +03003557 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003558 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003559
mohammad16038481e742018-03-18 13:57:31 +02003560#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003561 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003562 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003563 case PSA_ALG_CBC_NO_PADDING:
3564 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3565 MBEDTLS_PADDING_NONE );
3566 break;
3567 case PSA_ALG_CBC_PKCS7:
3568 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3569 MBEDTLS_PADDING_PKCS7 );
3570 break;
3571 default:
3572 /* The algorithm doesn't involve padding. */
3573 ret = 0;
3574 break;
3575 }
3576 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003577 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003578#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3579
mohammad1603503973b2018-03-12 15:59:30 +02003580 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003581 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003582 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003583 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003584 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003585 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003586 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003587#if defined(MBEDTLS_CHACHA20_C)
3588 else
3589 if( alg == PSA_ALG_CHACHA20 )
3590 operation->iv_size = 12;
3591#endif
mohammad1603503973b2018-03-12 15:59:30 +02003592
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003593exit:
3594 if( status == 0 )
3595 status = mbedtls_to_psa_error( ret );
3596 if( status != 0 )
3597 psa_cipher_abort( operation );
3598 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003599}
3600
Gilles Peskinefe119512018-07-08 21:39:34 +02003601psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003602 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003603 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003604{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003605 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003606}
3607
Gilles Peskinefe119512018-07-08 21:39:34 +02003608psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003609 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003610 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003611{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003612 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003613}
3614
Gilles Peskinefe119512018-07-08 21:39:34 +02003615psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003616 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003617 size_t iv_size,
3618 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003619{
itayzafrir534bd7c2018-08-02 13:56:32 +03003620 psa_status_t status;
3621 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003622 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003623 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003624 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003625 }
Moran Peker41deec42018-04-04 15:43:05 +03003626 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003627 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003628 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003629 goto exit;
3630 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003631 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3632 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003633 if( ret != 0 )
3634 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003635 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003636 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003637 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003638
mohammad16038481e742018-03-18 13:57:31 +02003639 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003640 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003641
Moran Peker395db872018-05-31 14:07:14 +03003642exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003643 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003644 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003645 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003646}
3647
Gilles Peskinefe119512018-07-08 21:39:34 +02003648psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003649 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003650 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003651{
itayzafrir534bd7c2018-08-02 13:56:32 +03003652 psa_status_t status;
3653 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003654 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003655 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003656 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003657 }
Moran Pekera28258c2018-05-29 16:25:04 +03003658 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003659 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003660 status = PSA_ERROR_INVALID_ARGUMENT;
3661 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003662 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003663 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3664 status = mbedtls_to_psa_error( ret );
3665exit:
3666 if( status == PSA_SUCCESS )
3667 operation->iv_set = 1;
3668 else
mohammad1603503973b2018-03-12 15:59:30 +02003669 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003670 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003671}
3672
Gilles Peskinee553c652018-06-04 16:22:46 +02003673psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3674 const uint8_t *input,
3675 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003676 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003677 size_t output_size,
3678 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003679{
itayzafrir534bd7c2018-08-02 13:56:32 +03003680 psa_status_t status;
3681 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003682 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003683
3684 if( operation->alg == 0 )
3685 {
3686 return( PSA_ERROR_BAD_STATE );
3687 }
3688
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003689 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003690 {
3691 /* Take the unprocessed partial block left over from previous
3692 * update calls, if any, plus the input to this call. Remove
3693 * the last partial block, if any. You get the data that will be
3694 * output in this call. */
3695 expected_output_size =
3696 ( operation->ctx.cipher.unprocessed_len + input_length )
3697 / operation->block_size * operation->block_size;
3698 }
3699 else
3700 {
3701 expected_output_size = input_length;
3702 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003703
Gilles Peskine89d789c2018-06-04 17:17:16 +02003704 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003705 {
3706 status = PSA_ERROR_BUFFER_TOO_SMALL;
3707 goto exit;
3708 }
mohammad160382759612018-03-12 18:16:40 +02003709
mohammad1603503973b2018-03-12 15:59:30 +02003710 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003711 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003712 status = mbedtls_to_psa_error( ret );
3713exit:
3714 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003715 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003716 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003717}
3718
Gilles Peskinee553c652018-06-04 16:22:46 +02003719psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3720 uint8_t *output,
3721 size_t output_size,
3722 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003723{
David Saadab4ecc272019-02-14 13:48:10 +02003724 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003725 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003726 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003727
mohammad1603503973b2018-03-12 15:59:30 +02003728 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003729 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003730 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003731 }
3732 if( operation->iv_required && ! operation->iv_set )
3733 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003734 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003735 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003736
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003737 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003738 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3739 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003740 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003741 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003742 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003743 }
3744
Janos Follath315b51c2018-07-09 16:04:51 +01003745 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3746 temp_output_buffer,
3747 output_length );
3748 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003749 {
Janos Follath315b51c2018-07-09 16:04:51 +01003750 status = mbedtls_to_psa_error( cipher_ret );
3751 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003752 }
Janos Follath315b51c2018-07-09 16:04:51 +01003753
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003754 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003755 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003756 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003757 memcpy( output, temp_output_buffer, *output_length );
3758 else
3759 {
Janos Follath315b51c2018-07-09 16:04:51 +01003760 status = PSA_ERROR_BUFFER_TOO_SMALL;
3761 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003762 }
mohammad1603503973b2018-03-12 15:59:30 +02003763
Gilles Peskine3f108122018-12-07 18:14:53 +01003764 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003765 status = psa_cipher_abort( operation );
3766
3767 return( status );
3768
3769error:
3770
3771 *output_length = 0;
3772
Gilles Peskine3f108122018-12-07 18:14:53 +01003773 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003774 (void) psa_cipher_abort( operation );
3775
3776 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003777}
3778
Gilles Peskinee553c652018-06-04 16:22:46 +02003779psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3780{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003781 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003782 {
3783 /* The object has (apparently) been initialized but it is not
3784 * in use. It's ok to call abort on such an object, and there's
3785 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003786 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003787 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003788
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003789 /* Sanity check (shouldn't happen: operation->alg should
3790 * always have been initialized to a valid value). */
3791 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3792 return( PSA_ERROR_BAD_STATE );
3793
mohammad1603503973b2018-03-12 15:59:30 +02003794 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003795
Moran Peker41deec42018-04-04 15:43:05 +03003796 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003797 operation->key_set = 0;
3798 operation->iv_set = 0;
3799 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003800 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003801 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003802
Moran Peker395db872018-05-31 14:07:14 +03003803 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003804}
3805
Gilles Peskinea0655c32018-04-30 17:06:50 +02003806
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003807
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003808
mohammad16035955c982018-04-26 00:53:03 +03003809/****************************************************************/
3810/* AEAD */
3811/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003812
Gilles Peskineedf9a652018-08-17 18:11:56 +02003813typedef struct
3814{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003815 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003816 const mbedtls_cipher_info_t *cipher_info;
3817 union
3818 {
3819#if defined(MBEDTLS_CCM_C)
3820 mbedtls_ccm_context ccm;
3821#endif /* MBEDTLS_CCM_C */
3822#if defined(MBEDTLS_GCM_C)
3823 mbedtls_gcm_context gcm;
3824#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003825#if defined(MBEDTLS_CHACHAPOLY_C)
3826 mbedtls_chachapoly_context chachapoly;
3827#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003828 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003829 psa_algorithm_t core_alg;
3830 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003831 uint8_t tag_length;
3832} aead_operation_t;
3833
Gilles Peskine30a9e412019-01-14 18:36:12 +01003834static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003835{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003836 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003837 {
3838#if defined(MBEDTLS_CCM_C)
3839 case PSA_ALG_CCM:
3840 mbedtls_ccm_free( &operation->ctx.ccm );
3841 break;
3842#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003843#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003844 case PSA_ALG_GCM:
3845 mbedtls_gcm_free( &operation->ctx.gcm );
3846 break;
3847#endif /* MBEDTLS_GCM_C */
3848 }
3849}
3850
3851static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003852 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003853 psa_key_usage_t usage,
3854 psa_algorithm_t alg )
3855{
3856 psa_status_t status;
3857 size_t key_bits;
3858 mbedtls_cipher_id_t cipher_id;
3859
Gilles Peskine28f8f302019-07-24 13:30:31 +02003860 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003861 if( status != PSA_SUCCESS )
3862 return( status );
3863
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003864 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003865
3866 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02003867 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003868 &cipher_id );
3869 if( operation->cipher_info == NULL )
3870 return( PSA_ERROR_NOT_SUPPORTED );
3871
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003872 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003873 {
3874#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003875 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
3876 operation->core_alg = PSA_ALG_CCM;
3877 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003878 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3879 * The call to mbedtls_ccm_encrypt_and_tag or
3880 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02003881 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003882 return( PSA_ERROR_INVALID_ARGUMENT );
3883 mbedtls_ccm_init( &operation->ctx.ccm );
3884 status = mbedtls_to_psa_error(
3885 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
3886 operation->slot->data.raw.data,
3887 (unsigned int) key_bits ) );
3888 if( status != 0 )
3889 goto cleanup;
3890 break;
3891#endif /* MBEDTLS_CCM_C */
3892
3893#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003894 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
3895 operation->core_alg = PSA_ALG_GCM;
3896 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003897 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3898 * The call to mbedtls_gcm_crypt_and_tag or
3899 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02003900 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003901 return( PSA_ERROR_INVALID_ARGUMENT );
3902 mbedtls_gcm_init( &operation->ctx.gcm );
3903 status = mbedtls_to_psa_error(
3904 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
3905 operation->slot->data.raw.data,
3906 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003907 if( status != 0 )
3908 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003909 break;
3910#endif /* MBEDTLS_GCM_C */
3911
Gilles Peskine26869f22019-05-06 15:25:00 +02003912#if defined(MBEDTLS_CHACHAPOLY_C)
3913 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
3914 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
3915 operation->full_tag_length = 16;
3916 /* We only support the default tag length. */
3917 if( alg != PSA_ALG_CHACHA20_POLY1305 )
3918 return( PSA_ERROR_NOT_SUPPORTED );
3919 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
3920 status = mbedtls_to_psa_error(
3921 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
3922 operation->slot->data.raw.data ) );
3923 if( status != 0 )
3924 goto cleanup;
3925 break;
3926#endif /* MBEDTLS_CHACHAPOLY_C */
3927
Gilles Peskineedf9a652018-08-17 18:11:56 +02003928 default:
3929 return( PSA_ERROR_NOT_SUPPORTED );
3930 }
3931
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003932 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
3933 {
3934 status = PSA_ERROR_INVALID_ARGUMENT;
3935 goto cleanup;
3936 }
3937 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003938
Gilles Peskineedf9a652018-08-17 18:11:56 +02003939 return( PSA_SUCCESS );
3940
3941cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01003942 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003943 return( status );
3944}
3945
Gilles Peskinec5487a82018-12-03 18:08:14 +01003946psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03003947 psa_algorithm_t alg,
3948 const uint8_t *nonce,
3949 size_t nonce_length,
3950 const uint8_t *additional_data,
3951 size_t additional_data_length,
3952 const uint8_t *plaintext,
3953 size_t plaintext_length,
3954 uint8_t *ciphertext,
3955 size_t ciphertext_size,
3956 size_t *ciphertext_length )
3957{
mohammad16035955c982018-04-26 00:53:03 +03003958 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003959 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03003960 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02003961
mohammad1603f08a5502018-06-03 15:05:47 +03003962 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003963
Gilles Peskinec5487a82018-12-03 18:08:14 +01003964 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003965 if( status != PSA_SUCCESS )
3966 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003967
Gilles Peskineedf9a652018-08-17 18:11:56 +02003968 /* For all currently supported modes, the tag is at the end of the
3969 * ciphertext. */
3970 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
3971 {
3972 status = PSA_ERROR_BUFFER_TOO_SMALL;
3973 goto exit;
3974 }
3975 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03003976
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003977#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003978 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03003979 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003980 status = mbedtls_to_psa_error(
3981 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
3982 MBEDTLS_GCM_ENCRYPT,
3983 plaintext_length,
3984 nonce, nonce_length,
3985 additional_data, additional_data_length,
3986 plaintext, ciphertext,
3987 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03003988 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003989 else
3990#endif /* MBEDTLS_GCM_C */
3991#if defined(MBEDTLS_CCM_C)
3992 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03003993 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003994 status = mbedtls_to_psa_error(
3995 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
3996 plaintext_length,
3997 nonce, nonce_length,
3998 additional_data,
3999 additional_data_length,
4000 plaintext, ciphertext,
4001 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004002 }
mohammad16035c8845f2018-05-09 05:40:09 -07004003 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004004#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004005#if defined(MBEDTLS_CHACHAPOLY_C)
4006 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4007 {
4008 if( nonce_length != 12 || operation.tag_length != 16 )
4009 {
4010 status = PSA_ERROR_NOT_SUPPORTED;
4011 goto exit;
4012 }
4013 status = mbedtls_to_psa_error(
4014 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4015 plaintext_length,
4016 nonce,
4017 additional_data,
4018 additional_data_length,
4019 plaintext,
4020 ciphertext,
4021 tag ) );
4022 }
4023 else
4024#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004025 {
mohammad1603554faad2018-06-03 15:07:38 +03004026 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004027 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004028
Gilles Peskineedf9a652018-08-17 18:11:56 +02004029 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4030 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004031
Gilles Peskineedf9a652018-08-17 18:11:56 +02004032exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004033 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004034 if( status == PSA_SUCCESS )
4035 *ciphertext_length = plaintext_length + operation.tag_length;
4036 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004037}
4038
Gilles Peskineee652a32018-06-01 19:23:52 +02004039/* Locate the tag in a ciphertext buffer containing the encrypted data
4040 * followed by the tag. Return the length of the part preceding the tag in
4041 * *plaintext_length. This is the size of the plaintext in modes where
4042 * the encrypted data has the same size as the plaintext, such as
4043 * CCM and GCM. */
4044static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4045 const uint8_t *ciphertext,
4046 size_t ciphertext_length,
4047 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004048 const uint8_t **p_tag )
4049{
4050 size_t payload_length;
4051 if( tag_length > ciphertext_length )
4052 return( PSA_ERROR_INVALID_ARGUMENT );
4053 payload_length = ciphertext_length - tag_length;
4054 if( payload_length > plaintext_size )
4055 return( PSA_ERROR_BUFFER_TOO_SMALL );
4056 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004057 return( PSA_SUCCESS );
4058}
4059
Gilles Peskinec5487a82018-12-03 18:08:14 +01004060psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004061 psa_algorithm_t alg,
4062 const uint8_t *nonce,
4063 size_t nonce_length,
4064 const uint8_t *additional_data,
4065 size_t additional_data_length,
4066 const uint8_t *ciphertext,
4067 size_t ciphertext_length,
4068 uint8_t *plaintext,
4069 size_t plaintext_size,
4070 size_t *plaintext_length )
4071{
mohammad16035955c982018-04-26 00:53:03 +03004072 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004073 aead_operation_t operation;
4074 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004075
Gilles Peskineee652a32018-06-01 19:23:52 +02004076 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004077
Gilles Peskinec5487a82018-12-03 18:08:14 +01004078 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004079 if( status != PSA_SUCCESS )
4080 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004081
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004082 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4083 ciphertext, ciphertext_length,
4084 plaintext_size, &tag );
4085 if( status != PSA_SUCCESS )
4086 goto exit;
4087
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004088#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004089 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004090 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004091 status = mbedtls_to_psa_error(
4092 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4093 ciphertext_length - operation.tag_length,
4094 nonce, nonce_length,
4095 additional_data,
4096 additional_data_length,
4097 tag, operation.tag_length,
4098 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004099 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004100 else
4101#endif /* MBEDTLS_GCM_C */
4102#if defined(MBEDTLS_CCM_C)
4103 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004104 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004105 status = mbedtls_to_psa_error(
4106 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4107 ciphertext_length - operation.tag_length,
4108 nonce, nonce_length,
4109 additional_data,
4110 additional_data_length,
4111 ciphertext, plaintext,
4112 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004113 }
mohammad160339574652018-06-01 04:39:53 -07004114 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004115#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004116#if defined(MBEDTLS_CHACHAPOLY_C)
4117 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4118 {
4119 if( nonce_length != 12 || operation.tag_length != 16 )
4120 {
4121 status = PSA_ERROR_NOT_SUPPORTED;
4122 goto exit;
4123 }
4124 status = mbedtls_to_psa_error(
4125 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4126 ciphertext_length - operation.tag_length,
4127 nonce,
4128 additional_data,
4129 additional_data_length,
4130 tag,
4131 ciphertext,
4132 plaintext ) );
4133 }
4134 else
4135#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004136 {
mohammad1603554faad2018-06-03 15:07:38 +03004137 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004138 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004139
Gilles Peskineedf9a652018-08-17 18:11:56 +02004140 if( status != PSA_SUCCESS && plaintext_size != 0 )
4141 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004142
Gilles Peskineedf9a652018-08-17 18:11:56 +02004143exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004144 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004145 if( status == PSA_SUCCESS )
4146 *plaintext_length = ciphertext_length - operation.tag_length;
4147 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004148}
4149
Gilles Peskinea0655c32018-04-30 17:06:50 +02004150
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004151
Gilles Peskine20035e32018-02-03 22:44:14 +01004152/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004153/* Generators */
4154/****************************************************************/
4155
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004156#define HKDF_STATE_INIT 0 /* no input yet */
4157#define HKDF_STATE_STARTED 1 /* got salt */
4158#define HKDF_STATE_KEYED 2 /* got key */
4159#define HKDF_STATE_OUTPUT 3 /* output started */
4160
Gilles Peskinecbe66502019-05-16 16:59:18 +02004161static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004162 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004163{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004164 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4165 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004166 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004167 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004168}
4169
4170
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004171psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004172{
4173 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004174 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004175 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004176 {
4177 /* The object has (apparently) been initialized but it is not
4178 * in use. It's ok to call abort on such an object, and there's
4179 * nothing to do. */
4180 }
4181 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004182#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004183 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004184 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004185 mbedtls_free( operation->ctx.hkdf.info );
4186 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004187 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004188 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004189 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004190 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004191 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004192#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004193 if( operation->ctx.tls12_prf.key != NULL )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004194 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004195 mbedtls_platform_zeroize( operation->ctx.tls12_prf.key,
4196 operation->ctx.tls12_prf.key_len );
4197 mbedtls_free( operation->ctx.tls12_prf.key );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004198 }
Hanno Becker580fba12018-11-13 20:50:45 +00004199
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004200 if( operation->ctx.tls12_prf.Ai_with_seed != NULL )
Hanno Becker580fba12018-11-13 20:50:45 +00004201 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004202 mbedtls_platform_zeroize( operation->ctx.tls12_prf.Ai_with_seed,
4203 operation->ctx.tls12_prf.Ai_with_seed_len );
4204 mbedtls_free( operation->ctx.tls12_prf.Ai_with_seed );
Hanno Becker580fba12018-11-13 20:50:45 +00004205 }
Janos Follath6a1d2622019-06-11 10:37:28 +01004206#else
4207 if( operation->ctx.tls12_prf.seed != NULL )
4208 {
4209 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4210 operation->ctx.tls12_prf.seed_length );
4211 mbedtls_free( operation->ctx.tls12_prf.seed );
4212 }
4213
4214 if( operation->ctx.tls12_prf.label != NULL )
4215 {
4216 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4217 operation->ctx.tls12_prf.label_length );
4218 mbedtls_free( operation->ctx.tls12_prf.label );
4219 }
4220
4221 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4222
4223 /* We leave the fields Ai and output_block to be erased safely by the
4224 * mbedtls_platform_zeroize() in the end of this function. */
Janos Follath999f6482019-06-11 12:04:10 +01004225#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004226 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004227 else
4228#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004229 {
4230 status = PSA_ERROR_BAD_STATE;
4231 }
Janos Follath083036a2019-06-11 10:22:26 +01004232 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004233 return( status );
4234}
4235
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004236psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004237 size_t *capacity)
4238{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004239 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004240 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004241 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004242 return PSA_ERROR_BAD_STATE;
4243 }
4244
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004245 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004246 return( PSA_SUCCESS );
4247}
4248
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004249psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004250 size_t capacity )
4251{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004252 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004253 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004254 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004255 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004256 operation->capacity = capacity;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004257 return( PSA_SUCCESS );
4258}
4259
Gilles Peskinebef7f142018-07-12 17:22:21 +02004260#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004261/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004262 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004263static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004264 psa_algorithm_t hash_alg,
4265 uint8_t *output,
4266 size_t output_length )
4267{
4268 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4269 psa_status_t status;
4270
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004271 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4272 return( PSA_ERROR_BAD_STATE );
4273 hkdf->state = HKDF_STATE_OUTPUT;
4274
Gilles Peskinebef7f142018-07-12 17:22:21 +02004275 while( output_length != 0 )
4276 {
4277 /* Copy what remains of the current block */
4278 uint8_t n = hash_length - hkdf->offset_in_block;
4279 if( n > output_length )
4280 n = (uint8_t) output_length;
4281 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4282 output += n;
4283 output_length -= n;
4284 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004285 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004286 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004287 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004288 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004289 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004290 * object was corrupted or if this function is called directly
4291 * inside the library. */
4292 if( hkdf->block_number == 0xff )
4293 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004294
4295 /* We need a new block */
4296 ++hkdf->block_number;
4297 hkdf->offset_in_block = 0;
4298 status = psa_hmac_setup_internal( &hkdf->hmac,
4299 hkdf->prk, hash_length,
4300 hash_alg );
4301 if( status != PSA_SUCCESS )
4302 return( status );
4303 if( hkdf->block_number != 1 )
4304 {
4305 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4306 hkdf->output_block,
4307 hash_length );
4308 if( status != PSA_SUCCESS )
4309 return( status );
4310 }
4311 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4312 hkdf->info,
4313 hkdf->info_length );
4314 if( status != PSA_SUCCESS )
4315 return( status );
4316 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4317 &hkdf->block_number, 1 );
4318 if( status != PSA_SUCCESS )
4319 return( status );
4320 status = psa_hmac_finish_internal( &hkdf->hmac,
4321 hkdf->output_block,
4322 sizeof( hkdf->output_block ) );
4323 if( status != PSA_SUCCESS )
4324 return( status );
4325 }
4326
4327 return( PSA_SUCCESS );
4328}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004329
Janos Follath999f6482019-06-11 12:04:10 +01004330#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004331static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4332 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004333 psa_algorithm_t alg )
4334{
4335 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4336 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4337 psa_hmac_internal_data hmac;
4338 psa_status_t status, cleanup_status;
4339
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004340 uint8_t *Ai;
Hanno Becker3b339e22018-11-13 20:56:14 +00004341 size_t Ai_len;
4342
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004343 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004344 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004345 * prevented this call. It could happen only if the operation
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004346 * object was corrupted or if this function is called directly
4347 * inside the library. */
4348 if( tls12_prf->block_number == 0xff )
4349 return( PSA_ERROR_BAD_STATE );
4350
4351 /* We need a new block */
4352 ++tls12_prf->block_number;
4353 tls12_prf->offset_in_block = 0;
4354
4355 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4356 *
4357 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4358 *
4359 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4360 * HMAC_hash(secret, A(2) + seed) +
4361 * HMAC_hash(secret, A(3) + seed) + ...
4362 *
4363 * A(0) = seed
4364 * A(i) = HMAC_hash( secret, A(i-1) )
4365 *
Gilles Peskinecbe66502019-05-16 16:59:18 +02004366 * The `psa_tls12_prf_key_derivation` structures saves the block
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004367 * `HMAC_hash(secret, A(i) + seed)` from which the output
4368 * is currently extracted as `output_block`, while
4369 * `A(i) + seed` is stored in `Ai_with_seed`.
4370 *
4371 * Generating a new block means recalculating `Ai_with_seed`
4372 * from the A(i)-part of it, and afterwards recalculating
4373 * `output_block`.
4374 *
4375 * A(0) is computed at setup time.
4376 *
4377 */
4378
4379 psa_hmac_init_internal( &hmac );
4380
4381 /* We must distinguish the calculation of A(1) from those
4382 * of A(2) and higher, because A(0)=seed has a different
4383 * length than the other A(i). */
4384 if( tls12_prf->block_number == 1 )
4385 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004386 Ai = tls12_prf->Ai_with_seed + hash_length;
4387 Ai_len = tls12_prf->Ai_with_seed_len - hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004388 }
4389 else
4390 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004391 Ai = tls12_prf->Ai_with_seed;
4392 Ai_len = hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004393 }
4394
Hanno Becker3b339e22018-11-13 20:56:14 +00004395 /* Compute A(i+1) = HMAC_hash(secret, A(i)) */
4396 status = psa_hmac_setup_internal( &hmac,
4397 tls12_prf->key,
4398 tls12_prf->key_len,
4399 hash_alg );
4400 if( status != PSA_SUCCESS )
4401 goto cleanup;
4402
4403 status = psa_hash_update( &hmac.hash_ctx,
4404 Ai, Ai_len );
4405 if( status != PSA_SUCCESS )
4406 goto cleanup;
4407
4408 status = psa_hmac_finish_internal( &hmac,
4409 tls12_prf->Ai_with_seed,
4410 hash_length );
4411 if( status != PSA_SUCCESS )
4412 goto cleanup;
4413
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004414 /* Compute the next block `HMAC_hash(secret, A(i+1) + seed)`. */
4415 status = psa_hmac_setup_internal( &hmac,
4416 tls12_prf->key,
4417 tls12_prf->key_len,
4418 hash_alg );
4419 if( status != PSA_SUCCESS )
4420 goto cleanup;
4421
4422 status = psa_hash_update( &hmac.hash_ctx,
4423 tls12_prf->Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00004424 tls12_prf->Ai_with_seed_len );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004425 if( status != PSA_SUCCESS )
4426 goto cleanup;
4427
4428 status = psa_hmac_finish_internal( &hmac,
4429 tls12_prf->output_block,
4430 hash_length );
4431 if( status != PSA_SUCCESS )
4432 goto cleanup;
4433
4434cleanup:
4435
4436 cleanup_status = psa_hmac_abort_internal( &hmac );
4437 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4438 status = cleanup_status;
4439
4440 return( status );
4441}
Janos Follath7742fee2019-06-17 12:58:10 +01004442#else
4443static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4444 psa_tls12_prf_key_derivation_t *tls12_prf,
4445 psa_algorithm_t alg )
4446{
4447 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4448 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004449 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4450 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004451
Janos Follath7742fee2019-06-17 12:58:10 +01004452 /* We can't be wanting more output after block 0xff, otherwise
4453 * the capacity check in psa_key_derivation_output_bytes() would have
4454 * prevented this call. It could happen only if the operation
4455 * object was corrupted or if this function is called directly
4456 * inside the library. */
4457 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004458 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004459
4460 /* We need a new block */
4461 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004462 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004463
4464 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4465 *
4466 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4467 *
4468 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4469 * HMAC_hash(secret, A(2) + seed) +
4470 * HMAC_hash(secret, A(3) + seed) + ...
4471 *
4472 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004473 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004474 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004475 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004476 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004477 * is currently extracted as `output_block` and where i is
4478 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004479 */
4480
Janos Follathea29bfb2019-06-19 12:21:20 +01004481 /* Save the hash context before using it, to preserve the hash state with
4482 * only the inner padding in it. We need this, because inner padding depends
4483 * on the key (secret in the RFC's terminology). */
4484 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4485 if( status != PSA_SUCCESS )
4486 goto cleanup;
4487
4488 /* Calculate A(i) where i = tls12_prf->block_number. */
4489 if( tls12_prf->block_number == 1 )
4490 {
4491 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4492 * the variable seed and in this instance means it in the context of the
4493 * P_hash function, where seed = label + seed.) */
4494 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4495 tls12_prf->label, tls12_prf->label_length );
4496 if( status != PSA_SUCCESS )
4497 goto cleanup;
4498 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4499 tls12_prf->seed, tls12_prf->seed_length );
4500 if( status != PSA_SUCCESS )
4501 goto cleanup;
4502 }
4503 else
4504 {
4505 /* A(i) = HMAC_hash(secret, A(i-1)) */
4506 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4507 tls12_prf->Ai, hash_length );
4508 if( status != PSA_SUCCESS )
4509 goto cleanup;
4510 }
4511
4512 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4513 tls12_prf->Ai, hash_length );
4514 if( status != PSA_SUCCESS )
4515 goto cleanup;
4516 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4517 if( status != PSA_SUCCESS )
4518 goto cleanup;
4519
4520 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4521 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4522 tls12_prf->Ai, hash_length );
4523 if( status != PSA_SUCCESS )
4524 goto cleanup;
4525 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4526 tls12_prf->label, tls12_prf->label_length );
4527 if( status != PSA_SUCCESS )
4528 goto cleanup;
4529 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4530 tls12_prf->seed, tls12_prf->seed_length );
4531 if( status != PSA_SUCCESS )
4532 goto cleanup;
4533 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4534 tls12_prf->output_block, hash_length );
4535 if( status != PSA_SUCCESS )
4536 goto cleanup;
4537 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4538 if( status != PSA_SUCCESS )
4539 goto cleanup;
4540
Janos Follath7742fee2019-06-17 12:58:10 +01004541
4542cleanup:
4543
Janos Follathea29bfb2019-06-19 12:21:20 +01004544 cleanup_status = psa_hash_abort( &backup );
4545 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4546 status = cleanup_status;
4547
4548 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004549}
Janos Follath999f6482019-06-11 12:04:10 +01004550#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004551
Janos Follath999f6482019-06-11 12:04:10 +01004552#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004553/* Read some bytes from an TLS-1.2-PRF-based operation.
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004554 * See Section 5 of RFC 5246. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004555static psa_status_t psa_key_derivation_tls12_prf_read(
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004556 psa_tls12_prf_key_derivation_t *tls12_prf,
4557 psa_algorithm_t alg,
4558 uint8_t *output,
4559 size_t output_length )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004560{
4561 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4562 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4563 psa_status_t status;
4564
4565 while( output_length != 0 )
4566 {
4567 /* Copy what remains of the current block */
4568 uint8_t n = hash_length - tls12_prf->offset_in_block;
4569
4570 /* Check if we have fully processed the current block. */
4571 if( n == 0 )
4572 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004573 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004574 alg );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004575 if( status != PSA_SUCCESS )
4576 return( status );
4577
4578 continue;
4579 }
4580
4581 if( n > output_length )
4582 n = (uint8_t) output_length;
4583 memcpy( output, tls12_prf->output_block + tls12_prf->offset_in_block,
4584 n );
4585 output += n;
4586 output_length -= n;
4587 tls12_prf->offset_in_block += n;
4588 }
4589
4590 return( PSA_SUCCESS );
4591}
Janos Follath844eb0e2019-06-19 12:10:49 +01004592#else
4593static psa_status_t psa_key_derivation_tls12_prf_read(
4594 psa_tls12_prf_key_derivation_t *tls12_prf,
4595 psa_algorithm_t alg,
4596 uint8_t *output,
4597 size_t output_length )
4598{
4599 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4600 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4601 psa_status_t status;
4602 uint8_t offset, length;
4603
4604 while( output_length != 0 )
4605 {
4606 /* Check if we have fully processed the current block. */
4607 if( tls12_prf->left_in_block == 0 )
4608 {
4609 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4610 alg );
4611 if( status != PSA_SUCCESS )
4612 return( status );
4613
4614 continue;
4615 }
4616
4617 if( tls12_prf->left_in_block > output_length )
4618 length = (uint8_t) output_length;
4619 else
4620 length = tls12_prf->left_in_block;
4621
4622 offset = hash_length - tls12_prf->left_in_block;
4623 memcpy( output, tls12_prf->output_block + offset, length );
4624 output += length;
4625 output_length -= length;
4626 tls12_prf->left_in_block -= length;
4627 }
4628
4629 return( PSA_SUCCESS );
4630}
Janos Follath999f6482019-06-11 12:04:10 +01004631#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004632#endif /* MBEDTLS_MD_C */
4633
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004634psa_status_t psa_key_derivation_output_bytes(
4635 psa_key_derivation_operation_t *operation,
4636 uint8_t *output,
4637 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004638{
4639 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004640 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004641
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004642 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004643 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004644 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004645 return PSA_ERROR_BAD_STATE;
4646 }
4647
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004648 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004649 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004650 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004651 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004652 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004653 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004654 goto exit;
4655 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004656 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004657 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004658 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004659 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004660 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4661 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004662 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004663 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004664 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004665 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004666 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004667
Gilles Peskinebef7f142018-07-12 17:22:21 +02004668#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004669 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004670 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004671 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004672 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004673 output, output_length );
4674 }
Janos Follathadbec812019-06-14 11:05:39 +01004675 else
Janos Follathadbec812019-06-14 11:05:39 +01004676 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004677 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004678 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004679 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004680 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004681 output_length );
4682 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004683 else
4684#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004685 {
4686 return( PSA_ERROR_BAD_STATE );
4687 }
4688
4689exit:
4690 if( status != PSA_SUCCESS )
4691 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004692 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004693 * This allows us to differentiate between exhausted operations and
4694 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4695 * operations. */
4696 psa_algorithm_t alg = operation->alg;
4697 psa_key_derivation_abort( operation );
4698 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004699 memset( output, '!', output_length );
4700 }
4701 return( status );
4702}
4703
Gilles Peskine08542d82018-07-19 17:05:42 +02004704#if defined(MBEDTLS_DES_C)
4705static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4706{
4707 if( data_size >= 8 )
4708 mbedtls_des_key_set_parity( data );
4709 if( data_size >= 16 )
4710 mbedtls_des_key_set_parity( data + 8 );
4711 if( data_size >= 24 )
4712 mbedtls_des_key_set_parity( data + 16 );
4713}
4714#endif /* MBEDTLS_DES_C */
4715
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004716static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004717 psa_key_slot_t *slot,
4718 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004719 psa_key_derivation_operation_t *operation )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004720{
4721 uint8_t *data = NULL;
4722 size_t bytes = PSA_BITS_TO_BYTES( bits );
4723 psa_status_t status;
4724
Gilles Peskine8e338702019-07-30 20:06:31 +02004725 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004726 return( PSA_ERROR_INVALID_ARGUMENT );
4727 if( bits % 8 != 0 )
4728 return( PSA_ERROR_INVALID_ARGUMENT );
4729 data = mbedtls_calloc( 1, bytes );
4730 if( data == NULL )
4731 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4732
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004733 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004734 if( status != PSA_SUCCESS )
4735 goto exit;
4736#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004737 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004738 psa_des_set_key_parity( data, bytes );
4739#endif /* MBEDTLS_DES_C */
4740 status = psa_import_key_into_slot( slot, data, bytes );
4741
4742exit:
4743 mbedtls_free( data );
4744 return( status );
4745}
4746
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004747psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004748 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004749 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004750{
4751 psa_status_t status;
4752 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004753 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine011e4282019-06-26 18:34:38 +02004754 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004755#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4756 if( driver != NULL )
4757 {
4758 /* Deriving a key in a secure element is not implemented yet. */
4759 status = PSA_ERROR_NOT_SUPPORTED;
4760 }
4761#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004762 if( status == PSA_SUCCESS )
4763 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004764 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004765 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004766 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004767 }
4768 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004769 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004770 if( status != PSA_SUCCESS )
4771 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004772 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004773 *handle = 0;
4774 }
4775 return( status );
4776}
4777
Gilles Peskineeab56e42018-07-12 17:12:33 +02004778
4779
4780/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004781/* Key derivation */
4782/****************************************************************/
4783
Gilles Peskinea05219c2018-11-16 16:02:56 +01004784#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004785#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004786/* Set up an HKDF-based operation. This is exactly the extract phase
Gilles Peskine346797d2018-11-16 16:05:06 +01004787 * of the HKDF algorithm.
4788 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004789 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004790 * to potentially free embedded data structures and wipe confidential data.
4791 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004792static psa_status_t psa_key_derivation_hkdf_setup( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004793 const uint8_t *secret,
4794 size_t secret_length,
4795 psa_algorithm_t hash_alg,
4796 const uint8_t *salt,
4797 size_t salt_length,
4798 const uint8_t *label,
4799 size_t label_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004800{
4801 psa_status_t status;
4802 status = psa_hmac_setup_internal( &hkdf->hmac,
4803 salt, salt_length,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004804 hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004805 if( status != PSA_SUCCESS )
4806 return( status );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004807 status = psa_hash_update( &hkdf->hmac.hash_ctx, secret, secret_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004808 if( status != PSA_SUCCESS )
4809 return( status );
4810 status = psa_hmac_finish_internal( &hkdf->hmac,
4811 hkdf->prk,
4812 sizeof( hkdf->prk ) );
4813 if( status != PSA_SUCCESS )
4814 return( status );
4815 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4816 hkdf->block_number = 0;
4817 hkdf->info_length = label_length;
4818 if( label_length != 0 )
4819 {
4820 hkdf->info = mbedtls_calloc( 1, label_length );
4821 if( hkdf->info == NULL )
4822 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4823 memcpy( hkdf->info, label, label_length );
4824 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004825 hkdf->state = HKDF_STATE_KEYED;
4826 hkdf->info_set = 1;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004827 return( PSA_SUCCESS );
4828}
Janos Follath71a4c912019-06-11 09:14:47 +01004829#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01004830#endif /* MBEDTLS_MD_C */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004831
Gilles Peskinea05219c2018-11-16 16:02:56 +01004832#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004833#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004834/* Set up a TLS-1.2-prf-based operation (see RFC 5246, Section 5).
Gilles Peskine346797d2018-11-16 16:05:06 +01004835 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004836 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004837 * to potentially free embedded data structures and wipe confidential data.
4838 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004839static psa_status_t psa_key_derivation_tls12_prf_setup(
4840 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004841 const uint8_t *key,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004842 size_t key_len,
4843 psa_algorithm_t hash_alg,
4844 const uint8_t *salt,
4845 size_t salt_length,
4846 const uint8_t *label,
4847 size_t label_length )
4848{
4849 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Hanno Becker580fba12018-11-13 20:50:45 +00004850 size_t Ai_with_seed_len = hash_length + salt_length + label_length;
4851 int overflow;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004852
4853 tls12_prf->key = mbedtls_calloc( 1, key_len );
4854 if( tls12_prf->key == NULL )
4855 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4856 tls12_prf->key_len = key_len;
4857 memcpy( tls12_prf->key, key, key_len );
4858
Hanno Becker580fba12018-11-13 20:50:45 +00004859 overflow = ( salt_length + label_length < salt_length ) ||
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004860 ( salt_length + label_length + hash_length < hash_length );
Hanno Becker580fba12018-11-13 20:50:45 +00004861 if( overflow )
4862 return( PSA_ERROR_INVALID_ARGUMENT );
4863
4864 tls12_prf->Ai_with_seed = mbedtls_calloc( 1, Ai_with_seed_len );
4865 if( tls12_prf->Ai_with_seed == NULL )
4866 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4867 tls12_prf->Ai_with_seed_len = Ai_with_seed_len;
4868
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004869 /* Write `label + seed' at the end of the `A(i) + seed` buffer,
4870 * leaving the initial `hash_length` bytes unspecified for now. */
Hanno Becker353e4532018-11-15 09:53:57 +00004871 if( label_length != 0 )
4872 {
4873 memcpy( tls12_prf->Ai_with_seed + hash_length,
4874 label, label_length );
4875 }
4876
4877 if( salt_length != 0 )
4878 {
4879 memcpy( tls12_prf->Ai_with_seed + hash_length + label_length,
4880 salt, salt_length );
4881 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004882
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004883 /* The first block gets generated when
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004884 * psa_key_derivation_output_bytes() is called. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004885 tls12_prf->block_number = 0;
4886 tls12_prf->offset_in_block = hash_length;
4887
4888 return( PSA_SUCCESS );
4889}
Janos Follath71a4c912019-06-11 09:14:47 +01004890#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Becker1aaedc02018-11-16 11:35:34 +00004891
Janos Follath71a4c912019-06-11 09:14:47 +01004892#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004893/* Set up a TLS-1.2-PSK-to-MS-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004894static psa_status_t psa_key_derivation_tls12_psk_to_ms_setup(
4895 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004896 const uint8_t *psk,
Hanno Becker1aaedc02018-11-16 11:35:34 +00004897 size_t psk_len,
4898 psa_algorithm_t hash_alg,
4899 const uint8_t *salt,
4900 size_t salt_length,
4901 const uint8_t *label,
4902 size_t label_length )
4903{
4904 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004905 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
Hanno Becker1aaedc02018-11-16 11:35:34 +00004906
4907 if( psk_len > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4908 return( PSA_ERROR_INVALID_ARGUMENT );
4909
4910 /* Quoting RFC 4279, Section 2:
4911 *
4912 * The premaster secret is formed as follows: if the PSK is N octets
4913 * long, concatenate a uint16 with the value N, N zero octets, a second
4914 * uint16 with the value N, and the PSK itself.
4915 */
4916
4917 pms[0] = ( psk_len >> 8 ) & 0xff;
4918 pms[1] = ( psk_len >> 0 ) & 0xff;
4919 memset( pms + 2, 0, psk_len );
4920 pms[2 + psk_len + 0] = pms[0];
4921 pms[2 + psk_len + 1] = pms[1];
4922 memcpy( pms + 4 + psk_len, psk, psk_len );
4923
Gilles Peskinecbe66502019-05-16 16:59:18 +02004924 status = psa_key_derivation_tls12_prf_setup( tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004925 pms, 4 + 2 * psk_len,
4926 hash_alg,
4927 salt, salt_length,
4928 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004929
Gilles Peskine3f108122018-12-07 18:14:53 +01004930 mbedtls_platform_zeroize( pms, sizeof( pms ) );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004931 return( status );
4932}
Janos Follath71a4c912019-06-11 09:14:47 +01004933#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01004934#endif /* MBEDTLS_MD_C */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004935
Janos Follath71a4c912019-06-11 09:14:47 +01004936#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004937/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004938 * to potentially free embedded data structures and wipe confidential data.
4939 */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004940static psa_status_t psa_key_derivation_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004941 psa_key_derivation_operation_t *operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004942 const uint8_t *secret, size_t secret_length,
4943 psa_algorithm_t alg,
4944 const uint8_t *salt, size_t salt_length,
4945 const uint8_t *label, size_t label_length,
4946 size_t capacity )
4947{
4948 psa_status_t status;
4949 size_t max_capacity;
4950
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004951 /* Set operation->alg even on failure so that abort knows what to do. */
4952 operation->alg = alg;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004953
4954#if defined(MBEDTLS_MD_C)
4955 if( PSA_ALG_IS_HKDF( alg ) )
4956 {
4957 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4958 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4959 if( hash_size == 0 )
4960 return( PSA_ERROR_NOT_SUPPORTED );
4961 max_capacity = 255 * hash_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004962 status = psa_key_derivation_hkdf_setup( &operation->ctx.hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004963 secret, secret_length,
4964 hash_alg,
4965 salt, salt_length,
4966 label, label_length );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004967 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00004968 /* TLS-1.2 PRF and TLS-1.2 PSK-to-MS are very similar, so share code. */
4969 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
4970 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004971 {
4972 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4973 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4974
4975 /* TLS-1.2 PRF supports only SHA-256 and SHA-384. */
4976 if( hash_alg != PSA_ALG_SHA_256 &&
4977 hash_alg != PSA_ALG_SHA_384 )
4978 {
4979 return( PSA_ERROR_NOT_SUPPORTED );
4980 }
4981
4982 max_capacity = 255 * hash_size;
Hanno Becker1aaedc02018-11-16 11:35:34 +00004983
4984 if( PSA_ALG_IS_TLS12_PRF( alg ) )
4985 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004986 status = psa_key_derivation_tls12_prf_setup( &operation->ctx.tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004987 secret, secret_length,
4988 hash_alg, salt, salt_length,
4989 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004990 }
4991 else
4992 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004993 status = psa_key_derivation_tls12_psk_to_ms_setup(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004994 &operation->ctx.tls12_prf,
Hanno Becker1aaedc02018-11-16 11:35:34 +00004995 secret, secret_length,
4996 hash_alg, salt, salt_length,
4997 label, label_length );
4998 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004999 }
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005000 else
5001#endif
5002 {
5003 return( PSA_ERROR_NOT_SUPPORTED );
5004 }
5005
5006 if( status != PSA_SUCCESS )
5007 return( status );
5008
5009 if( capacity <= max_capacity )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005010 operation->capacity = capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005011 else if( capacity == PSA_KEY_DERIVATION_UNLIMITED_CAPACITY )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005012 operation->capacity = max_capacity;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005013 else
5014 return( PSA_ERROR_INVALID_ARGUMENT );
5015
5016 return( PSA_SUCCESS );
5017}
Janos Follath71a4c912019-06-11 09:14:47 +01005018#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005019
Janos Follath71a4c912019-06-11 09:14:47 +01005020#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005021psa_status_t psa_key_derivation( psa_key_derivation_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01005022 psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +02005023 psa_algorithm_t alg,
5024 const uint8_t *salt,
5025 size_t salt_length,
5026 const uint8_t *label,
5027 size_t label_length,
5028 size_t capacity )
5029{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005030 psa_key_slot_t *slot;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005031 psa_status_t status;
5032
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005033 if( operation->alg != 0 )
Gilles Peskineea0fb492018-07-12 17:17:20 +02005034 return( PSA_ERROR_BAD_STATE );
5035
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005036 /* Make sure that alg is a key derivation algorithm. This prevents
5037 * key selection algorithms, which psa_key_derivation_internal
5038 * accepts for the sake of key agreement. */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005039 if( ! PSA_ALG_IS_KEY_DERIVATION( alg ) )
5040 return( PSA_ERROR_INVALID_ARGUMENT );
5041
Gilles Peskine28f8f302019-07-24 13:30:31 +02005042 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005043 if( status != PSA_SUCCESS )
5044 return( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005045
Gilles Peskine8e338702019-07-30 20:06:31 +02005046 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005047 return( PSA_ERROR_INVALID_ARGUMENT );
5048
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005049 status = psa_key_derivation_internal( operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005050 slot->data.raw.data,
5051 slot->data.raw.bytes,
5052 alg,
5053 salt, salt_length,
5054 label, label_length,
5055 capacity );
5056 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005057 psa_key_derivation_abort( operation );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005058 return( status );
5059}
Janos Follath71a4c912019-06-11 09:14:47 +01005060#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005061
Gilles Peskine969c5d62019-01-16 15:53:06 +01005062static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005063 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005064 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005065{
Janos Follath5fe19732019-06-20 15:09:30 +01005066 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5067 * initialisers for this union leave some bytes unspecified.) */
5068 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5069
Gilles Peskine969c5d62019-01-16 15:53:06 +01005070 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005071#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005072 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5073 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5074 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005075 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005076 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005077 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5078 if( hash_size == 0 )
5079 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005080 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5081 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005082 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005083 {
5084 return( PSA_ERROR_NOT_SUPPORTED );
5085 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005086 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005087 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005088 }
5089#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005090 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005091 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005092}
5093
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005094psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005095 psa_algorithm_t alg )
5096{
5097 psa_status_t status;
5098
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005099 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005100 return( PSA_ERROR_BAD_STATE );
5101
Gilles Peskine6843c292019-01-18 16:44:49 +01005102 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5103 return( PSA_ERROR_INVALID_ARGUMENT );
5104 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005105 {
5106 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005107 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005108 }
5109 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5110 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005111 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005112 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005113 else
5114 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005115
5116 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005117 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005118 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005119}
5120
5121#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005122static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005123 psa_algorithm_t hash_alg,
5124 psa_key_derivation_step_t step,
5125 const uint8_t *data,
5126 size_t data_length )
5127{
5128 psa_status_t status;
5129 switch( step )
5130 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005131 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005132 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005133 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005134 status = psa_hmac_setup_internal( &hkdf->hmac,
5135 data, data_length,
5136 hash_alg );
5137 if( status != PSA_SUCCESS )
5138 return( status );
5139 hkdf->state = HKDF_STATE_STARTED;
5140 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005141 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005142 /* If no salt was provided, use an empty salt. */
5143 if( hkdf->state == HKDF_STATE_INIT )
5144 {
5145 status = psa_hmac_setup_internal( &hkdf->hmac,
5146 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005147 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005148 if( status != PSA_SUCCESS )
5149 return( status );
5150 hkdf->state = HKDF_STATE_STARTED;
5151 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005152 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005153 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005154 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5155 data, data_length );
5156 if( status != PSA_SUCCESS )
5157 return( status );
5158 status = psa_hmac_finish_internal( &hkdf->hmac,
5159 hkdf->prk,
5160 sizeof( hkdf->prk ) );
5161 if( status != PSA_SUCCESS )
5162 return( status );
5163 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5164 hkdf->block_number = 0;
5165 hkdf->state = HKDF_STATE_KEYED;
5166 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005167 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005168 if( hkdf->state == HKDF_STATE_OUTPUT )
5169 return( PSA_ERROR_BAD_STATE );
5170 if( hkdf->info_set )
5171 return( PSA_ERROR_BAD_STATE );
5172 hkdf->info_length = data_length;
5173 if( data_length != 0 )
5174 {
5175 hkdf->info = mbedtls_calloc( 1, data_length );
5176 if( hkdf->info == NULL )
5177 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5178 memcpy( hkdf->info, data, data_length );
5179 }
5180 hkdf->info_set = 1;
5181 return( PSA_SUCCESS );
5182 default:
5183 return( PSA_ERROR_INVALID_ARGUMENT );
5184 }
5185}
Janos Follathb03233e2019-06-11 15:30:30 +01005186
5187#if defined(PSA_PRE_1_0_KEY_DERIVATION)
5188static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5189 psa_algorithm_t hash_alg,
5190 psa_key_derivation_step_t step,
5191 const uint8_t *data,
5192 size_t data_length )
5193{
5194 (void) prf;
5195 (void) hash_alg;
5196 (void) step;
5197 (void) data;
5198 (void) data_length;
5199
5200 return( PSA_ERROR_INVALID_ARGUMENT );
5201}
Janos Follath6660f0e2019-06-17 08:44:03 +01005202
5203static psa_status_t psa_tls12_prf_psk_to_ms_input(
5204 psa_tls12_prf_key_derivation_t *prf,
5205 psa_algorithm_t hash_alg,
5206 psa_key_derivation_step_t step,
5207 const uint8_t *data,
5208 size_t data_length )
5209{
5210 (void) prf;
5211 (void) hash_alg;
5212 (void) step;
5213 (void) data;
5214 (void) data_length;
5215
5216 return( PSA_ERROR_INVALID_ARGUMENT );
5217}
Janos Follathb03233e2019-06-11 15:30:30 +01005218#else
Janos Follathf08e2652019-06-13 09:05:41 +01005219static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5220 const uint8_t *data,
5221 size_t data_length )
5222{
5223 if( prf->state != TLS12_PRF_STATE_INIT )
5224 return( PSA_ERROR_BAD_STATE );
5225
Janos Follathd6dce9f2019-07-04 09:11:38 +01005226 if( data_length != 0 )
5227 {
5228 prf->seed = mbedtls_calloc( 1, data_length );
5229 if( prf->seed == NULL )
5230 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005231
Janos Follathd6dce9f2019-07-04 09:11:38 +01005232 memcpy( prf->seed, data, data_length );
5233 prf->seed_length = data_length;
5234 }
Janos Follathf08e2652019-06-13 09:05:41 +01005235
5236 prf->state = TLS12_PRF_STATE_SEED_SET;
5237
5238 return( PSA_SUCCESS );
5239}
5240
Janos Follath81550542019-06-13 14:26:34 +01005241static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5242 psa_algorithm_t hash_alg,
5243 const uint8_t *data,
5244 size_t data_length )
5245{
5246 psa_status_t status;
5247 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5248 return( PSA_ERROR_BAD_STATE );
5249
5250 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5251 if( status != PSA_SUCCESS )
5252 return( status );
5253
5254 prf->state = TLS12_PRF_STATE_KEY_SET;
5255
5256 return( PSA_SUCCESS );
5257}
5258
Janos Follath6660f0e2019-06-17 08:44:03 +01005259static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5260 psa_tls12_prf_key_derivation_t *prf,
5261 psa_algorithm_t hash_alg,
5262 const uint8_t *data,
5263 size_t data_length )
5264{
5265 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005266 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5267 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005268
5269 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5270 return( PSA_ERROR_INVALID_ARGUMENT );
5271
5272 /* Quoting RFC 4279, Section 2:
5273 *
5274 * The premaster secret is formed as follows: if the PSK is N octets
5275 * long, concatenate a uint16 with the value N, N zero octets, a second
5276 * uint16 with the value N, and the PSK itself.
5277 */
5278
Janos Follath40e13932019-06-26 13:22:29 +01005279 *cur++ = ( data_length >> 8 ) & 0xff;
5280 *cur++ = ( data_length >> 0 ) & 0xff;
5281 memset( cur, 0, data_length );
5282 cur += data_length;
5283 *cur++ = pms[0];
5284 *cur++ = pms[1];
5285 memcpy( cur, data, data_length );
5286 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005287
Janos Follath40e13932019-06-26 13:22:29 +01005288 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005289
5290 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5291 return( status );
5292}
5293
Janos Follath63028dd2019-06-13 09:15:47 +01005294static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5295 const uint8_t *data,
5296 size_t data_length )
5297{
5298 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5299 return( PSA_ERROR_BAD_STATE );
5300
Janos Follathd6dce9f2019-07-04 09:11:38 +01005301 if( data_length != 0 )
5302 {
5303 prf->label = mbedtls_calloc( 1, data_length );
5304 if( prf->label == NULL )
5305 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005306
Janos Follathd6dce9f2019-07-04 09:11:38 +01005307 memcpy( prf->label, data, data_length );
5308 prf->label_length = data_length;
5309 }
Janos Follath63028dd2019-06-13 09:15:47 +01005310
5311 prf->state = TLS12_PRF_STATE_LABEL_SET;
5312
5313 return( PSA_SUCCESS );
5314}
5315
Janos Follathb03233e2019-06-11 15:30:30 +01005316static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5317 psa_algorithm_t hash_alg,
5318 psa_key_derivation_step_t step,
5319 const uint8_t *data,
5320 size_t data_length )
5321{
Janos Follathb03233e2019-06-11 15:30:30 +01005322 switch( step )
5323 {
Janos Follathf08e2652019-06-13 09:05:41 +01005324 case PSA_KEY_DERIVATION_INPUT_SEED:
5325 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005326 case PSA_KEY_DERIVATION_INPUT_SECRET:
5327 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005328 case PSA_KEY_DERIVATION_INPUT_LABEL:
5329 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005330 default:
5331 return( PSA_ERROR_INVALID_ARGUMENT );
5332 }
5333}
Janos Follath6660f0e2019-06-17 08:44:03 +01005334
5335static psa_status_t psa_tls12_prf_psk_to_ms_input(
5336 psa_tls12_prf_key_derivation_t *prf,
5337 psa_algorithm_t hash_alg,
5338 psa_key_derivation_step_t step,
5339 const uint8_t *data,
5340 size_t data_length )
5341{
5342 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005343 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005344 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5345 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005346 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005347
5348 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5349}
Janos Follathb03233e2019-06-11 15:30:30 +01005350#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005351#endif /* MBEDTLS_MD_C */
5352
Janos Follathb80a94e2019-06-12 15:54:46 +01005353static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005354 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005355 psa_key_derivation_step_t step,
5356 const uint8_t *data,
5357 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005358{
5359 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005360 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005361
5362#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005363 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005364 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005365 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005366 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005367 step, data, data_length );
5368 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005369 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005370#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005371#if defined(MBEDTLS_MD_C)
Janos Follath6660f0e2019-06-17 08:44:03 +01005372 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005373 {
Janos Follathb03233e2019-06-11 15:30:30 +01005374 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5375 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5376 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005377 }
5378 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5379 {
5380 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5381 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5382 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005383 }
5384 else
5385#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005386 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005387 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005388 return( PSA_ERROR_BAD_STATE );
5389 }
5390
5391 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005392 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005393 return( status );
5394}
5395
Janos Follath51f4a0f2019-06-14 11:35:55 +01005396psa_status_t psa_key_derivation_input_bytes(
5397 psa_key_derivation_operation_t *operation,
5398 psa_key_derivation_step_t step,
5399 const uint8_t *data,
5400 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005401{
Janos Follathc5621512019-06-14 11:27:57 +01005402 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5403 return( PSA_ERROR_INVALID_ARGUMENT );
5404
5405 return( psa_key_derivation_input_internal( operation, step,
5406 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005407}
5408
Janos Follath51f4a0f2019-06-14 11:35:55 +01005409psa_status_t psa_key_derivation_input_key(
5410 psa_key_derivation_operation_t *operation,
5411 psa_key_derivation_step_t step,
5412 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005413{
5414 psa_key_slot_t *slot;
5415 psa_status_t status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02005416 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005417 PSA_KEY_USAGE_DERIVE,
5418 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005419 if( status != PSA_SUCCESS )
5420 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02005421 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005422 return( PSA_ERROR_INVALID_ARGUMENT );
5423 /* Don't allow a key to be used as an input that is usually public.
5424 * This is debatable. It's ok from a cryptographic perspective to
5425 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005426 * the material should be dedicated to a particular input step,
5427 * otherwise this may allow the key to be used in an unintended way
5428 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005429 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005430 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005431 return( psa_key_derivation_input_internal( operation,
5432 step,
5433 slot->data.raw.data,
5434 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005435}
5436
Gilles Peskineea0fb492018-07-12 17:17:20 +02005437
5438
5439/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005440/* Key agreement */
5441/****************************************************************/
5442
Gilles Peskinea05219c2018-11-16 16:02:56 +01005443#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005444static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5445 size_t peer_key_length,
5446 const mbedtls_ecp_keypair *our_key,
5447 uint8_t *shared_secret,
5448 size_t shared_secret_size,
5449 size_t *shared_secret_length )
5450{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005451 mbedtls_ecp_keypair *their_key = NULL;
5452 mbedtls_ecdh_context ecdh;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005453 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005454 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005455
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005456 status = psa_import_ec_public_key(
5457 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5458 peer_key, peer_key_length,
5459 &their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005460 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005461 goto exit;
Gilles Peskineb4086612018-11-14 20:51:23 +01005462
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005463 status = mbedtls_to_psa_error(
5464 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5465 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005466 goto exit;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005467 status = mbedtls_to_psa_error(
5468 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5469 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005470 goto exit;
5471
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005472 status = mbedtls_to_psa_error(
5473 mbedtls_ecdh_calc_secret( &ecdh,
5474 shared_secret_length,
5475 shared_secret, shared_secret_size,
5476 mbedtls_ctr_drbg_random,
5477 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005478
5479exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005480 mbedtls_ecdh_free( &ecdh );
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005481 mbedtls_ecp_keypair_free( their_key );
5482 mbedtls_free( their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005483 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005484}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005485#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005486
Gilles Peskine01d718c2018-09-18 12:01:02 +02005487#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5488
Gilles Peskine0216fe12019-04-11 21:23:21 +02005489static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5490 psa_key_slot_t *private_key,
5491 const uint8_t *peer_key,
5492 size_t peer_key_length,
5493 uint8_t *shared_secret,
5494 size_t shared_secret_size,
5495 size_t *shared_secret_length )
5496{
5497 switch( alg )
5498 {
5499#if defined(MBEDTLS_ECDH_C)
5500 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005501 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005502 return( PSA_ERROR_INVALID_ARGUMENT );
5503 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5504 private_key->data.ecp,
5505 shared_secret, shared_secret_size,
5506 shared_secret_length ) );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005507#endif /* MBEDTLS_ECDH_C */
5508 default:
5509 (void) private_key;
5510 (void) peer_key;
5511 (void) peer_key_length;
5512 (void) shared_secret;
5513 (void) shared_secret_size;
5514 (void) shared_secret_length;
5515 return( PSA_ERROR_NOT_SUPPORTED );
5516 }
5517}
5518
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005519/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005520 * to potentially free embedded data structures and wipe confidential data.
5521 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005522static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005523 psa_key_derivation_step_t step,
Gilles Peskine2f060a82018-12-04 17:12:32 +01005524 psa_key_slot_t *private_key,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005525 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005526 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005527{
5528 psa_status_t status;
5529 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5530 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005531 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005532
5533 /* Step 1: run the secret agreement algorithm to generate the shared
5534 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005535 status = psa_key_agreement_raw_internal( ka_alg,
5536 private_key,
5537 peer_key, peer_key_length,
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005538 shared_secret,
5539 sizeof( shared_secret ),
5540 &shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005541 if( status != PSA_SUCCESS )
5542 goto exit;
5543
5544 /* Step 2: set up the key derivation to generate key material from
5545 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005546 status = psa_key_derivation_input_internal( operation, step,
5547 shared_secret,
5548 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005549
Gilles Peskine01d718c2018-09-18 12:01:02 +02005550exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005551 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005552 return( status );
5553}
5554
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005555psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005556 psa_key_derivation_step_t step,
5557 psa_key_handle_t private_key,
5558 const uint8_t *peer_key,
5559 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005560{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005561 psa_key_slot_t *slot;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005562 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005563 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005564 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005565 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005566 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005567 if( status != PSA_SUCCESS )
5568 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005569 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005570 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005571 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005572 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005573 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005574 return( status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005575}
5576
Gilles Peskinebe697d82019-05-16 18:00:41 +02005577psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5578 psa_key_handle_t private_key,
5579 const uint8_t *peer_key,
5580 size_t peer_key_length,
5581 uint8_t *output,
5582 size_t output_size,
5583 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005584{
5585 psa_key_slot_t *slot;
5586 psa_status_t status;
5587
5588 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5589 {
5590 status = PSA_ERROR_INVALID_ARGUMENT;
5591 goto exit;
5592 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005593 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005594 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005595 if( status != PSA_SUCCESS )
5596 goto exit;
5597
5598 status = psa_key_agreement_raw_internal( alg, slot,
5599 peer_key, peer_key_length,
5600 output, output_size,
5601 output_length );
5602
5603exit:
5604 if( status != PSA_SUCCESS )
5605 {
5606 /* If an error happens and is not handled properly, the output
5607 * may be used as a key to protect sensitive data. Arrange for such
5608 * a key to be random, which is likely to result in decryption or
5609 * verification errors. This is better than filling the buffer with
5610 * some constant data such as zeros, which would result in the data
5611 * being protected with a reproducible, easily knowable key.
5612 */
5613 psa_generate_random( output, output_size );
5614 *output_length = output_size;
5615 }
5616 return( status );
5617}
Gilles Peskine01d718c2018-09-18 12:01:02 +02005618
5619
5620/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005621/* Random generation */
Gilles Peskine05d69892018-06-19 22:00:52 +02005622/****************************************************************/
5623
5624psa_status_t psa_generate_random( uint8_t *output,
5625 size_t output_size )
5626{
itayzafrir0adf0fc2018-09-06 16:24:41 +03005627 int ret;
5628 GUARD_MODULE_INITIALIZED;
5629
5630 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
Gilles Peskine05d69892018-06-19 22:00:52 +02005631 return( mbedtls_to_psa_error( ret ) );
5632}
5633
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005634#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5635#include "mbedtls/entropy_poll.h"
avolinski13beb102018-11-20 16:51:49 +02005636
Gilles Peskine7228da22019-07-15 11:06:15 +02005637psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005638 size_t seed_size )
5639{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005640 if( global_data.initialized )
5641 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005642
5643 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5644 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5645 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5646 return( PSA_ERROR_INVALID_ARGUMENT );
5647
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005648 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005649}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005650#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005651
Gilles Peskinee56e8782019-04-26 17:34:02 +02005652#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5653static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5654 size_t domain_parameters_size,
5655 int *exponent )
5656{
5657 size_t i;
5658 uint32_t acc = 0;
5659
5660 if( domain_parameters_size == 0 )
5661 {
5662 *exponent = 65537;
5663 return( PSA_SUCCESS );
5664 }
5665
5666 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5667 * support values that fit in a 32-bit integer, which is larger than
5668 * int on just about every platform anyway. */
5669 if( domain_parameters_size > sizeof( acc ) )
5670 return( PSA_ERROR_NOT_SUPPORTED );
5671 for( i = 0; i < domain_parameters_size; i++ )
5672 acc = ( acc << 8 ) | domain_parameters[i];
5673 if( acc > INT_MAX )
5674 return( PSA_ERROR_NOT_SUPPORTED );
5675 *exponent = acc;
5676 return( PSA_SUCCESS );
5677}
5678#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5679
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005680static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005681 psa_key_slot_t *slot, size_t bits,
5682 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskine05d69892018-06-19 22:00:52 +02005683{
Gilles Peskine8e338702019-07-30 20:06:31 +02005684 psa_key_type_t type = slot->attr.type;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005685
Gilles Peskinee56e8782019-04-26 17:34:02 +02005686 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005687 return( PSA_ERROR_INVALID_ARGUMENT );
5688
Gilles Peskine48c0ea12018-06-21 14:15:31 +02005689 if( key_type_is_raw_bytes( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005690 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005691 psa_status_t status;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005692 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005693 if( status != PSA_SUCCESS )
5694 return( status );
5695 status = psa_generate_random( slot->data.raw.data,
5696 slot->data.raw.bytes );
5697 if( status != PSA_SUCCESS )
5698 {
5699 mbedtls_free( slot->data.raw.data );
5700 return( status );
5701 }
5702#if defined(MBEDTLS_DES_C)
5703 if( type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005704 psa_des_set_key_parity( slot->data.raw.data,
5705 slot->data.raw.bytes );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005706#endif /* MBEDTLS_DES_C */
5707 }
5708 else
5709
5710#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005711 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005712 {
5713 mbedtls_rsa_context *rsa;
5714 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005715 int exponent;
5716 psa_status_t status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005717 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5718 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine86a440b2018-11-12 18:39:40 +01005719 /* Accept only byte-aligned keys, for the same reasons as
5720 * in psa_import_rsa_key(). */
5721 if( bits % 8 != 0 )
5722 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005723 status = psa_read_rsa_exponent( domain_parameters,
5724 domain_parameters_size,
5725 &exponent );
5726 if( status != PSA_SUCCESS )
5727 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005728 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5729 if( rsa == NULL )
5730 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5731 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5732 ret = mbedtls_rsa_gen_key( rsa,
5733 mbedtls_ctr_drbg_random,
5734 &global_data.ctr_drbg,
Jaeden Amero23bbb752018-06-26 14:16:54 +01005735 (unsigned int) bits,
Gilles Peskine12313cd2018-06-20 00:20:32 +02005736 exponent );
5737 if( ret != 0 )
5738 {
5739 mbedtls_rsa_free( rsa );
5740 mbedtls_free( rsa );
5741 return( mbedtls_to_psa_error( ret ) );
5742 }
5743 slot->data.rsa = rsa;
5744 }
5745 else
5746#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5747
5748#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005749 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005750 {
5751 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5752 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5753 const mbedtls_ecp_curve_info *curve_info =
5754 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5755 mbedtls_ecp_keypair *ecp;
5756 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005757 if( domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005758 return( PSA_ERROR_NOT_SUPPORTED );
5759 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5760 return( PSA_ERROR_NOT_SUPPORTED );
5761 if( curve_info->bit_size != bits )
5762 return( PSA_ERROR_INVALID_ARGUMENT );
5763 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5764 if( ecp == NULL )
5765 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5766 mbedtls_ecp_keypair_init( ecp );
5767 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5768 mbedtls_ctr_drbg_random,
5769 &global_data.ctr_drbg );
5770 if( ret != 0 )
5771 {
5772 mbedtls_ecp_keypair_free( ecp );
5773 mbedtls_free( ecp );
5774 return( mbedtls_to_psa_error( ret ) );
5775 }
5776 slot->data.ecp = ecp;
5777 }
5778 else
5779#endif /* MBEDTLS_ECP_C */
5780
5781 return( PSA_ERROR_NOT_SUPPORTED );
5782
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005783 return( PSA_SUCCESS );
5784}
5785
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005786psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005787 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005788{
5789 psa_status_t status;
5790 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005791 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine011e4282019-06-26 18:34:38 +02005792 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005793#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5794 if( driver != NULL )
5795 {
5796 /* Generating a key in a secure element is not implemented yet. */
5797 status = PSA_ERROR_NOT_SUPPORTED;
5798 }
5799#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005800 if( status == PSA_SUCCESS )
5801 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005802 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005803 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005804 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005805 }
5806 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005807 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005808 if( status != PSA_SUCCESS )
5809 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005810 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005811 *handle = 0;
5812 }
5813 return( status );
5814}
5815
5816
Gilles Peskine05d69892018-06-19 22:00:52 +02005817
5818/****************************************************************/
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01005819/* Module setup */
5820/****************************************************************/
5821
Gilles Peskine5e769522018-11-20 21:59:56 +01005822psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5823 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5824 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5825{
5826 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5827 return( PSA_ERROR_BAD_STATE );
5828 global_data.entropy_init = entropy_init;
5829 global_data.entropy_free = entropy_free;
5830 return( PSA_SUCCESS );
5831}
5832
Gilles Peskinee59236f2018-01-27 23:32:46 +01005833void mbedtls_psa_crypto_free( void )
5834{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005835 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005836 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5837 {
5838 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005839 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005840 }
5841 /* Wipe all remaining data, including configuration.
5842 * In particular, this sets all state indicator to the value
5843 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005844 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005845#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005846 /* Unregister all secure element drivers, so that we restart from
5847 * a pristine state. */
5848 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005849#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005850}
5851
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005852#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5853/** Recover a transaction that was interrupted by a power failure.
5854 *
5855 * This function is called during initialization, before psa_crypto_init()
5856 * returns. If this function returns a failure status, the initialization
5857 * fails.
5858 */
5859static psa_status_t psa_crypto_recover_transaction(
5860 const psa_crypto_transaction_t *transaction )
5861{
5862 switch( transaction->unknown.type )
5863 {
5864 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5865 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
5866 /* TOnogrepDO - fall through to the failure case until this
5867 * is implemented */
5868 default:
5869 /* We found an unsupported transaction in the storage.
5870 * We don't know what state the storage is in. Give up. */
5871 return( PSA_ERROR_STORAGE_FAILURE );
5872 }
5873}
5874#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5875
Gilles Peskinee59236f2018-01-27 23:32:46 +01005876psa_status_t psa_crypto_init( void )
5877{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005878 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005879 const unsigned char drbg_seed[] = "PSA";
5880
Gilles Peskinec6b69072018-11-20 21:42:52 +01005881 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005882 if( global_data.initialized != 0 )
5883 return( PSA_SUCCESS );
5884
Gilles Peskine5e769522018-11-20 21:59:56 +01005885 /* Set default configuration if
5886 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5887 if( global_data.entropy_init == NULL )
5888 global_data.entropy_init = mbedtls_entropy_init;
5889 if( global_data.entropy_free == NULL )
5890 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005891
Gilles Peskinec6b69072018-11-20 21:42:52 +01005892 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005893 global_data.entropy_init( &global_data.entropy );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005894 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005895 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005896 status = mbedtls_to_psa_error(
5897 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5898 mbedtls_entropy_func,
5899 &global_data.entropy,
5900 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5901 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005902 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005903 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005904
Gilles Peskine66fb1262018-12-10 16:29:04 +01005905 status = psa_initialize_key_slots( );
5906 if( status != PSA_SUCCESS )
5907 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005908
Gilles Peskine4b734222019-07-24 15:56:31 +02005909#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005910 status = psa_crypto_load_transaction( );
5911 if( status == PSA_SUCCESS )
5912 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005913 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5914 if( status != PSA_SUCCESS )
5915 goto exit;
5916 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005917 }
5918 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5919 {
5920 /* There's no transaction to complete. It's all good. */
5921 status = PSA_SUCCESS;
5922 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005923#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005924
Gilles Peskinec6b69072018-11-20 21:42:52 +01005925 /* All done. */
Gilles Peskinee4ebc122018-03-07 14:16:44 +01005926 global_data.initialized = 1;
5927
Gilles Peskinee59236f2018-01-27 23:32:46 +01005928exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005929 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005930 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005931 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005932}
5933
5934#endif /* MBEDTLS_PSA_CRYPTO_C */