blob: 08f9476f97f7b96b81c326f054447b326f6121d4 [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 */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200717static psa_key_bits_t psa_calculate_key_bits( const psa_key_slot_t *slot )
Gilles Peskineb46bef22019-07-30 21:32:04 +0200718{
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200719 size_t bits = 0; /* return 0 on an empty slot */
720
Gilles Peskineb46bef22019-07-30 21:32:04 +0200721 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200722 bits = PSA_BYTES_TO_BITS( slot->data.raw.bytes );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200723#if defined(MBEDTLS_RSA_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200724 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
725 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200726#endif /* defined(MBEDTLS_RSA_C) */
727#if defined(MBEDTLS_ECP_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200728 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
729 bits = slot->data.ecp->grp.pbits;
Gilles Peskineb46bef22019-07-30 21:32:04 +0200730#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200731
732 /* We know that the size fits in psa_key_bits_t thanks to checks
733 * when the key was created. */
734 return( (psa_key_bits_t) bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200735}
736
Gilles Peskine8e338702019-07-30 20:06:31 +0200737/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100738 * previously. This function assumes that the slot does not contain
739 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100740psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
741 const uint8_t *data,
742 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100743{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200744 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100745
Gilles Peskine8e338702019-07-30 20:06:31 +0200746 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100747 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200748 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200749 /* Ensure that the bytes-to-bit conversion didn't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100750 if( data_length > SIZE_MAX / 8 )
751 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200752 /* Enforce a size limit, and in particular ensure that the bit
753 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200754 if( bit_size > PSA_MAX_KEY_BITS )
755 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine8e338702019-07-30 20:06:31 +0200756 status = prepare_raw_data_slot( slot->attr.type, bit_size,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200757 &slot->data.raw );
758 if( status != PSA_SUCCESS )
759 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200760 if( data_length != 0 )
761 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100762 }
763 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100764#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200765 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100766 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200767 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100768 data, data_length,
769 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100770 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200771 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000772 {
773 status = psa_import_ec_public_key(
Gilles Peskine8e338702019-07-30 20:06:31 +0200774 PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000775 data, data_length,
776 &slot->data.ecp );
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000777 }
Gilles Peskinef76aa772018-10-29 19:24:33 +0100778 else
779#endif /* MBEDTLS_ECP_C */
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000780#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200781 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100782 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200783 status = psa_import_rsa_key( slot->attr.type,
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000784 data, data_length,
785 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100786 }
787 else
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000788#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100789 {
790 return( PSA_ERROR_NOT_SUPPORTED );
791 }
Gilles Peskineb46bef22019-07-30 21:32:04 +0200792
793 if( status == PSA_SUCCESS )
794 {
795 /* Write the actual key size to the slot.
796 * psa_start_key_creation() wrote the size declared by the
797 * caller, which may be 0 (meaning unspecified) or wrong. */
798 slot->attr.bits = psa_calculate_key_bits( slot );
799 }
Jaeden Amero08ad3272019-01-14 13:12:39 +0000800 return( status );
Darryl Green940d72c2018-07-13 13:18:51 +0100801}
802
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100803/** Calculate the intersection of two algorithm usage policies.
804 *
805 * Return 0 (which allows no operation) on incompatibility.
806 */
807static psa_algorithm_t psa_key_policy_algorithm_intersection(
808 psa_algorithm_t alg1,
809 psa_algorithm_t alg2 )
810{
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200811 /* Common case: both sides actually specify the same policy. */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100812 if( alg1 == alg2 )
813 return( alg1 );
814 /* If the policies are from the same hash-and-sign family, check
Gilles Peskinef603c712019-01-19 13:40:11 +0100815 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100816 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
817 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
818 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
819 {
820 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
821 return( alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100822 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100823 return( alg1 );
824 }
825 /* If the policies are incompatible, allow nothing. */
826 return( 0 );
827}
828
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200829static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
830 psa_algorithm_t requested_alg )
831{
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200832 /* Common case: the policy only allows requested_alg. */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200833 if( requested_alg == policy_alg )
834 return( 1 );
835 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200836 * and requested_alg is the same hash-and-sign family with any hash,
837 * then requested_alg is compliant with policy_alg. */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200838 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
839 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
840 {
841 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
842 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
843 }
844 /* If it isn't permitted, it's forbidden. */
845 return( 0 );
846}
847
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100848/** Test whether a policy permits an algorithm.
849 *
850 * The caller must test usage flags separately.
851 */
852static int psa_key_policy_permits( const psa_key_policy_t *policy,
853 psa_algorithm_t alg )
854{
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200855 return( psa_key_algorithm_permits( policy->alg, alg ) ||
856 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100857}
858
Gilles Peskinef603c712019-01-19 13:40:11 +0100859/** Restrict a key policy based on a constraint.
860 *
861 * \param[in,out] policy The policy to restrict.
862 * \param[in] constraint The policy constraint to apply.
863 *
864 * \retval #PSA_SUCCESS
865 * \c *policy contains the intersection of the original value of
866 * \c *policy and \c *constraint.
867 * \retval #PSA_ERROR_INVALID_ARGUMENT
868 * \c *policy and \c *constraint are incompatible.
869 * \c *policy is unchanged.
870 */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100871static psa_status_t psa_restrict_key_policy(
872 psa_key_policy_t *policy,
873 const psa_key_policy_t *constraint )
874{
875 psa_algorithm_t intersection_alg =
876 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200877 psa_algorithm_t intersection_alg2 =
878 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100879 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
880 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200881 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
882 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100883 policy->usage &= constraint->usage;
Gilles Peskinef603c712019-01-19 13:40:11 +0100884 policy->alg = intersection_alg;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200885 policy->alg2 = intersection_alg2;
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100886 return( PSA_SUCCESS );
887}
888
Darryl Green06fd18d2018-07-16 11:21:11 +0100889/** Retrieve a slot which must contain a key. The key must have allow all the
890 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
891 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100892static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100893 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100894 psa_key_usage_t usage,
895 psa_algorithm_t alg )
896{
897 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100898 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100899
900 *p_slot = NULL;
901
Gilles Peskinec5487a82018-12-03 18:08:14 +0100902 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100903 if( status != PSA_SUCCESS )
904 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100905
906 /* Enforce that usage policy for the key slot contains all the flags
907 * required by the usage parameter. There is one exception: public
908 * keys can always be exported, so we treat public key objects as
909 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200910 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100911 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +0200912 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +0100913 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914
915 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200916 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100917 return( PSA_ERROR_NOT_PERMITTED );
918
919 *p_slot = slot;
920 return( PSA_SUCCESS );
921}
Darryl Green940d72c2018-07-13 13:18:51 +0100922
Gilles Peskine28f8f302019-07-24 13:30:31 +0200923/** Retrieve a slot which must contain a transparent key.
924 *
925 * A transparent key is a key for which the key material is directly
926 * available, as opposed to a key in a secure element.
927 *
Gilles Peskine60450a42019-07-25 11:32:45 +0200928 * This is a temporary function to use instead of psa_get_key_from_slot()
929 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200930 */
931#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
932static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
933 psa_key_slot_t **p_slot,
934 psa_key_usage_t usage,
935 psa_algorithm_t alg )
936{
937 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
938 if( status != PSA_SUCCESS )
939 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +0200940 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200941 {
942 *p_slot = NULL;
943 return( PSA_ERROR_NOT_SUPPORTED );
944 }
945 return( PSA_SUCCESS );
946}
947#else /* MBEDTLS_PSA_CRYPTO_SE_C */
948/* With no secure element support, all keys are transparent. */
949#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
950 psa_get_key_from_slot( handle, p_slot, usage, alg )
951#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
952
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100953/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100954static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000955{
Gilles Peskine73167e12019-07-12 23:44:37 +0200956#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
957 if( psa_key_slot_is_external( slot ) )
958 {
959 /* No key material to clean. */
960 }
961 else
962#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine8e338702019-07-30 20:06:31 +0200963 if( slot->attr.type == PSA_KEY_TYPE_NONE )
Darryl Green40225ba2018-11-15 14:48:15 +0000964 {
965 /* No key material to clean. */
966 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200967 else if( key_type_is_raw_bytes( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000968 {
969 mbedtls_free( slot->data.raw.data );
970 }
971 else
972#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200973 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000974 {
975 mbedtls_rsa_free( slot->data.rsa );
976 mbedtls_free( slot->data.rsa );
977 }
978 else
979#endif /* defined(MBEDTLS_RSA_C) */
980#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200981 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000982 {
983 mbedtls_ecp_keypair_free( slot->data.ecp );
984 mbedtls_free( slot->data.ecp );
985 }
986 else
987#endif /* defined(MBEDTLS_ECP_C) */
988 {
989 /* Shouldn't happen: the key type is not any type that we
990 * put in. */
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200991 return( PSA_ERROR_CORRUPTION_DETECTED );
Darryl Green40225ba2018-11-15 14:48:15 +0000992 }
993
994 return( PSA_SUCCESS );
995}
996
Gilles Peskine5f25dd02019-01-14 18:24:53 +0100997static void psa_abort_operations_using_key( psa_key_slot_t *slot )
998{
Gilles Peskinec88644d2019-04-12 15:03:38 +0200999 /*FIXME how to implement this?*/
Gilles Peskine5f25dd02019-01-14 18:24:53 +01001000 (void) slot;
1001}
1002
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001003/** Completely wipe a slot in memory, including its policy.
1004 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001005psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001006{
1007 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine5f25dd02019-01-14 18:24:53 +01001008 psa_abort_operations_using_key( slot );
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009 /* At this point, key material and other type-specific content has
1010 * been wiped. Clear remaining metadata. We can call memset and not
1011 * zeroize because the metadata is not particularly sensitive. */
1012 memset( slot, 0, sizeof( *slot ) );
1013 return( status );
1014}
1015
Gilles Peskinec5487a82018-12-03 18:08:14 +01001016psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001017{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001018 psa_key_slot_t *slot;
Darryl Greend49a4992018-06-18 17:27:26 +01001019 psa_status_t status = PSA_SUCCESS;
1020 psa_status_t storage_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001021#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1022 psa_se_drv_table_entry_t *driver;
1023#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001024
Gilles Peskinec5487a82018-12-03 18:08:14 +01001025 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001026 if( status != PSA_SUCCESS )
1027 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001028
1029#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001030 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001031 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001032 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001033 /* For a key in a secure element, we need to do three things:
1034 * remove the key file in internal storage, destroy the
1035 * key inside the secure element, and update the driver's
1036 * persistent data. Start a transaction that will encompass these
1037 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001038 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001039 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001040 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001041 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001042 status = psa_crypto_save_transaction( );
1043 if( status != PSA_SUCCESS )
1044 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001045 (void) psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02001046 /* TOnogrepDO: destroy what can be destroyed anyway */
1047 return( status );
1048 }
1049
Gilles Peskine354f7672019-07-12 23:46:38 +02001050 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskinefc762652019-07-22 19:30:34 +02001051 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001052#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1053
Darryl Greend49a4992018-06-18 17:27:26 +01001054#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001055 if( slot->attr.lifetime == PSA_KEY_LIFETIME_PERSISTENT )
Darryl Greend49a4992018-06-18 17:27:26 +01001056 {
Gilles Peskine69f976b2018-11-30 18:46:56 +01001057 storage_status =
Gilles Peskine8e338702019-07-30 20:06:31 +02001058 psa_destroy_persistent_key( slot->attr.id );
Darryl Greend49a4992018-06-18 17:27:26 +01001059 }
1060#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001061
Gilles Peskinefc762652019-07-22 19:30:34 +02001062#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1063 if( driver != NULL )
1064 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001065 psa_status_t status2;
1066 status = psa_save_se_persistent_data( driver );
1067 status2 = psa_crypto_stop_transaction( );
1068 if( status == PSA_SUCCESS )
1069 status = status2;
Gilles Peskinefc762652019-07-22 19:30:34 +02001070 if( status != PSA_SUCCESS )
1071 {
1072 /* TOnogrepDO: destroy what can be destroyed anyway */
1073 return( status );
1074 }
1075 }
1076#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1077
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001078 status = psa_wipe_key_slot( slot );
Darryl Greend49a4992018-06-18 17:27:26 +01001079 if( status != PSA_SUCCESS )
1080 return( status );
1081 return( storage_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001082}
1083
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001084void psa_reset_key_attributes( psa_key_attributes_t *attributes )
1085{
Gilles Peskineb699f072019-04-26 16:06:02 +02001086 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001087 memset( attributes, 0, sizeof( *attributes ) );
1088}
1089
Gilles Peskineb699f072019-04-26 16:06:02 +02001090psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1091 psa_key_type_t type,
1092 const uint8_t *data,
1093 size_t data_length )
1094{
1095 uint8_t *copy = NULL;
1096
1097 if( data_length != 0 )
1098 {
1099 copy = mbedtls_calloc( 1, data_length );
1100 if( copy == NULL )
1101 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1102 memcpy( copy, data, data_length );
1103 }
1104 /* After this point, this function is guaranteed to succeed, so it
1105 * can start modifying `*attributes`. */
1106
1107 if( attributes->domain_parameters != NULL )
1108 {
1109 mbedtls_free( attributes->domain_parameters );
1110 attributes->domain_parameters = NULL;
1111 attributes->domain_parameters_size = 0;
1112 }
1113
1114 attributes->domain_parameters = copy;
1115 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001116 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001117 return( PSA_SUCCESS );
1118}
1119
1120psa_status_t psa_get_key_domain_parameters(
1121 const psa_key_attributes_t *attributes,
1122 uint8_t *data, size_t data_size, size_t *data_length )
1123{
1124 if( attributes->domain_parameters_size > data_size )
1125 return( PSA_ERROR_BUFFER_TOO_SMALL );
1126 *data_length = attributes->domain_parameters_size;
1127 if( attributes->domain_parameters_size != 0 )
1128 memcpy( data, attributes->domain_parameters,
1129 attributes->domain_parameters_size );
1130 return( PSA_SUCCESS );
1131}
1132
1133#if defined(MBEDTLS_RSA_C)
1134static psa_status_t psa_get_rsa_public_exponent(
1135 const mbedtls_rsa_context *rsa,
1136 psa_key_attributes_t *attributes )
1137{
1138 mbedtls_mpi mpi;
1139 int ret;
1140 uint8_t *buffer = NULL;
1141 size_t buflen;
1142 mbedtls_mpi_init( &mpi );
1143
1144 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1145 if( ret != 0 )
1146 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001147 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1148 {
1149 /* It's the default value, which is reported as an empty string,
1150 * so there's nothing to do. */
1151 goto exit;
1152 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001153
1154 buflen = mbedtls_mpi_size( &mpi );
1155 buffer = mbedtls_calloc( 1, buflen );
1156 if( buffer == NULL )
1157 {
1158 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1159 goto exit;
1160 }
1161 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1162 if( ret != 0 )
1163 goto exit;
1164 attributes->domain_parameters = buffer;
1165 attributes->domain_parameters_size = buflen;
1166
1167exit:
1168 mbedtls_mpi_free( &mpi );
1169 if( ret != 0 )
1170 mbedtls_free( buffer );
1171 return( mbedtls_to_psa_error( ret ) );
1172}
1173#endif /* MBEDTLS_RSA_C */
1174
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001175/** Retrieve all the publicly-accessible attributes of a key.
1176 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001177psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1178 psa_key_attributes_t *attributes )
1179{
1180 psa_key_slot_t *slot;
1181 psa_status_t status;
1182
1183 psa_reset_key_attributes( attributes );
1184
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001185 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001186 if( status != PSA_SUCCESS )
1187 return( status );
1188
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001189 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001190 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1191 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1192
1193#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1194 if( psa_key_slot_is_external( slot ) )
1195 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1196#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001197
Gilles Peskine8e338702019-07-30 20:06:31 +02001198 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001199 {
1200#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001201 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001202 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001203#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1204 /* TOnogrepDO: reporting the public exponent for opaque keys
1205 * is not yet implemented. */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001207 break;
1208#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001209 status = psa_get_rsa_public_exponent( slot->data.rsa, attributes );
1210 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001211#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001212 default:
1213 /* Nothing else to do. */
1214 break;
1215 }
1216
1217 if( status != PSA_SUCCESS )
1218 psa_reset_key_attributes( attributes );
1219 return( status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001220}
1221
Gilles Peskinec8000c02019-08-02 20:15:51 +02001222#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1223psa_status_t psa_get_key_slot_number(
1224 const psa_key_attributes_t *attributes,
1225 psa_key_slot_number_t *slot_number )
1226{
1227 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1228 {
1229 *slot_number = attributes->slot_number;
1230 return( PSA_SUCCESS );
1231 }
1232 else
1233 return( PSA_ERROR_INVALID_ARGUMENT );
1234}
1235#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1236
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001237#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero6b196002019-01-10 10:23:21 +00001238static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1239 unsigned char *buf, size_t size )
1240{
1241 int ret;
1242 unsigned char *c;
1243 size_t len = 0;
1244
1245 c = buf + size;
1246
1247 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1248
1249 return( (int) len );
1250}
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001251#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero6b196002019-01-10 10:23:21 +00001252
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001253static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1254 uint8_t *data,
1255 size_t data_size,
1256 size_t *data_length,
1257 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001258{
Gilles Peskine5d309672019-07-12 23:47:28 +02001259#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1260 const psa_drv_se_t *drv;
1261 psa_drv_se_context_t *drv_context;
1262#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1263
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001264 *data_length = 0;
1265
Gilles Peskine8e338702019-07-30 20:06:31 +02001266 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001267 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001268
Gilles Peskine5d309672019-07-12 23:47:28 +02001269#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001270 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001271 {
1272 psa_drv_se_export_key_t method;
1273 if( drv->key_management == NULL )
1274 return( PSA_ERROR_NOT_SUPPORTED );
1275 method = ( export_public_key ?
1276 drv->key_management->p_export_public :
1277 drv->key_management->p_export );
1278 if( method == NULL )
1279 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001280 return( method( drv_context,
1281 slot->data.se.slot_number,
1282 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001283 }
1284#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1285
Gilles Peskine8e338702019-07-30 20:06:31 +02001286 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001287 {
1288 if( slot->data.raw.bytes > data_size )
1289 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine52b90182018-10-29 19:26:27 +01001290 if( data_size != 0 )
1291 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001292 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
Gilles Peskine52b90182018-10-29 19:26:27 +01001293 memset( data + slot->data.raw.bytes, 0,
1294 data_size - slot->data.raw.bytes );
1295 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001296 *data_length = slot->data.raw.bytes;
1297 return( PSA_SUCCESS );
1298 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001299#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001300 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) && !export_public_key )
Gilles Peskine188c71e2018-10-29 19:26:02 +01001301 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001302 psa_status_t status;
1303
Gilles Peskineb46bef22019-07-30 21:32:04 +02001304 size_t bytes = PSA_BITS_TO_BYTES( slot->attr.bits );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001305 if( bytes > data_size )
1306 return( PSA_ERROR_BUFFER_TOO_SMALL );
1307 status = mbedtls_to_psa_error(
1308 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1309 if( status != PSA_SUCCESS )
1310 return( status );
1311 memset( data + bytes, 0, data_size - bytes );
1312 *data_length = bytes;
1313 return( PSA_SUCCESS );
1314 }
1315#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001316 else
Moran Peker17e36e12018-05-02 12:55:20 +03001317 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001318#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001319 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1320 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001321 {
Moran Pekera998bc62018-04-16 18:16:20 +03001322 mbedtls_pk_context pk;
1323 int ret;
Gilles Peskine8e338702019-07-30 20:06:31 +02001324 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001325 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001326#if defined(MBEDTLS_RSA_C)
1327 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001328 pk.pk_info = &mbedtls_rsa_info;
1329 pk.pk_ctx = slot->data.rsa;
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 }
1334 else
1335 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001336#if defined(MBEDTLS_ECP_C)
1337 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001338 pk.pk_info = &mbedtls_eckey_info;
1339 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001340#else
1341 return( PSA_ERROR_NOT_SUPPORTED );
1342#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001343 }
Gilles Peskine8e338702019-07-30 20:06:31 +02001344 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero6b196002019-01-10 10:23:21 +00001345 {
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001346 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero6b196002019-01-10 10:23:21 +00001347 }
Moran Peker17e36e12018-05-02 12:55:20 +03001348 else
Jaeden Amero6b196002019-01-10 10:23:21 +00001349 {
Moran Peker17e36e12018-05-02 12:55:20 +03001350 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero6b196002019-01-10 10:23:21 +00001351 }
Moran Peker60364322018-04-29 11:34:58 +03001352 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001353 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001354 /* If data_size is 0 then data may be NULL and then the
1355 * call to memset would have undefined behavior. */
1356 if( data_size != 0 )
1357 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001358 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001359 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001360 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1361 * Move the data to the beginning and erase remaining data
1362 * at the original location. */
1363 if( 2 * (size_t) ret <= data_size )
1364 {
1365 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001366 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001367 }
1368 else if( (size_t) ret < data_size )
1369 {
1370 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001371 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001372 }
Moran Pekera998bc62018-04-16 18:16:20 +03001373 *data_length = ret;
1374 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001375 }
1376 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001377#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001378 {
1379 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001380 it is valid for a special-purpose implementation to omit
1381 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001382 return( PSA_ERROR_NOT_SUPPORTED );
1383 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001384 }
1385}
1386
Gilles Peskinec5487a82018-12-03 18:08:14 +01001387psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001388 uint8_t *data,
1389 size_t data_size,
1390 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001391{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001392 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001393 psa_status_t status;
1394
1395 /* Set the key to empty now, so that even when there are errors, we always
1396 * set data_length to a value between 0 and data_size. On error, setting
1397 * the key to empty is a good choice because an empty key representation is
1398 * unlikely to be accepted anywhere. */
1399 *data_length = 0;
1400
1401 /* Export requires the EXPORT flag. There is an exception for public keys,
1402 * which don't require any flag, but psa_get_key_from_slot takes
1403 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001404 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001405 if( status != PSA_SUCCESS )
1406 return( status );
1407 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001408 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001409}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001410
Gilles Peskinec5487a82018-12-03 18:08:14 +01001411psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001412 uint8_t *data,
1413 size_t data_size,
1414 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001415{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001416 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001417 psa_status_t status;
1418
1419 /* Set the key to empty now, so that even when there are errors, we always
1420 * set data_length to a value between 0 and data_size. On error, setting
1421 * the key to empty is a good choice because an empty key representation is
1422 * unlikely to be accepted anywhere. */
1423 *data_length = 0;
1424
1425 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001426 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001427 if( status != PSA_SUCCESS )
1428 return( status );
1429 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001430 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001431}
1432
Gilles Peskine91e8c332019-08-02 19:19:39 +02001433#if defined(static_assert)
1434static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1435 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001436static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001437 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001438static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001439 "One or more key attribute flag is listed as both internal-only and external-only" );
1440#endif
1441
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001442/** Validate that a key policy is internally well-formed.
1443 *
1444 * This function only rejects invalid policies. It does not validate the
1445 * consistency of the policy with respect to other attributes of the key
1446 * such as the key type.
1447 */
1448static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001449{
1450 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001451 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001452 PSA_KEY_USAGE_ENCRYPT |
1453 PSA_KEY_USAGE_DECRYPT |
1454 PSA_KEY_USAGE_SIGN |
1455 PSA_KEY_USAGE_VERIFY |
1456 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1457 return( PSA_ERROR_INVALID_ARGUMENT );
1458
Gilles Peskine4747d192019-04-17 15:05:45 +02001459 return( PSA_SUCCESS );
1460}
1461
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001462/** Validate the internal consistency of key attributes.
1463 *
1464 * This function only rejects invalid attribute values. If does not
1465 * validate the consistency of the attributes with any key data that may
1466 * be involved in the creation of the key.
1467 *
1468 * Call this function early in the key creation process.
1469 *
1470 * \param[in] attributes Key attributes for the new key.
1471 * \param[out] p_drv On any return, the driver for the key, if any.
1472 * NULL for a transparent key.
1473 *
1474 */
1475static psa_status_t psa_validate_key_attributes(
1476 const psa_key_attributes_t *attributes,
1477 psa_se_drv_table_entry_t **p_drv )
1478{
1479 psa_status_t status;
1480
1481 if( attributes->core.lifetime != PSA_KEY_LIFETIME_VOLATILE )
1482 {
1483 status = psa_validate_persistent_key_parameters(
1484 attributes->core.lifetime, attributes->core.id,
1485 p_drv, 1 );
1486 if( status != PSA_SUCCESS )
1487 return( status );
1488 }
1489
1490 status = psa_validate_key_policy( &attributes->core.policy );
1491 if( status != PSA_SUCCESS )
1492 return( status );
1493
1494 /* Refuse to create overly large keys.
1495 * Note that this doesn't trigger on import if the attributes don't
1496 * explicitly specify a size (so psa_get_key_bits returns 0), so
1497 * psa_import_key() needs its own checks. */
1498 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1499 return( PSA_ERROR_NOT_SUPPORTED );
1500
Gilles Peskine91e8c332019-08-02 19:19:39 +02001501 /* Reject invalid flags. These should not be reachable through the API. */
1502 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1503 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1504 return( PSA_ERROR_INVALID_ARGUMENT );
1505
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001506 return( PSA_SUCCESS );
1507}
1508
Gilles Peskine4747d192019-04-17 15:05:45 +02001509/** Prepare a key slot to receive key material.
1510 *
1511 * This function allocates a key slot and sets its metadata.
1512 *
1513 * If this function fails, call psa_fail_key_creation().
1514 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001515 * This function is intended to be used as follows:
1516 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1517 * it with the specified attributes, and assign it a handle.
1518 * -# Populate the slot with the key material.
1519 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1520 * In case of failure at any step, stop the sequence and call
1521 * psa_fail_key_creation().
1522 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001523 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001524 * \param[in] attributes Key attributes for the new key.
1525 * \param[out] handle On success, a handle for the allocated slot.
1526 * \param[out] p_slot On success, a pointer to the prepared slot.
1527 * \param[out] p_drv On any return, the driver for the key, if any.
1528 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001529 *
1530 * \retval #PSA_SUCCESS
1531 * The key slot is ready to receive key material.
1532 * \return If this function fails, the key slot is an invalid state.
1533 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001534 */
1535static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001536 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001537 const psa_key_attributes_t *attributes,
1538 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001539 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001540 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001541{
1542 psa_status_t status;
1543 psa_key_slot_t *slot;
1544
Gilles Peskinedf179142019-07-15 22:02:14 +02001545 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001546 *p_drv = NULL;
1547
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001548 status = psa_validate_key_attributes( attributes, p_drv );
1549 if( status != PSA_SUCCESS )
1550 return( status );
1551
Gilles Peskineedbed562019-08-07 18:19:59 +02001552 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001553 if( status != PSA_SUCCESS )
1554 return( status );
1555 slot = *p_slot;
1556
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001557 /* We're storing the declared bit-size of the key. It's up to each
1558 * creation mechanism to verify that this information is correct.
1559 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001560 * an input (generate, device) but not for those where the bit-size
1561 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001562
1563 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001564
Gilles Peskine91e8c332019-08-02 19:19:39 +02001565 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001566 * external-only flags, query `attributes`. Thanks to the check
1567 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001568 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001569 * may have set. */
1570 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001571
Gilles Peskinecbaff462019-07-12 23:46:04 +02001572#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine60450a42019-07-25 11:32:45 +02001573 /* For a key in a secure element, we need to do three things:
1574 * create the key file in internal storage, create the
1575 * key inside the secure element, and update the driver's
1576 * persistent data. Start a transaction that will encompass these
1577 * three actions. */
1578 /* The first thing to do is to find a slot number for the new key.
1579 * We save the slot number in persistent storage as part of the
1580 * transaction data. It will be needed to recover if the power
1581 * fails during the key creation process, to clean up on the secure
1582 * element side after restarting. Obtaining a slot number from the
1583 * secure element driver updates its persistent state, but we do not yet
1584 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001585 * we can roll back to a state where the key doesn't exist. */
Gilles Peskinecbaff462019-07-12 23:46:04 +02001586 if( *p_drv != NULL )
1587 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001588 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001589 &slot->data.se.slot_number );
1590 if( status != PSA_SUCCESS )
1591 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001592 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001593 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001594 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001595 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001596 status = psa_crypto_save_transaction( );
1597 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001598 {
1599 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001600 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001601 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001602 }
1603#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1604
Gilles Peskine4747d192019-04-17 15:05:45 +02001605 return( status );
1606}
1607
1608/** Finalize the creation of a key once its key material has been set.
1609 *
1610 * This entails writing the key to persistent storage.
1611 *
1612 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001613 * See the documentation of psa_start_key_creation() for the intended use
1614 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001615 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001616 * \param[in,out] slot Pointer to the slot with key material.
1617 * \param[in] driver The secure element driver for the key,
1618 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001619 *
1620 * \retval #PSA_SUCCESS
1621 * The key was successfully created. The handle is now valid.
1622 * \return If this function fails, the key slot is an invalid state.
1623 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001624 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001625static psa_status_t psa_finish_key_creation(
1626 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001627 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001628{
1629 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001630 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001631 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001632
1633#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001634 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001635 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001636#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1637 if( driver != NULL )
1638 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001639 psa_se_key_data_storage_t data;
1640#if defined(static_assert)
1641 static_assert( sizeof( slot->data.se.slot_number ) ==
1642 sizeof( data.slot_number ),
1643 "Slot number size does not match psa_se_key_data_storage_t" );
1644 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1645 "Bit-size size does not match psa_se_key_data_storage_t" );
1646#endif
1647 memcpy( &data.slot_number, &slot->data.se.slot_number,
1648 sizeof( slot->data.se.slot_number ) );
1649 memcpy( &data.bits, &slot->attr.bits,
1650 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001651 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001652 (uint8_t*) &data,
1653 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001654 }
1655 else
1656#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1657 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001658 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001659 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001660 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001661 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1662 size_t length = 0;
Gilles Peskine1df83d42019-07-23 16:13:14 +02001663 if( buffer == NULL && buffer_size != 0 )
1664 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1665 status = psa_internal_export_key( slot,
1666 buffer, buffer_size, &length,
1667 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001668 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001669 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001670 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001671
Gilles Peskine1df83d42019-07-23 16:13:14 +02001672 if( buffer_size != 0 )
1673 mbedtls_platform_zeroize( buffer, buffer_size );
1674 mbedtls_free( buffer );
1675 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001676 }
1677#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1678
Gilles Peskinecbaff462019-07-12 23:46:04 +02001679#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1680 if( driver != NULL )
1681 {
1682 status = psa_save_se_persistent_data( driver );
1683 if( status != PSA_SUCCESS )
1684 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001685 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001686 return( status );
1687 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001688 status = psa_crypto_stop_transaction( );
1689 if( status != PSA_SUCCESS )
1690 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001691 }
1692#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1693
Gilles Peskine4747d192019-04-17 15:05:45 +02001694 return( status );
1695}
1696
1697/** Abort the creation of a key.
1698 *
1699 * You may call this function after calling psa_start_key_creation(),
1700 * or after psa_finish_key_creation() fails. In other circumstances, this
1701 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001702 * See the documentation of psa_start_key_creation() for the intended use
1703 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001704 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001705 * \param[in,out] slot Pointer to the slot with key material.
1706 * \param[in] driver The secure element driver for the key,
1707 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001708 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001709static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001710 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001711{
Gilles Peskine011e4282019-06-26 18:34:38 +02001712 (void) driver;
1713
Gilles Peskine4747d192019-04-17 15:05:45 +02001714 if( slot == NULL )
1715 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001716
1717#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1718 /* TOnogrepDO: If the key has already been created in the secure
1719 * element, and the failure happened later (when saving metadata
1720 * to internal storage), we need to destroy the key in the secure
1721 * element. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001722
1723 /* Abort the ongoing transaction if any. We already did what it
1724 * takes to undo any partial creation. All that's left is to update
1725 * the transaction data itself. */
1726 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001727#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1728
Gilles Peskine4747d192019-04-17 15:05:45 +02001729 psa_wipe_key_slot( slot );
1730}
1731
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001732/** Validate optional attributes during key creation.
1733 *
1734 * Some key attributes are optional during key creation. If they are
1735 * specified in the attributes structure, check that they are consistent
1736 * with the data in the slot.
1737 *
1738 * This function should be called near the end of key creation, after
1739 * the slot in memory is fully populated but before saving persistent data.
1740 */
1741static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001742 const psa_key_slot_t *slot,
1743 const psa_key_attributes_t *attributes )
1744{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001745 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001746 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001747 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001748 return( PSA_ERROR_INVALID_ARGUMENT );
1749 }
1750
1751 if( attributes->domain_parameters_size != 0 )
1752 {
1753#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001754 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001755 {
1756 mbedtls_mpi actual, required;
1757 int ret;
1758 mbedtls_mpi_init( &actual );
1759 mbedtls_mpi_init( &required );
1760 ret = mbedtls_rsa_export( slot->data.rsa,
1761 NULL, NULL, NULL, NULL, &actual );
1762 if( ret != 0 )
1763 goto rsa_exit;
1764 ret = mbedtls_mpi_read_binary( &required,
1765 attributes->domain_parameters,
1766 attributes->domain_parameters_size );
1767 if( ret != 0 )
1768 goto rsa_exit;
1769 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1770 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1771 rsa_exit:
1772 mbedtls_mpi_free( &actual );
1773 mbedtls_mpi_free( &required );
1774 if( ret != 0)
1775 return( mbedtls_to_psa_error( ret ) );
1776 }
1777 else
1778#endif
1779 {
1780 return( PSA_ERROR_INVALID_ARGUMENT );
1781 }
1782 }
1783
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001784 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001785 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001786 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001787 return( PSA_ERROR_INVALID_ARGUMENT );
1788 }
1789
1790 return( PSA_SUCCESS );
1791}
1792
Gilles Peskine4747d192019-04-17 15:05:45 +02001793psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001795 size_t data_length,
1796 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001797{
1798 psa_status_t status;
1799 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001800 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001801
Gilles Peskinedf179142019-07-15 22:02:14 +02001802 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
1803 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001804 if( status != PSA_SUCCESS )
1805 goto exit;
1806
Gilles Peskine5d309672019-07-12 23:47:28 +02001807#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1808 if( driver != NULL )
1809 {
1810 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001811 size_t bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001812 if( drv->key_management == NULL ||
1813 drv->key_management->p_import == NULL )
1814 {
1815 status = PSA_ERROR_NOT_SUPPORTED;
1816 goto exit;
1817 }
1818 status = drv->key_management->p_import(
1819 psa_get_se_driver_context( driver ),
1820 slot->data.se.slot_number,
Gilles Peskine8e338702019-07-30 20:06:31 +02001821 slot->attr.lifetime, slot->attr.type,
1822 slot->attr.policy.alg, slot->attr.policy.usage,
Gilles Peskine18017402019-07-24 20:25:59 +02001823 data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001824 &bits );
1825 if( status != PSA_SUCCESS )
1826 goto exit;
1827 if( bits > PSA_MAX_KEY_BITS )
1828 {
1829 status = PSA_ERROR_NOT_SUPPORTED;
1830 goto exit;
1831 }
1832 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001833 }
1834 else
1835#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1836 {
1837 status = psa_import_key_into_slot( slot, data, data_length );
1838 if( status != PSA_SUCCESS )
1839 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001840 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001841 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001842 if( status != PSA_SUCCESS )
1843 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001844
Gilles Peskine011e4282019-06-26 18:34:38 +02001845 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001846exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001847 if( status != PSA_SUCCESS )
1848 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001849 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001850 *handle = 0;
1851 }
1852 return( status );
1853}
1854
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001855static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001856 psa_key_slot_t *target )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001857{
1858 psa_status_t status;
1859 uint8_t *buffer = NULL;
1860 size_t buffer_size = 0;
1861 size_t length;
1862
Gilles Peskine8e338702019-07-30 20:06:31 +02001863 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001864 psa_get_key_slot_bits( source ) );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001865 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001866 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001867 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001868 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1869 if( status != PSA_SUCCESS )
1870 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001871 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001872 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001873
1874exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001875 if( buffer_size != 0 )
1876 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001877 mbedtls_free( buffer );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001878 return( status );
1879}
1880
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001881psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1882 const psa_key_attributes_t *specified_attributes,
1883 psa_key_handle_t *target_handle )
1884{
1885 psa_status_t status;
1886 psa_key_slot_t *source_slot = NULL;
1887 psa_key_slot_t *target_slot = NULL;
1888 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001889 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001890
Gilles Peskine28f8f302019-07-24 13:30:31 +02001891 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001892 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001893 if( status != PSA_SUCCESS )
1894 goto exit;
1895
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001896 status = psa_validate_optional_attributes( source_slot,
1897 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001898 if( status != PSA_SUCCESS )
1899 goto exit;
1900
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001901 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001902 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001903 if( status != PSA_SUCCESS )
1904 goto exit;
1905
Gilles Peskinedf179142019-07-15 22:02:14 +02001906 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
1907 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001908 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001909 if( status != PSA_SUCCESS )
1910 goto exit;
1911
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001912#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1913 if( driver != NULL )
1914 {
1915 /* Copying to a secure element is not implemented yet. */
1916 status = PSA_ERROR_NOT_SUPPORTED;
1917 goto exit;
1918 }
1919#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1920
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001921 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001922 if( status != PSA_SUCCESS )
1923 goto exit;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001924
Gilles Peskine011e4282019-06-26 18:34:38 +02001925 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001926exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001927 if( status != PSA_SUCCESS )
1928 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001929 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001930 *target_handle = 0;
1931 }
1932 return( status );
1933}
1934
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001935
1936
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001937/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001938/* Message digests */
1939/****************************************************************/
1940
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001941static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001942{
1943 switch( alg )
1944 {
1945#if defined(MBEDTLS_MD2_C)
1946 case PSA_ALG_MD2:
1947 return( &mbedtls_md2_info );
1948#endif
1949#if defined(MBEDTLS_MD4_C)
1950 case PSA_ALG_MD4:
1951 return( &mbedtls_md4_info );
1952#endif
1953#if defined(MBEDTLS_MD5_C)
1954 case PSA_ALG_MD5:
1955 return( &mbedtls_md5_info );
1956#endif
1957#if defined(MBEDTLS_RIPEMD160_C)
1958 case PSA_ALG_RIPEMD160:
1959 return( &mbedtls_ripemd160_info );
1960#endif
1961#if defined(MBEDTLS_SHA1_C)
1962 case PSA_ALG_SHA_1:
1963 return( &mbedtls_sha1_info );
1964#endif
1965#if defined(MBEDTLS_SHA256_C)
1966 case PSA_ALG_SHA_224:
1967 return( &mbedtls_sha224_info );
1968 case PSA_ALG_SHA_256:
1969 return( &mbedtls_sha256_info );
1970#endif
1971#if defined(MBEDTLS_SHA512_C)
1972 case PSA_ALG_SHA_384:
1973 return( &mbedtls_sha384_info );
1974 case PSA_ALG_SHA_512:
1975 return( &mbedtls_sha512_info );
1976#endif
1977 default:
1978 return( NULL );
1979 }
1980}
1981
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001982psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
1983{
1984 switch( operation->alg )
1985 {
Gilles Peskine81736312018-06-26 15:04:31 +02001986 case 0:
1987 /* The object has (apparently) been initialized but it is not
1988 * in use. It's ok to call abort on such an object, and there's
1989 * nothing to do. */
1990 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001991#if defined(MBEDTLS_MD2_C)
1992 case PSA_ALG_MD2:
1993 mbedtls_md2_free( &operation->ctx.md2 );
1994 break;
1995#endif
1996#if defined(MBEDTLS_MD4_C)
1997 case PSA_ALG_MD4:
1998 mbedtls_md4_free( &operation->ctx.md4 );
1999 break;
2000#endif
2001#if defined(MBEDTLS_MD5_C)
2002 case PSA_ALG_MD5:
2003 mbedtls_md5_free( &operation->ctx.md5 );
2004 break;
2005#endif
2006#if defined(MBEDTLS_RIPEMD160_C)
2007 case PSA_ALG_RIPEMD160:
2008 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2009 break;
2010#endif
2011#if defined(MBEDTLS_SHA1_C)
2012 case PSA_ALG_SHA_1:
2013 mbedtls_sha1_free( &operation->ctx.sha1 );
2014 break;
2015#endif
2016#if defined(MBEDTLS_SHA256_C)
2017 case PSA_ALG_SHA_224:
2018 case PSA_ALG_SHA_256:
2019 mbedtls_sha256_free( &operation->ctx.sha256 );
2020 break;
2021#endif
2022#if defined(MBEDTLS_SHA512_C)
2023 case PSA_ALG_SHA_384:
2024 case PSA_ALG_SHA_512:
2025 mbedtls_sha512_free( &operation->ctx.sha512 );
2026 break;
2027#endif
2028 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002029 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002030 }
2031 operation->alg = 0;
2032 return( PSA_SUCCESS );
2033}
2034
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002035psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002036 psa_algorithm_t alg )
2037{
2038 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002039
2040 /* A context must be freshly initialized before it can be set up. */
2041 if( operation->alg != 0 )
2042 {
2043 return( PSA_ERROR_BAD_STATE );
2044 }
2045
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002046 switch( alg )
2047 {
2048#if defined(MBEDTLS_MD2_C)
2049 case PSA_ALG_MD2:
2050 mbedtls_md2_init( &operation->ctx.md2 );
2051 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2052 break;
2053#endif
2054#if defined(MBEDTLS_MD4_C)
2055 case PSA_ALG_MD4:
2056 mbedtls_md4_init( &operation->ctx.md4 );
2057 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2058 break;
2059#endif
2060#if defined(MBEDTLS_MD5_C)
2061 case PSA_ALG_MD5:
2062 mbedtls_md5_init( &operation->ctx.md5 );
2063 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2064 break;
2065#endif
2066#if defined(MBEDTLS_RIPEMD160_C)
2067 case PSA_ALG_RIPEMD160:
2068 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2069 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2070 break;
2071#endif
2072#if defined(MBEDTLS_SHA1_C)
2073 case PSA_ALG_SHA_1:
2074 mbedtls_sha1_init( &operation->ctx.sha1 );
2075 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2076 break;
2077#endif
2078#if defined(MBEDTLS_SHA256_C)
2079 case PSA_ALG_SHA_224:
2080 mbedtls_sha256_init( &operation->ctx.sha256 );
2081 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2082 break;
2083 case PSA_ALG_SHA_256:
2084 mbedtls_sha256_init( &operation->ctx.sha256 );
2085 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2086 break;
2087#endif
2088#if defined(MBEDTLS_SHA512_C)
2089 case PSA_ALG_SHA_384:
2090 mbedtls_sha512_init( &operation->ctx.sha512 );
2091 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2092 break;
2093 case PSA_ALG_SHA_512:
2094 mbedtls_sha512_init( &operation->ctx.sha512 );
2095 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2096 break;
2097#endif
2098 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002099 return( PSA_ALG_IS_HASH( alg ) ?
2100 PSA_ERROR_NOT_SUPPORTED :
2101 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002102 }
2103 if( ret == 0 )
2104 operation->alg = alg;
2105 else
2106 psa_hash_abort( operation );
2107 return( mbedtls_to_psa_error( ret ) );
2108}
2109
2110psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2111 const uint8_t *input,
2112 size_t input_length )
2113{
2114 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002115
2116 /* Don't require hash implementations to behave correctly on a
2117 * zero-length input, which may have an invalid pointer. */
2118 if( input_length == 0 )
2119 return( PSA_SUCCESS );
2120
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002121 switch( operation->alg )
2122 {
2123#if defined(MBEDTLS_MD2_C)
2124 case PSA_ALG_MD2:
2125 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2126 input, input_length );
2127 break;
2128#endif
2129#if defined(MBEDTLS_MD4_C)
2130 case PSA_ALG_MD4:
2131 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2132 input, input_length );
2133 break;
2134#endif
2135#if defined(MBEDTLS_MD5_C)
2136 case PSA_ALG_MD5:
2137 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2138 input, input_length );
2139 break;
2140#endif
2141#if defined(MBEDTLS_RIPEMD160_C)
2142 case PSA_ALG_RIPEMD160:
2143 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2144 input, input_length );
2145 break;
2146#endif
2147#if defined(MBEDTLS_SHA1_C)
2148 case PSA_ALG_SHA_1:
2149 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2150 input, input_length );
2151 break;
2152#endif
2153#if defined(MBEDTLS_SHA256_C)
2154 case PSA_ALG_SHA_224:
2155 case PSA_ALG_SHA_256:
2156 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2157 input, input_length );
2158 break;
2159#endif
2160#if defined(MBEDTLS_SHA512_C)
2161 case PSA_ALG_SHA_384:
2162 case PSA_ALG_SHA_512:
2163 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2164 input, input_length );
2165 break;
2166#endif
2167 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002168 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002169 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002170
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002171 if( ret != 0 )
2172 psa_hash_abort( operation );
2173 return( mbedtls_to_psa_error( ret ) );
2174}
2175
2176psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2177 uint8_t *hash,
2178 size_t hash_size,
2179 size_t *hash_length )
2180{
itayzafrir40835d42018-08-02 13:14:17 +03002181 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002182 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002183 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002184
2185 /* Fill the output buffer with something that isn't a valid hash
2186 * (barring an attack on the hash and deliberately-crafted input),
2187 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002188 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002189 /* If hash_size is 0 then hash may be NULL and then the
2190 * call to memset would have undefined behavior. */
2191 if( hash_size != 0 )
2192 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002193
2194 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002195 {
2196 status = PSA_ERROR_BUFFER_TOO_SMALL;
2197 goto exit;
2198 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002199
2200 switch( operation->alg )
2201 {
2202#if defined(MBEDTLS_MD2_C)
2203 case PSA_ALG_MD2:
2204 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2205 break;
2206#endif
2207#if defined(MBEDTLS_MD4_C)
2208 case PSA_ALG_MD4:
2209 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2210 break;
2211#endif
2212#if defined(MBEDTLS_MD5_C)
2213 case PSA_ALG_MD5:
2214 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2215 break;
2216#endif
2217#if defined(MBEDTLS_RIPEMD160_C)
2218 case PSA_ALG_RIPEMD160:
2219 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2220 break;
2221#endif
2222#if defined(MBEDTLS_SHA1_C)
2223 case PSA_ALG_SHA_1:
2224 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2225 break;
2226#endif
2227#if defined(MBEDTLS_SHA256_C)
2228 case PSA_ALG_SHA_224:
2229 case PSA_ALG_SHA_256:
2230 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2231 break;
2232#endif
2233#if defined(MBEDTLS_SHA512_C)
2234 case PSA_ALG_SHA_384:
2235 case PSA_ALG_SHA_512:
2236 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2237 break;
2238#endif
2239 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002240 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002241 }
itayzafrir40835d42018-08-02 13:14:17 +03002242 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002243
itayzafrir40835d42018-08-02 13:14:17 +03002244exit:
2245 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002246 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002247 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002248 return( psa_hash_abort( operation ) );
2249 }
2250 else
2251 {
2252 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002253 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002254 }
2255}
2256
Gilles Peskine2d277862018-06-18 15:41:12 +02002257psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2258 const uint8_t *hash,
2259 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002260{
2261 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2262 size_t actual_hash_length;
2263 psa_status_t status = psa_hash_finish( operation,
2264 actual_hash, sizeof( actual_hash ),
2265 &actual_hash_length );
2266 if( status != PSA_SUCCESS )
2267 return( status );
2268 if( actual_hash_length != hash_length )
2269 return( PSA_ERROR_INVALID_SIGNATURE );
2270 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2271 return( PSA_ERROR_INVALID_SIGNATURE );
2272 return( PSA_SUCCESS );
2273}
2274
Gilles Peskineeb35d782019-01-22 17:56:16 +01002275psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2276 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002277{
2278 if( target_operation->alg != 0 )
2279 return( PSA_ERROR_BAD_STATE );
2280
2281 switch( source_operation->alg )
2282 {
2283 case 0:
2284 return( PSA_ERROR_BAD_STATE );
2285#if defined(MBEDTLS_MD2_C)
2286 case PSA_ALG_MD2:
2287 mbedtls_md2_clone( &target_operation->ctx.md2,
2288 &source_operation->ctx.md2 );
2289 break;
2290#endif
2291#if defined(MBEDTLS_MD4_C)
2292 case PSA_ALG_MD4:
2293 mbedtls_md4_clone( &target_operation->ctx.md4,
2294 &source_operation->ctx.md4 );
2295 break;
2296#endif
2297#if defined(MBEDTLS_MD5_C)
2298 case PSA_ALG_MD5:
2299 mbedtls_md5_clone( &target_operation->ctx.md5,
2300 &source_operation->ctx.md5 );
2301 break;
2302#endif
2303#if defined(MBEDTLS_RIPEMD160_C)
2304 case PSA_ALG_RIPEMD160:
2305 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2306 &source_operation->ctx.ripemd160 );
2307 break;
2308#endif
2309#if defined(MBEDTLS_SHA1_C)
2310 case PSA_ALG_SHA_1:
2311 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2312 &source_operation->ctx.sha1 );
2313 break;
2314#endif
2315#if defined(MBEDTLS_SHA256_C)
2316 case PSA_ALG_SHA_224:
2317 case PSA_ALG_SHA_256:
2318 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2319 &source_operation->ctx.sha256 );
2320 break;
2321#endif
2322#if defined(MBEDTLS_SHA512_C)
2323 case PSA_ALG_SHA_384:
2324 case PSA_ALG_SHA_512:
2325 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2326 &source_operation->ctx.sha512 );
2327 break;
2328#endif
2329 default:
2330 return( PSA_ERROR_NOT_SUPPORTED );
2331 }
2332
2333 target_operation->alg = source_operation->alg;
2334 return( PSA_SUCCESS );
2335}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002336
2337
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002338/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002339/* MAC */
2340/****************************************************************/
2341
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002342static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002343 psa_algorithm_t alg,
2344 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002345 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002346 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002347{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002348 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002349 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002350
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002351 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002352 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002353
Gilles Peskine8c9def32018-02-08 10:02:12 +01002354 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2355 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002356 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002357 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002358 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002359 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002360 mode = MBEDTLS_MODE_STREAM;
2361 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002362 case PSA_ALG_CTR:
2363 mode = MBEDTLS_MODE_CTR;
2364 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002365 case PSA_ALG_CFB:
2366 mode = MBEDTLS_MODE_CFB;
2367 break;
2368 case PSA_ALG_OFB:
2369 mode = MBEDTLS_MODE_OFB;
2370 break;
2371 case PSA_ALG_CBC_NO_PADDING:
2372 mode = MBEDTLS_MODE_CBC;
2373 break;
2374 case PSA_ALG_CBC_PKCS7:
2375 mode = MBEDTLS_MODE_CBC;
2376 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002377 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002378 mode = MBEDTLS_MODE_CCM;
2379 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002380 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002381 mode = MBEDTLS_MODE_GCM;
2382 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002383 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2384 mode = MBEDTLS_MODE_CHACHAPOLY;
2385 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002386 default:
2387 return( NULL );
2388 }
2389 }
2390 else if( alg == PSA_ALG_CMAC )
2391 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002392 else
2393 return( NULL );
2394
2395 switch( key_type )
2396 {
2397 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002398 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002399 break;
2400 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002401 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2402 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002403 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002404 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002405 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002406 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002407 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2408 * but two-key Triple-DES is functionally three-key Triple-DES
2409 * with K1=K3, so that's how we present it to mbedtls. */
2410 if( key_bits == 128 )
2411 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412 break;
2413 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002414 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002415 break;
2416 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002417 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002418 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002419 case PSA_KEY_TYPE_CHACHA20:
2420 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2421 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002422 default:
2423 return( NULL );
2424 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002425 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002426 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002427
Jaeden Amero23bbb752018-06-26 14:16:54 +01002428 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2429 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002430}
2431
Gilles Peskinea05219c2018-11-16 16:02:56 +01002432#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002433static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002434{
Gilles Peskine2d277862018-06-18 15:41:12 +02002435 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002436 {
2437 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002438 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002439 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002440 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002441 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002442 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002443 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002444 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002445 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002446 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002447 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002448 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002449 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002450 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002451 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002452 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002453 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002454 return( 128 );
2455 default:
2456 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002457 }
2458}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002459#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002460
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002461/* Initialize the MAC operation structure. Once this function has been
2462 * called, psa_mac_abort can run and will do the right thing. */
2463static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2464 psa_algorithm_t alg )
2465{
2466 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2467
2468 operation->alg = alg;
2469 operation->key_set = 0;
2470 operation->iv_set = 0;
2471 operation->iv_required = 0;
2472 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002473 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002474
2475#if defined(MBEDTLS_CMAC_C)
2476 if( alg == PSA_ALG_CMAC )
2477 {
2478 operation->iv_required = 0;
2479 mbedtls_cipher_init( &operation->ctx.cmac );
2480 status = PSA_SUCCESS;
2481 }
2482 else
2483#endif /* MBEDTLS_CMAC_C */
2484#if defined(MBEDTLS_MD_C)
2485 if( PSA_ALG_IS_HMAC( operation->alg ) )
2486 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002487 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2488 operation->ctx.hmac.hash_ctx.alg = 0;
2489 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002490 }
2491 else
2492#endif /* MBEDTLS_MD_C */
2493 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002494 if( ! PSA_ALG_IS_MAC( alg ) )
2495 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002496 }
2497
2498 if( status != PSA_SUCCESS )
2499 memset( operation, 0, sizeof( *operation ) );
2500 return( status );
2501}
2502
Gilles Peskine01126fa2018-07-12 17:04:55 +02002503#if defined(MBEDTLS_MD_C)
2504static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2505{
Gilles Peskine3f108122018-12-07 18:14:53 +01002506 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002507 return( psa_hash_abort( &hmac->hash_ctx ) );
2508}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002509
Janos Follath999f6482019-06-11 12:04:10 +01002510#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002511static void psa_hmac_init_internal( psa_hmac_internal_data *hmac )
2512{
2513 /* Instances of psa_hash_operation_s can be initialized by zeroization. */
2514 memset( hmac, 0, sizeof( *hmac ) );
2515}
Janos Follath999f6482019-06-11 12:04:10 +01002516#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002517#endif /* MBEDTLS_MD_C */
2518
Gilles Peskine8c9def32018-02-08 10:02:12 +01002519psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2520{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002521 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002523 /* The object has (apparently) been initialized but it is not
2524 * in use. It's ok to call abort on such an object, and there's
2525 * nothing to do. */
2526 return( PSA_SUCCESS );
2527 }
2528 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002529#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002530 if( operation->alg == PSA_ALG_CMAC )
2531 {
2532 mbedtls_cipher_free( &operation->ctx.cmac );
2533 }
2534 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002535#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002536#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002537 if( PSA_ALG_IS_HMAC( operation->alg ) )
2538 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002539 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002540 }
2541 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002542#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002543 {
2544 /* Sanity check (shouldn't happen: operation->alg should
2545 * always have been initialized to a valid value). */
2546 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002547 }
Moran Peker41deec42018-04-04 15:43:05 +03002548
Gilles Peskine8c9def32018-02-08 10:02:12 +01002549 operation->alg = 0;
2550 operation->key_set = 0;
2551 operation->iv_set = 0;
2552 operation->iv_required = 0;
2553 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002554 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002555
Gilles Peskine8c9def32018-02-08 10:02:12 +01002556 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002557
2558bad_state:
2559 /* If abort is called on an uninitialized object, we can't trust
2560 * anything. Wipe the object in case it contains confidential data.
2561 * This may result in a memory leak if a pointer gets overwritten,
2562 * but it's too late to do anything about this. */
2563 memset( operation, 0, sizeof( *operation ) );
2564 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002565}
2566
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002567#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002568static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002569 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002570 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002571 const mbedtls_cipher_info_t *cipher_info )
2572{
2573 int ret;
2574
2575 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002576
2577 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2578 if( ret != 0 )
2579 return( ret );
2580
2581 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2582 slot->data.raw.data,
2583 key_bits );
2584 return( ret );
2585}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002586#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002587
Gilles Peskine248051a2018-06-20 16:09:38 +02002588#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002589static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2590 const uint8_t *key,
2591 size_t key_length,
2592 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002593{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002594 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002595 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002596 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002597 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002598 psa_status_t status;
2599
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002600 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2601 * overflow below. This should never trigger if the hash algorithm
2602 * is implemented correctly. */
2603 /* The size checks against the ipad and opad buffers cannot be written
2604 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2605 * because that triggers -Wlogical-op on GCC 7.3. */
2606 if( block_size > sizeof( ipad ) )
2607 return( PSA_ERROR_NOT_SUPPORTED );
2608 if( block_size > sizeof( hmac->opad ) )
2609 return( PSA_ERROR_NOT_SUPPORTED );
2610 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002611 return( PSA_ERROR_NOT_SUPPORTED );
2612
Gilles Peskined223b522018-06-11 18:12:58 +02002613 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002614 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002615 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002616 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002617 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002618 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002619 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002620 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002621 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002622 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002623 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002624 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002625 }
Gilles Peskine96889972018-07-12 17:07:03 +02002626 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2627 * but it is permitted. It is common when HMAC is used in HKDF, for
2628 * example. Don't call `memcpy` in the 0-length because `key` could be
2629 * an invalid pointer which would make the behavior undefined. */
2630 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002631 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002632
Gilles Peskined223b522018-06-11 18:12:58 +02002633 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2634 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002635 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002636 ipad[i] ^= 0x36;
2637 memset( ipad + key_length, 0x36, block_size - key_length );
2638
2639 /* Copy the key material from ipad to opad, flipping the requisite bits,
2640 * and filling the rest of opad with the requisite constant. */
2641 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002642 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2643 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002644
Gilles Peskine01126fa2018-07-12 17:04:55 +02002645 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002646 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002647 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002648
Gilles Peskine01126fa2018-07-12 17:04:55 +02002649 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002650
2651cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002652 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002653
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002654 return( status );
2655}
Gilles Peskine248051a2018-06-20 16:09:38 +02002656#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002657
Gilles Peskine89167cb2018-07-08 20:12:23 +02002658static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002659 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002660 psa_algorithm_t alg,
2661 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002662{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002663 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002664 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002666 psa_key_usage_t usage =
2667 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002668 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002669 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002670
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002671 /* A context must be freshly initialized before it can be set up. */
2672 if( operation->alg != 0 )
2673 {
2674 return( PSA_ERROR_BAD_STATE );
2675 }
2676
Gilles Peskined911eb72018-08-14 15:18:45 +02002677 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002678 if( status != PSA_SUCCESS )
2679 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002680 if( is_sign )
2681 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002682
Gilles Peskine28f8f302019-07-24 13:30:31 +02002683 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002684 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002685 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002686 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002687
Gilles Peskine8c9def32018-02-08 10:02:12 +01002688#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002689 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002690 {
2691 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002692 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002693 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002694 int ret;
2695 if( cipher_info == NULL )
2696 {
2697 status = PSA_ERROR_NOT_SUPPORTED;
2698 goto exit;
2699 }
2700 operation->mac_size = cipher_info->block_size;
2701 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2702 status = mbedtls_to_psa_error( ret );
2703 }
2704 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002705#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002706#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002707 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002708 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002709 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002710 if( hash_alg == 0 )
2711 {
2712 status = PSA_ERROR_NOT_SUPPORTED;
2713 goto exit;
2714 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002715
2716 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2717 /* Sanity check. This shouldn't fail on a valid configuration. */
2718 if( operation->mac_size == 0 ||
2719 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2720 {
2721 status = PSA_ERROR_NOT_SUPPORTED;
2722 goto exit;
2723 }
2724
Gilles Peskine8e338702019-07-30 20:06:31 +02002725 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002726 {
2727 status = PSA_ERROR_INVALID_ARGUMENT;
2728 goto exit;
2729 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002730
Gilles Peskine01126fa2018-07-12 17:04:55 +02002731 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2732 slot->data.raw.data,
2733 slot->data.raw.bytes,
2734 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002735 }
2736 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002737#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002738 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002739 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002740 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002741 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002742
Gilles Peskined911eb72018-08-14 15:18:45 +02002743 if( truncated == 0 )
2744 {
2745 /* The "normal" case: untruncated algorithm. Nothing to do. */
2746 }
2747 else if( truncated < 4 )
2748 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002749 /* A very short MAC is too short for security since it can be
2750 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2751 * so we make this our minimum, even though 32 bits is still
2752 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002753 status = PSA_ERROR_NOT_SUPPORTED;
2754 }
2755 else if( truncated > operation->mac_size )
2756 {
2757 /* It's impossible to "truncate" to a larger length. */
2758 status = PSA_ERROR_INVALID_ARGUMENT;
2759 }
2760 else
2761 operation->mac_size = truncated;
2762
Gilles Peskinefbfac682018-07-08 20:51:54 +02002763exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002764 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002765 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002766 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002767 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002768 else
2769 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002770 operation->key_set = 1;
2771 }
2772 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002773}
2774
Gilles Peskine89167cb2018-07-08 20:12:23 +02002775psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002776 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002777 psa_algorithm_t alg )
2778{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002779 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002780}
2781
2782psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002783 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002784 psa_algorithm_t alg )
2785{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002786 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002787}
2788
Gilles Peskine8c9def32018-02-08 10:02:12 +01002789psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2790 const uint8_t *input,
2791 size_t input_length )
2792{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002793 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002794 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002795 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002796 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002797 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798 operation->has_input = 1;
2799
Gilles Peskine8c9def32018-02-08 10:02:12 +01002800#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002801 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002802 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002803 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2804 input, input_length );
2805 status = mbedtls_to_psa_error( ret );
2806 }
2807 else
2808#endif /* MBEDTLS_CMAC_C */
2809#if defined(MBEDTLS_MD_C)
2810 if( PSA_ALG_IS_HMAC( operation->alg ) )
2811 {
2812 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2813 input_length );
2814 }
2815 else
2816#endif /* MBEDTLS_MD_C */
2817 {
2818 /* This shouldn't happen if `operation` was initialized by
2819 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002820 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002821 }
2822
Gilles Peskinefbfac682018-07-08 20:51:54 +02002823 if( status != PSA_SUCCESS )
2824 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002825 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002826}
2827
Gilles Peskine01126fa2018-07-12 17:04:55 +02002828#if defined(MBEDTLS_MD_C)
2829static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2830 uint8_t *mac,
2831 size_t mac_size )
2832{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002833 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002834 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2835 size_t hash_size = 0;
2836 size_t block_size = psa_get_hash_block_size( hash_alg );
2837 psa_status_t status;
2838
Gilles Peskine01126fa2018-07-12 17:04:55 +02002839 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2840 if( status != PSA_SUCCESS )
2841 return( status );
2842 /* From here on, tmp needs to be wiped. */
2843
2844 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2845 if( status != PSA_SUCCESS )
2846 goto exit;
2847
2848 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2849 if( status != PSA_SUCCESS )
2850 goto exit;
2851
2852 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2853 if( status != PSA_SUCCESS )
2854 goto exit;
2855
Gilles Peskined911eb72018-08-14 15:18:45 +02002856 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2857 if( status != PSA_SUCCESS )
2858 goto exit;
2859
2860 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002861
2862exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002863 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002864 return( status );
2865}
2866#endif /* MBEDTLS_MD_C */
2867
mohammad16036df908f2018-04-02 08:34:15 -07002868static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002869 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002870 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002871{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002872 if( ! operation->key_set )
2873 return( PSA_ERROR_BAD_STATE );
2874 if( operation->iv_required && ! operation->iv_set )
2875 return( PSA_ERROR_BAD_STATE );
2876
Gilles Peskine8c9def32018-02-08 10:02:12 +01002877 if( mac_size < operation->mac_size )
2878 return( PSA_ERROR_BUFFER_TOO_SMALL );
2879
Gilles Peskine8c9def32018-02-08 10:02:12 +01002880#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002881 if( operation->alg == PSA_ALG_CMAC )
2882 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002883 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2884 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2885 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002886 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002887 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002888 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002889 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002890 else
2891#endif /* MBEDTLS_CMAC_C */
2892#if defined(MBEDTLS_MD_C)
2893 if( PSA_ALG_IS_HMAC( operation->alg ) )
2894 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002895 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002896 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002897 }
2898 else
2899#endif /* MBEDTLS_MD_C */
2900 {
2901 /* This shouldn't happen if `operation` was initialized by
2902 * a setup function. */
2903 return( PSA_ERROR_BAD_STATE );
2904 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002905}
2906
Gilles Peskineacd4be32018-07-08 19:56:25 +02002907psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2908 uint8_t *mac,
2909 size_t mac_size,
2910 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002911{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002912 psa_status_t status;
2913
Jaeden Amero252ef282019-02-15 14:05:35 +00002914 if( operation->alg == 0 )
2915 {
2916 return( PSA_ERROR_BAD_STATE );
2917 }
2918
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002919 /* Fill the output buffer with something that isn't a valid mac
2920 * (barring an attack on the mac and deliberately-crafted input),
2921 * in case the caller doesn't check the return status properly. */
2922 *mac_length = mac_size;
2923 /* If mac_size is 0 then mac may be NULL and then the
2924 * call to memset would have undefined behavior. */
2925 if( mac_size != 0 )
2926 memset( mac, '!', mac_size );
2927
Gilles Peskine89167cb2018-07-08 20:12:23 +02002928 if( ! operation->is_sign )
2929 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002930 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002931 }
mohammad16036df908f2018-04-02 08:34:15 -07002932
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002933 status = psa_mac_finish_internal( operation, mac, mac_size );
2934
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002935 if( status == PSA_SUCCESS )
2936 {
2937 status = psa_mac_abort( operation );
2938 if( status == PSA_SUCCESS )
2939 *mac_length = operation->mac_size;
2940 else
2941 memset( mac, '!', mac_size );
2942 }
2943 else
2944 psa_mac_abort( operation );
2945 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002946}
2947
Gilles Peskineacd4be32018-07-08 19:56:25 +02002948psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2949 const uint8_t *mac,
2950 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002951{
Gilles Peskine828ed142018-06-18 23:25:51 +02002952 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002953 psa_status_t status;
2954
Jaeden Amero252ef282019-02-15 14:05:35 +00002955 if( operation->alg == 0 )
2956 {
2957 return( PSA_ERROR_BAD_STATE );
2958 }
2959
Gilles Peskine89167cb2018-07-08 20:12:23 +02002960 if( operation->is_sign )
2961 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002962 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002963 }
2964 if( operation->mac_size != mac_length )
2965 {
2966 status = PSA_ERROR_INVALID_SIGNATURE;
2967 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002968 }
mohammad16036df908f2018-04-02 08:34:15 -07002969
2970 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002971 actual_mac, sizeof( actual_mac ) );
2972
2973 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2974 status = PSA_ERROR_INVALID_SIGNATURE;
2975
2976cleanup:
2977 if( status == PSA_SUCCESS )
2978 status = psa_mac_abort( operation );
2979 else
2980 psa_mac_abort( operation );
2981
Gilles Peskine3f108122018-12-07 18:14:53 +01002982 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002983
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002984 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002985}
2986
2987
Gilles Peskine20035e32018-02-03 22:44:14 +01002988
Gilles Peskine20035e32018-02-03 22:44:14 +01002989/****************************************************************/
2990/* Asymmetric cryptography */
2991/****************************************************************/
2992
Gilles Peskine2b450e32018-06-27 15:42:46 +02002993#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002994/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002995 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002996static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
2997 size_t hash_length,
2998 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002999{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003000 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003001 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003002 *md_alg = mbedtls_md_get_type( md_info );
3003
3004 /* The Mbed TLS RSA module uses an unsigned int for hash length
3005 * parameters. Validate that it fits so that we don't risk an
3006 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003007#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003008 if( hash_length > UINT_MAX )
3009 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003010#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003011
3012#if defined(MBEDTLS_PKCS1_V15)
3013 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3014 * must be correct. */
3015 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3016 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003017 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003018 if( md_info == NULL )
3019 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003020 if( mbedtls_md_get_size( md_info ) != hash_length )
3021 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003022 }
3023#endif /* MBEDTLS_PKCS1_V15 */
3024
3025#if defined(MBEDTLS_PKCS1_V21)
3026 /* PSS requires a hash internally. */
3027 if( PSA_ALG_IS_RSA_PSS( alg ) )
3028 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003029 if( md_info == NULL )
3030 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003031 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003032#endif /* MBEDTLS_PKCS1_V21 */
3033
Gilles Peskine61b91d42018-06-08 16:09:36 +02003034 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003035}
3036
Gilles Peskine2b450e32018-06-27 15:42:46 +02003037static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3038 psa_algorithm_t alg,
3039 const uint8_t *hash,
3040 size_t hash_length,
3041 uint8_t *signature,
3042 size_t signature_size,
3043 size_t *signature_length )
3044{
3045 psa_status_t status;
3046 int ret;
3047 mbedtls_md_type_t md_alg;
3048
3049 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3050 if( status != PSA_SUCCESS )
3051 return( status );
3052
Gilles Peskine630a18a2018-06-29 17:49:35 +02003053 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003054 return( PSA_ERROR_BUFFER_TOO_SMALL );
3055
3056#if defined(MBEDTLS_PKCS1_V15)
3057 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3058 {
3059 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3060 MBEDTLS_MD_NONE );
3061 ret = mbedtls_rsa_pkcs1_sign( rsa,
3062 mbedtls_ctr_drbg_random,
3063 &global_data.ctr_drbg,
3064 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003065 md_alg,
3066 (unsigned int) hash_length,
3067 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003068 signature );
3069 }
3070 else
3071#endif /* MBEDTLS_PKCS1_V15 */
3072#if defined(MBEDTLS_PKCS1_V21)
3073 if( PSA_ALG_IS_RSA_PSS( alg ) )
3074 {
3075 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3076 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3077 mbedtls_ctr_drbg_random,
3078 &global_data.ctr_drbg,
3079 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003080 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003081 (unsigned int) hash_length,
3082 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003083 signature );
3084 }
3085 else
3086#endif /* MBEDTLS_PKCS1_V21 */
3087 {
3088 return( PSA_ERROR_INVALID_ARGUMENT );
3089 }
3090
3091 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003092 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003093 return( mbedtls_to_psa_error( ret ) );
3094}
3095
3096static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3097 psa_algorithm_t alg,
3098 const uint8_t *hash,
3099 size_t hash_length,
3100 const uint8_t *signature,
3101 size_t signature_length )
3102{
3103 psa_status_t status;
3104 int ret;
3105 mbedtls_md_type_t md_alg;
3106
3107 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3108 if( status != PSA_SUCCESS )
3109 return( status );
3110
Gilles Peskine630a18a2018-06-29 17:49:35 +02003111 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003112 return( PSA_ERROR_BUFFER_TOO_SMALL );
3113
3114#if defined(MBEDTLS_PKCS1_V15)
3115 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3116 {
3117 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3118 MBEDTLS_MD_NONE );
3119 ret = mbedtls_rsa_pkcs1_verify( rsa,
3120 mbedtls_ctr_drbg_random,
3121 &global_data.ctr_drbg,
3122 MBEDTLS_RSA_PUBLIC,
3123 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003124 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003125 hash,
3126 signature );
3127 }
3128 else
3129#endif /* MBEDTLS_PKCS1_V15 */
3130#if defined(MBEDTLS_PKCS1_V21)
3131 if( PSA_ALG_IS_RSA_PSS( alg ) )
3132 {
3133 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3134 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3135 mbedtls_ctr_drbg_random,
3136 &global_data.ctr_drbg,
3137 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003138 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003139 (unsigned int) hash_length,
3140 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003141 signature );
3142 }
3143 else
3144#endif /* MBEDTLS_PKCS1_V21 */
3145 {
3146 return( PSA_ERROR_INVALID_ARGUMENT );
3147 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003148
3149 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3150 * the rest of the signature is invalid". This has little use in
3151 * practice and PSA doesn't report this distinction. */
3152 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3153 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003154 return( mbedtls_to_psa_error( ret ) );
3155}
3156#endif /* MBEDTLS_RSA_C */
3157
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003158#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003159/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3160 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3161 * (even though these functions don't modify it). */
3162static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3163 psa_algorithm_t alg,
3164 const uint8_t *hash,
3165 size_t hash_length,
3166 uint8_t *signature,
3167 size_t signature_size,
3168 size_t *signature_length )
3169{
3170 int ret;
3171 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003172 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003173 mbedtls_mpi_init( &r );
3174 mbedtls_mpi_init( &s );
3175
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003176 if( signature_size < 2 * curve_bytes )
3177 {
3178 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3179 goto cleanup;
3180 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003181
Gilles Peskinea05219c2018-11-16 16:02:56 +01003182#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003183 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3184 {
3185 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3186 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3187 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3188 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det( &ecp->grp, &r, &s, &ecp->d,
3189 hash, hash_length,
3190 md_alg ) );
3191 }
3192 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003193#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003194 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003195 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003196 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3197 hash, hash_length,
3198 mbedtls_ctr_drbg_random,
3199 &global_data.ctr_drbg ) );
3200 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003201
3202 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3203 signature,
3204 curve_bytes ) );
3205 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3206 signature + curve_bytes,
3207 curve_bytes ) );
3208
3209cleanup:
3210 mbedtls_mpi_free( &r );
3211 mbedtls_mpi_free( &s );
3212 if( ret == 0 )
3213 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003214 return( mbedtls_to_psa_error( ret ) );
3215}
3216
3217static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3218 const uint8_t *hash,
3219 size_t hash_length,
3220 const uint8_t *signature,
3221 size_t signature_length )
3222{
3223 int ret;
3224 mbedtls_mpi r, s;
3225 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3226 mbedtls_mpi_init( &r );
3227 mbedtls_mpi_init( &s );
3228
3229 if( signature_length != 2 * curve_bytes )
3230 return( PSA_ERROR_INVALID_SIGNATURE );
3231
3232 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3233 signature,
3234 curve_bytes ) );
3235 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3236 signature + curve_bytes,
3237 curve_bytes ) );
3238
3239 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3240 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003241
3242cleanup:
3243 mbedtls_mpi_free( &r );
3244 mbedtls_mpi_free( &s );
3245 return( mbedtls_to_psa_error( ret ) );
3246}
3247#endif /* MBEDTLS_ECDSA_C */
3248
Gilles Peskinec5487a82018-12-03 18:08:14 +01003249psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003250 psa_algorithm_t alg,
3251 const uint8_t *hash,
3252 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003253 uint8_t *signature,
3254 size_t signature_size,
3255 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003256{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003257 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003258 psa_status_t status;
3259
3260 *signature_length = signature_size;
3261
Gilles Peskine28f8f302019-07-24 13:30:31 +02003262 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003263 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003264 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003265 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003266 {
3267 status = PSA_ERROR_INVALID_ARGUMENT;
3268 goto exit;
3269 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003270
Gilles Peskine20035e32018-02-03 22:44:14 +01003271#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003272 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003273 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003274 status = psa_rsa_sign( slot->data.rsa,
3275 alg,
3276 hash, hash_length,
3277 signature, signature_size,
3278 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003279 }
3280 else
3281#endif /* defined(MBEDTLS_RSA_C) */
3282#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003283 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003284 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003285#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003286 if(
3287#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3288 PSA_ALG_IS_ECDSA( alg )
3289#else
3290 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3291#endif
3292 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003293 status = psa_ecdsa_sign( slot->data.ecp,
3294 alg,
3295 hash, hash_length,
3296 signature, signature_size,
3297 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003298 else
3299#endif /* defined(MBEDTLS_ECDSA_C) */
3300 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003301 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003302 }
itayzafrir5c753392018-05-08 11:18:38 +03003303 }
3304 else
3305#endif /* defined(MBEDTLS_ECP_C) */
3306 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003307 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003308 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003309
3310exit:
3311 /* Fill the unused part of the output buffer (the whole buffer on error,
3312 * the trailing part on success) with something that isn't a valid mac
3313 * (barring an attack on the mac and deliberately-crafted input),
3314 * in case the caller doesn't check the return status properly. */
3315 if( status == PSA_SUCCESS )
3316 memset( signature + *signature_length, '!',
3317 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003318 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003319 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003320 /* If signature_size is 0 then we have nothing to do. We must not call
3321 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003322 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003323}
3324
Gilles Peskinec5487a82018-12-03 18:08:14 +01003325psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03003326 psa_algorithm_t alg,
3327 const uint8_t *hash,
3328 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02003329 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02003330 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003331{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003332 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003333 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003334
Gilles Peskine28f8f302019-07-24 13:30:31 +02003335 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003336 if( status != PSA_SUCCESS )
3337 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003338
Gilles Peskine61b91d42018-06-08 16:09:36 +02003339#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003340 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003341 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003342 return( psa_rsa_verify( slot->data.rsa,
3343 alg,
3344 hash, hash_length,
3345 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003346 }
3347 else
3348#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003349#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003350 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003351 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003352#if defined(MBEDTLS_ECDSA_C)
3353 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003354 return( psa_ecdsa_verify( slot->data.ecp,
3355 hash, hash_length,
3356 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003357 else
3358#endif /* defined(MBEDTLS_ECDSA_C) */
3359 {
3360 return( PSA_ERROR_INVALID_ARGUMENT );
3361 }
itayzafrir5c753392018-05-08 11:18:38 +03003362 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003363 else
3364#endif /* defined(MBEDTLS_ECP_C) */
3365 {
3366 return( PSA_ERROR_NOT_SUPPORTED );
3367 }
3368}
3369
Gilles Peskine072ac562018-06-30 00:21:29 +02003370#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3371static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3372 mbedtls_rsa_context *rsa )
3373{
3374 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3375 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3376 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3377 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3378}
3379#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3380
Gilles Peskinec5487a82018-12-03 18:08:14 +01003381psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003382 psa_algorithm_t alg,
3383 const uint8_t *input,
3384 size_t input_length,
3385 const uint8_t *salt,
3386 size_t salt_length,
3387 uint8_t *output,
3388 size_t output_size,
3389 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003390{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003391 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003392 psa_status_t status;
3393
Darryl Green5cc689a2018-07-24 15:34:10 +01003394 (void) input;
3395 (void) input_length;
3396 (void) salt;
3397 (void) output;
3398 (void) output_size;
3399
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003400 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003401
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003402 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3403 return( PSA_ERROR_INVALID_ARGUMENT );
3404
Gilles Peskine28f8f302019-07-24 13:30:31 +02003405 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003406 if( status != PSA_SUCCESS )
3407 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003408 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3409 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003410 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003411
3412#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003413 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003414 {
3415 mbedtls_rsa_context *rsa = slot->data.rsa;
3416 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003417 if( output_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine61b91d42018-06-08 16:09:36 +02003418 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003419#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003420 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003421 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003422 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3423 mbedtls_ctr_drbg_random,
3424 &global_data.ctr_drbg,
3425 MBEDTLS_RSA_PUBLIC,
3426 input_length,
3427 input,
3428 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003429 }
3430 else
3431#endif /* MBEDTLS_PKCS1_V15 */
3432#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003433 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003434 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003435 psa_rsa_oaep_set_padding_mode( alg, rsa );
3436 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3437 mbedtls_ctr_drbg_random,
3438 &global_data.ctr_drbg,
3439 MBEDTLS_RSA_PUBLIC,
3440 salt, salt_length,
3441 input_length,
3442 input,
3443 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003444 }
3445 else
3446#endif /* MBEDTLS_PKCS1_V21 */
3447 {
3448 return( PSA_ERROR_INVALID_ARGUMENT );
3449 }
3450 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003451 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003452 return( mbedtls_to_psa_error( ret ) );
3453 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003454 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003455#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003456 {
3457 return( PSA_ERROR_NOT_SUPPORTED );
3458 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003459}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003460
Gilles Peskinec5487a82018-12-03 18:08:14 +01003461psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003462 psa_algorithm_t alg,
3463 const uint8_t *input,
3464 size_t input_length,
3465 const uint8_t *salt,
3466 size_t salt_length,
3467 uint8_t *output,
3468 size_t output_size,
3469 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003470{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003471 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003472 psa_status_t status;
3473
Darryl Green5cc689a2018-07-24 15:34:10 +01003474 (void) input;
3475 (void) input_length;
3476 (void) salt;
3477 (void) output;
3478 (void) output_size;
3479
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003480 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003481
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003482 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3483 return( PSA_ERROR_INVALID_ARGUMENT );
3484
Gilles Peskine28f8f302019-07-24 13:30:31 +02003485 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003486 if( status != PSA_SUCCESS )
3487 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003488 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003489 return( PSA_ERROR_INVALID_ARGUMENT );
3490
3491#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003492 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003493 {
3494 mbedtls_rsa_context *rsa = slot->data.rsa;
3495 int ret;
3496
Gilles Peskine630a18a2018-06-29 17:49:35 +02003497 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003498 return( PSA_ERROR_INVALID_ARGUMENT );
3499
3500#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003501 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003502 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003503 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3504 mbedtls_ctr_drbg_random,
3505 &global_data.ctr_drbg,
3506 MBEDTLS_RSA_PRIVATE,
3507 output_length,
3508 input,
3509 output,
3510 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003511 }
3512 else
3513#endif /* MBEDTLS_PKCS1_V15 */
3514#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003515 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003516 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003517 psa_rsa_oaep_set_padding_mode( alg, rsa );
3518 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3519 mbedtls_ctr_drbg_random,
3520 &global_data.ctr_drbg,
3521 MBEDTLS_RSA_PRIVATE,
3522 salt, salt_length,
3523 output_length,
3524 input,
3525 output,
3526 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003527 }
3528 else
3529#endif /* MBEDTLS_PKCS1_V21 */
3530 {
3531 return( PSA_ERROR_INVALID_ARGUMENT );
3532 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003533
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003534 return( mbedtls_to_psa_error( ret ) );
3535 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003536 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003537#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003538 {
3539 return( PSA_ERROR_NOT_SUPPORTED );
3540 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003541}
Gilles Peskine20035e32018-02-03 22:44:14 +01003542
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003543
3544
mohammad1603503973b2018-03-12 15:59:30 +02003545/****************************************************************/
3546/* Symmetric cryptography */
3547/****************************************************************/
3548
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003549/* Initialize the cipher operation structure. Once this function has been
3550 * called, psa_cipher_abort can run and will do the right thing. */
3551static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3552 psa_algorithm_t alg )
3553{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003554 if( ! PSA_ALG_IS_CIPHER( alg ) )
3555 {
3556 memset( operation, 0, sizeof( *operation ) );
3557 return( PSA_ERROR_INVALID_ARGUMENT );
3558 }
3559
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003560 operation->alg = alg;
3561 operation->key_set = 0;
3562 operation->iv_set = 0;
3563 operation->iv_required = 1;
3564 operation->iv_size = 0;
3565 operation->block_size = 0;
3566 mbedtls_cipher_init( &operation->ctx.cipher );
3567 return( PSA_SUCCESS );
3568}
3569
Gilles Peskinee553c652018-06-04 16:22:46 +02003570static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003571 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003572 psa_algorithm_t alg,
3573 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003574{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003575 int ret = 0;
3576 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003577 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003578 size_t key_bits;
3579 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003580 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3581 PSA_KEY_USAGE_ENCRYPT :
3582 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003583
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003584 /* A context must be freshly initialized before it can be set up. */
3585 if( operation->alg != 0 )
3586 {
3587 return( PSA_ERROR_BAD_STATE );
3588 }
3589
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003590 status = psa_cipher_init( operation, alg );
3591 if( status != PSA_SUCCESS )
3592 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003593
Gilles Peskine28f8f302019-07-24 13:30:31 +02003594 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003595 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003596 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003597 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003598
Gilles Peskine8e338702019-07-30 20:06:31 +02003599 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003600 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003601 {
3602 status = PSA_ERROR_NOT_SUPPORTED;
3603 goto exit;
3604 }
mohammad1603503973b2018-03-12 15:59:30 +02003605
mohammad1603503973b2018-03-12 15:59:30 +02003606 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003607 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003608 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003609
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003610#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003611 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003612 {
3613 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003614 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003615 memcpy( keys, slot->data.raw.data, 16 );
3616 memcpy( keys + 16, slot->data.raw.data, 8 );
3617 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3618 keys,
3619 192, cipher_operation );
3620 }
3621 else
3622#endif
3623 {
3624 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3625 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003626 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003627 }
Moran Peker41deec42018-04-04 15:43:05 +03003628 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003629 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003630
mohammad16038481e742018-03-18 13:57:31 +02003631#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003632 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003633 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003634 case PSA_ALG_CBC_NO_PADDING:
3635 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3636 MBEDTLS_PADDING_NONE );
3637 break;
3638 case PSA_ALG_CBC_PKCS7:
3639 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3640 MBEDTLS_PADDING_PKCS7 );
3641 break;
3642 default:
3643 /* The algorithm doesn't involve padding. */
3644 ret = 0;
3645 break;
3646 }
3647 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003648 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003649#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3650
mohammad1603503973b2018-03-12 15:59:30 +02003651 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003652 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003653 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003654 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003655 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003656 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003657 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003658#if defined(MBEDTLS_CHACHA20_C)
3659 else
3660 if( alg == PSA_ALG_CHACHA20 )
3661 operation->iv_size = 12;
3662#endif
mohammad1603503973b2018-03-12 15:59:30 +02003663
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003664exit:
3665 if( status == 0 )
3666 status = mbedtls_to_psa_error( ret );
3667 if( status != 0 )
3668 psa_cipher_abort( operation );
3669 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003670}
3671
Gilles Peskinefe119512018-07-08 21:39:34 +02003672psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003673 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003674 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003675{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003676 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003677}
3678
Gilles Peskinefe119512018-07-08 21:39:34 +02003679psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003680 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003681 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003682{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003683 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003684}
3685
Gilles Peskinefe119512018-07-08 21:39:34 +02003686psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003687 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003688 size_t iv_size,
3689 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003690{
itayzafrir534bd7c2018-08-02 13:56:32 +03003691 psa_status_t status;
3692 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003693 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003694 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003695 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003696 }
Moran Peker41deec42018-04-04 15:43:05 +03003697 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003698 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003699 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003700 goto exit;
3701 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003702 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3703 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003704 if( ret != 0 )
3705 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003706 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003707 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003708 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003709
mohammad16038481e742018-03-18 13:57:31 +02003710 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003711 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003712
Moran Peker395db872018-05-31 14:07:14 +03003713exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003714 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003715 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003716 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003717}
3718
Gilles Peskinefe119512018-07-08 21:39:34 +02003719psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003720 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003721 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003722{
itayzafrir534bd7c2018-08-02 13:56:32 +03003723 psa_status_t status;
3724 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003725 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003726 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003727 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003728 }
Moran Pekera28258c2018-05-29 16:25:04 +03003729 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003730 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003731 status = PSA_ERROR_INVALID_ARGUMENT;
3732 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003733 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003734 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3735 status = mbedtls_to_psa_error( ret );
3736exit:
3737 if( status == PSA_SUCCESS )
3738 operation->iv_set = 1;
3739 else
mohammad1603503973b2018-03-12 15:59:30 +02003740 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003741 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003742}
3743
Gilles Peskinee553c652018-06-04 16:22:46 +02003744psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3745 const uint8_t *input,
3746 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003747 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003748 size_t output_size,
3749 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003750{
itayzafrir534bd7c2018-08-02 13:56:32 +03003751 psa_status_t status;
3752 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003753 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003754
3755 if( operation->alg == 0 )
3756 {
3757 return( PSA_ERROR_BAD_STATE );
3758 }
3759
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003760 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003761 {
3762 /* Take the unprocessed partial block left over from previous
3763 * update calls, if any, plus the input to this call. Remove
3764 * the last partial block, if any. You get the data that will be
3765 * output in this call. */
3766 expected_output_size =
3767 ( operation->ctx.cipher.unprocessed_len + input_length )
3768 / operation->block_size * operation->block_size;
3769 }
3770 else
3771 {
3772 expected_output_size = input_length;
3773 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003774
Gilles Peskine89d789c2018-06-04 17:17:16 +02003775 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003776 {
3777 status = PSA_ERROR_BUFFER_TOO_SMALL;
3778 goto exit;
3779 }
mohammad160382759612018-03-12 18:16:40 +02003780
mohammad1603503973b2018-03-12 15:59:30 +02003781 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003782 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003783 status = mbedtls_to_psa_error( ret );
3784exit:
3785 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003786 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003787 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003788}
3789
Gilles Peskinee553c652018-06-04 16:22:46 +02003790psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3791 uint8_t *output,
3792 size_t output_size,
3793 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003794{
David Saadab4ecc272019-02-14 13:48:10 +02003795 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003796 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003797 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003798
mohammad1603503973b2018-03-12 15:59:30 +02003799 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003800 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003801 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003802 }
3803 if( operation->iv_required && ! operation->iv_set )
3804 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003805 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003806 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003807
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003808 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003809 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3810 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003811 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003812 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003813 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003814 }
3815
Janos Follath315b51c2018-07-09 16:04:51 +01003816 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3817 temp_output_buffer,
3818 output_length );
3819 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003820 {
Janos Follath315b51c2018-07-09 16:04:51 +01003821 status = mbedtls_to_psa_error( cipher_ret );
3822 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003823 }
Janos Follath315b51c2018-07-09 16:04:51 +01003824
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003825 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003826 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003827 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003828 memcpy( output, temp_output_buffer, *output_length );
3829 else
3830 {
Janos Follath315b51c2018-07-09 16:04:51 +01003831 status = PSA_ERROR_BUFFER_TOO_SMALL;
3832 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003833 }
mohammad1603503973b2018-03-12 15:59:30 +02003834
Gilles Peskine3f108122018-12-07 18:14:53 +01003835 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003836 status = psa_cipher_abort( operation );
3837
3838 return( status );
3839
3840error:
3841
3842 *output_length = 0;
3843
Gilles Peskine3f108122018-12-07 18:14:53 +01003844 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003845 (void) psa_cipher_abort( operation );
3846
3847 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003848}
3849
Gilles Peskinee553c652018-06-04 16:22:46 +02003850psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3851{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003852 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003853 {
3854 /* The object has (apparently) been initialized but it is not
3855 * in use. It's ok to call abort on such an object, and there's
3856 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003857 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003858 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003859
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003860 /* Sanity check (shouldn't happen: operation->alg should
3861 * always have been initialized to a valid value). */
3862 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3863 return( PSA_ERROR_BAD_STATE );
3864
mohammad1603503973b2018-03-12 15:59:30 +02003865 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003866
Moran Peker41deec42018-04-04 15:43:05 +03003867 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003868 operation->key_set = 0;
3869 operation->iv_set = 0;
3870 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003871 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003872 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003873
Moran Peker395db872018-05-31 14:07:14 +03003874 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003875}
3876
Gilles Peskinea0655c32018-04-30 17:06:50 +02003877
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003878
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003879
mohammad16035955c982018-04-26 00:53:03 +03003880/****************************************************************/
3881/* AEAD */
3882/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003883
Gilles Peskineedf9a652018-08-17 18:11:56 +02003884typedef struct
3885{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003886 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003887 const mbedtls_cipher_info_t *cipher_info;
3888 union
3889 {
3890#if defined(MBEDTLS_CCM_C)
3891 mbedtls_ccm_context ccm;
3892#endif /* MBEDTLS_CCM_C */
3893#if defined(MBEDTLS_GCM_C)
3894 mbedtls_gcm_context gcm;
3895#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003896#if defined(MBEDTLS_CHACHAPOLY_C)
3897 mbedtls_chachapoly_context chachapoly;
3898#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003899 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003900 psa_algorithm_t core_alg;
3901 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003902 uint8_t tag_length;
3903} aead_operation_t;
3904
Gilles Peskine30a9e412019-01-14 18:36:12 +01003905static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003906{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003907 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003908 {
3909#if defined(MBEDTLS_CCM_C)
3910 case PSA_ALG_CCM:
3911 mbedtls_ccm_free( &operation->ctx.ccm );
3912 break;
3913#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003914#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003915 case PSA_ALG_GCM:
3916 mbedtls_gcm_free( &operation->ctx.gcm );
3917 break;
3918#endif /* MBEDTLS_GCM_C */
3919 }
3920}
3921
3922static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003923 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003924 psa_key_usage_t usage,
3925 psa_algorithm_t alg )
3926{
3927 psa_status_t status;
3928 size_t key_bits;
3929 mbedtls_cipher_id_t cipher_id;
3930
Gilles Peskine28f8f302019-07-24 13:30:31 +02003931 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003932 if( status != PSA_SUCCESS )
3933 return( status );
3934
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003935 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003936
3937 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02003938 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003939 &cipher_id );
3940 if( operation->cipher_info == NULL )
3941 return( PSA_ERROR_NOT_SUPPORTED );
3942
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003943 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003944 {
3945#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003946 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
3947 operation->core_alg = PSA_ALG_CCM;
3948 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003949 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3950 * The call to mbedtls_ccm_encrypt_and_tag or
3951 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02003952 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003953 return( PSA_ERROR_INVALID_ARGUMENT );
3954 mbedtls_ccm_init( &operation->ctx.ccm );
3955 status = mbedtls_to_psa_error(
3956 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
3957 operation->slot->data.raw.data,
3958 (unsigned int) key_bits ) );
3959 if( status != 0 )
3960 goto cleanup;
3961 break;
3962#endif /* MBEDTLS_CCM_C */
3963
3964#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003965 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
3966 operation->core_alg = PSA_ALG_GCM;
3967 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003968 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3969 * The call to mbedtls_gcm_crypt_and_tag or
3970 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02003971 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003972 return( PSA_ERROR_INVALID_ARGUMENT );
3973 mbedtls_gcm_init( &operation->ctx.gcm );
3974 status = mbedtls_to_psa_error(
3975 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
3976 operation->slot->data.raw.data,
3977 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003978 if( status != 0 )
3979 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003980 break;
3981#endif /* MBEDTLS_GCM_C */
3982
Gilles Peskine26869f22019-05-06 15:25:00 +02003983#if defined(MBEDTLS_CHACHAPOLY_C)
3984 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
3985 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
3986 operation->full_tag_length = 16;
3987 /* We only support the default tag length. */
3988 if( alg != PSA_ALG_CHACHA20_POLY1305 )
3989 return( PSA_ERROR_NOT_SUPPORTED );
3990 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
3991 status = mbedtls_to_psa_error(
3992 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
3993 operation->slot->data.raw.data ) );
3994 if( status != 0 )
3995 goto cleanup;
3996 break;
3997#endif /* MBEDTLS_CHACHAPOLY_C */
3998
Gilles Peskineedf9a652018-08-17 18:11:56 +02003999 default:
4000 return( PSA_ERROR_NOT_SUPPORTED );
4001 }
4002
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004003 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4004 {
4005 status = PSA_ERROR_INVALID_ARGUMENT;
4006 goto cleanup;
4007 }
4008 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004009
Gilles Peskineedf9a652018-08-17 18:11:56 +02004010 return( PSA_SUCCESS );
4011
4012cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004013 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004014 return( status );
4015}
4016
Gilles Peskinec5487a82018-12-03 18:08:14 +01004017psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004018 psa_algorithm_t alg,
4019 const uint8_t *nonce,
4020 size_t nonce_length,
4021 const uint8_t *additional_data,
4022 size_t additional_data_length,
4023 const uint8_t *plaintext,
4024 size_t plaintext_length,
4025 uint8_t *ciphertext,
4026 size_t ciphertext_size,
4027 size_t *ciphertext_length )
4028{
mohammad16035955c982018-04-26 00:53:03 +03004029 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004030 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004031 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004032
mohammad1603f08a5502018-06-03 15:05:47 +03004033 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004034
Gilles Peskinec5487a82018-12-03 18:08:14 +01004035 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004036 if( status != PSA_SUCCESS )
4037 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004038
Gilles Peskineedf9a652018-08-17 18:11:56 +02004039 /* For all currently supported modes, the tag is at the end of the
4040 * ciphertext. */
4041 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4042 {
4043 status = PSA_ERROR_BUFFER_TOO_SMALL;
4044 goto exit;
4045 }
4046 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004047
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004048#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004049 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004050 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004051 status = mbedtls_to_psa_error(
4052 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4053 MBEDTLS_GCM_ENCRYPT,
4054 plaintext_length,
4055 nonce, nonce_length,
4056 additional_data, additional_data_length,
4057 plaintext, ciphertext,
4058 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004059 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004060 else
4061#endif /* MBEDTLS_GCM_C */
4062#if defined(MBEDTLS_CCM_C)
4063 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004064 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004065 status = mbedtls_to_psa_error(
4066 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4067 plaintext_length,
4068 nonce, nonce_length,
4069 additional_data,
4070 additional_data_length,
4071 plaintext, ciphertext,
4072 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004073 }
mohammad16035c8845f2018-05-09 05:40:09 -07004074 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004075#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004076#if defined(MBEDTLS_CHACHAPOLY_C)
4077 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4078 {
4079 if( nonce_length != 12 || operation.tag_length != 16 )
4080 {
4081 status = PSA_ERROR_NOT_SUPPORTED;
4082 goto exit;
4083 }
4084 status = mbedtls_to_psa_error(
4085 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4086 plaintext_length,
4087 nonce,
4088 additional_data,
4089 additional_data_length,
4090 plaintext,
4091 ciphertext,
4092 tag ) );
4093 }
4094 else
4095#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004096 {
mohammad1603554faad2018-06-03 15:07:38 +03004097 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004098 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004099
Gilles Peskineedf9a652018-08-17 18:11:56 +02004100 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4101 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004102
Gilles Peskineedf9a652018-08-17 18:11:56 +02004103exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004104 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004105 if( status == PSA_SUCCESS )
4106 *ciphertext_length = plaintext_length + operation.tag_length;
4107 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004108}
4109
Gilles Peskineee652a32018-06-01 19:23:52 +02004110/* Locate the tag in a ciphertext buffer containing the encrypted data
4111 * followed by the tag. Return the length of the part preceding the tag in
4112 * *plaintext_length. This is the size of the plaintext in modes where
4113 * the encrypted data has the same size as the plaintext, such as
4114 * CCM and GCM. */
4115static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4116 const uint8_t *ciphertext,
4117 size_t ciphertext_length,
4118 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004119 const uint8_t **p_tag )
4120{
4121 size_t payload_length;
4122 if( tag_length > ciphertext_length )
4123 return( PSA_ERROR_INVALID_ARGUMENT );
4124 payload_length = ciphertext_length - tag_length;
4125 if( payload_length > plaintext_size )
4126 return( PSA_ERROR_BUFFER_TOO_SMALL );
4127 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004128 return( PSA_SUCCESS );
4129}
4130
Gilles Peskinec5487a82018-12-03 18:08:14 +01004131psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004132 psa_algorithm_t alg,
4133 const uint8_t *nonce,
4134 size_t nonce_length,
4135 const uint8_t *additional_data,
4136 size_t additional_data_length,
4137 const uint8_t *ciphertext,
4138 size_t ciphertext_length,
4139 uint8_t *plaintext,
4140 size_t plaintext_size,
4141 size_t *plaintext_length )
4142{
mohammad16035955c982018-04-26 00:53:03 +03004143 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004144 aead_operation_t operation;
4145 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004146
Gilles Peskineee652a32018-06-01 19:23:52 +02004147 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004148
Gilles Peskinec5487a82018-12-03 18:08:14 +01004149 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004150 if( status != PSA_SUCCESS )
4151 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004152
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004153 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4154 ciphertext, ciphertext_length,
4155 plaintext_size, &tag );
4156 if( status != PSA_SUCCESS )
4157 goto exit;
4158
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004159#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004160 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004161 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004162 status = mbedtls_to_psa_error(
4163 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4164 ciphertext_length - operation.tag_length,
4165 nonce, nonce_length,
4166 additional_data,
4167 additional_data_length,
4168 tag, operation.tag_length,
4169 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004170 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004171 else
4172#endif /* MBEDTLS_GCM_C */
4173#if defined(MBEDTLS_CCM_C)
4174 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004175 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004176 status = mbedtls_to_psa_error(
4177 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4178 ciphertext_length - operation.tag_length,
4179 nonce, nonce_length,
4180 additional_data,
4181 additional_data_length,
4182 ciphertext, plaintext,
4183 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004184 }
mohammad160339574652018-06-01 04:39:53 -07004185 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004186#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004187#if defined(MBEDTLS_CHACHAPOLY_C)
4188 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4189 {
4190 if( nonce_length != 12 || operation.tag_length != 16 )
4191 {
4192 status = PSA_ERROR_NOT_SUPPORTED;
4193 goto exit;
4194 }
4195 status = mbedtls_to_psa_error(
4196 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4197 ciphertext_length - operation.tag_length,
4198 nonce,
4199 additional_data,
4200 additional_data_length,
4201 tag,
4202 ciphertext,
4203 plaintext ) );
4204 }
4205 else
4206#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004207 {
mohammad1603554faad2018-06-03 15:07:38 +03004208 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004209 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004210
Gilles Peskineedf9a652018-08-17 18:11:56 +02004211 if( status != PSA_SUCCESS && plaintext_size != 0 )
4212 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004213
Gilles Peskineedf9a652018-08-17 18:11:56 +02004214exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004215 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004216 if( status == PSA_SUCCESS )
4217 *plaintext_length = ciphertext_length - operation.tag_length;
4218 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004219}
4220
Gilles Peskinea0655c32018-04-30 17:06:50 +02004221
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004222
Gilles Peskine20035e32018-02-03 22:44:14 +01004223/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004224/* Generators */
4225/****************************************************************/
4226
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004227#define HKDF_STATE_INIT 0 /* no input yet */
4228#define HKDF_STATE_STARTED 1 /* got salt */
4229#define HKDF_STATE_KEYED 2 /* got key */
4230#define HKDF_STATE_OUTPUT 3 /* output started */
4231
Gilles Peskinecbe66502019-05-16 16:59:18 +02004232static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004233 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004234{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004235 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4236 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004237 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004238 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004239}
4240
4241
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004242psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004243{
4244 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004245 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004246 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004247 {
4248 /* The object has (apparently) been initialized but it is not
4249 * in use. It's ok to call abort on such an object, and there's
4250 * nothing to do. */
4251 }
4252 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004253#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004254 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004255 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004256 mbedtls_free( operation->ctx.hkdf.info );
4257 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004258 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004259 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004260 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004261 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004262 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004263#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004264 if( operation->ctx.tls12_prf.key != NULL )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004265 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004266 mbedtls_platform_zeroize( operation->ctx.tls12_prf.key,
4267 operation->ctx.tls12_prf.key_len );
4268 mbedtls_free( operation->ctx.tls12_prf.key );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004269 }
Hanno Becker580fba12018-11-13 20:50:45 +00004270
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004271 if( operation->ctx.tls12_prf.Ai_with_seed != NULL )
Hanno Becker580fba12018-11-13 20:50:45 +00004272 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004273 mbedtls_platform_zeroize( operation->ctx.tls12_prf.Ai_with_seed,
4274 operation->ctx.tls12_prf.Ai_with_seed_len );
4275 mbedtls_free( operation->ctx.tls12_prf.Ai_with_seed );
Hanno Becker580fba12018-11-13 20:50:45 +00004276 }
Janos Follath6a1d2622019-06-11 10:37:28 +01004277#else
4278 if( operation->ctx.tls12_prf.seed != NULL )
4279 {
4280 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4281 operation->ctx.tls12_prf.seed_length );
4282 mbedtls_free( operation->ctx.tls12_prf.seed );
4283 }
4284
4285 if( operation->ctx.tls12_prf.label != NULL )
4286 {
4287 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4288 operation->ctx.tls12_prf.label_length );
4289 mbedtls_free( operation->ctx.tls12_prf.label );
4290 }
4291
4292 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4293
4294 /* We leave the fields Ai and output_block to be erased safely by the
4295 * mbedtls_platform_zeroize() in the end of this function. */
Janos Follath999f6482019-06-11 12:04:10 +01004296#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004297 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004298 else
4299#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004300 {
4301 status = PSA_ERROR_BAD_STATE;
4302 }
Janos Follath083036a2019-06-11 10:22:26 +01004303 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004304 return( status );
4305}
4306
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004307psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004308 size_t *capacity)
4309{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004310 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004311 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004312 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004313 return PSA_ERROR_BAD_STATE;
4314 }
4315
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004316 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004317 return( PSA_SUCCESS );
4318}
4319
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004320psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004321 size_t capacity )
4322{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004323 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004324 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004325 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004326 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004327 operation->capacity = capacity;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004328 return( PSA_SUCCESS );
4329}
4330
Gilles Peskinebef7f142018-07-12 17:22:21 +02004331#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004332/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004333 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004334static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004335 psa_algorithm_t hash_alg,
4336 uint8_t *output,
4337 size_t output_length )
4338{
4339 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4340 psa_status_t status;
4341
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004342 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4343 return( PSA_ERROR_BAD_STATE );
4344 hkdf->state = HKDF_STATE_OUTPUT;
4345
Gilles Peskinebef7f142018-07-12 17:22:21 +02004346 while( output_length != 0 )
4347 {
4348 /* Copy what remains of the current block */
4349 uint8_t n = hash_length - hkdf->offset_in_block;
4350 if( n > output_length )
4351 n = (uint8_t) output_length;
4352 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4353 output += n;
4354 output_length -= n;
4355 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004356 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004357 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004358 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004359 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004360 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004361 * object was corrupted or if this function is called directly
4362 * inside the library. */
4363 if( hkdf->block_number == 0xff )
4364 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004365
4366 /* We need a new block */
4367 ++hkdf->block_number;
4368 hkdf->offset_in_block = 0;
4369 status = psa_hmac_setup_internal( &hkdf->hmac,
4370 hkdf->prk, hash_length,
4371 hash_alg );
4372 if( status != PSA_SUCCESS )
4373 return( status );
4374 if( hkdf->block_number != 1 )
4375 {
4376 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4377 hkdf->output_block,
4378 hash_length );
4379 if( status != PSA_SUCCESS )
4380 return( status );
4381 }
4382 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4383 hkdf->info,
4384 hkdf->info_length );
4385 if( status != PSA_SUCCESS )
4386 return( status );
4387 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4388 &hkdf->block_number, 1 );
4389 if( status != PSA_SUCCESS )
4390 return( status );
4391 status = psa_hmac_finish_internal( &hkdf->hmac,
4392 hkdf->output_block,
4393 sizeof( hkdf->output_block ) );
4394 if( status != PSA_SUCCESS )
4395 return( status );
4396 }
4397
4398 return( PSA_SUCCESS );
4399}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004400
Janos Follath999f6482019-06-11 12:04:10 +01004401#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004402static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4403 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004404 psa_algorithm_t alg )
4405{
4406 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4407 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4408 psa_hmac_internal_data hmac;
4409 psa_status_t status, cleanup_status;
4410
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004411 uint8_t *Ai;
Hanno Becker3b339e22018-11-13 20:56:14 +00004412 size_t Ai_len;
4413
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004414 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004415 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004416 * prevented this call. It could happen only if the operation
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004417 * object was corrupted or if this function is called directly
4418 * inside the library. */
4419 if( tls12_prf->block_number == 0xff )
4420 return( PSA_ERROR_BAD_STATE );
4421
4422 /* We need a new block */
4423 ++tls12_prf->block_number;
4424 tls12_prf->offset_in_block = 0;
4425
4426 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4427 *
4428 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4429 *
4430 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4431 * HMAC_hash(secret, A(2) + seed) +
4432 * HMAC_hash(secret, A(3) + seed) + ...
4433 *
4434 * A(0) = seed
4435 * A(i) = HMAC_hash( secret, A(i-1) )
4436 *
Gilles Peskinecbe66502019-05-16 16:59:18 +02004437 * The `psa_tls12_prf_key_derivation` structures saves the block
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004438 * `HMAC_hash(secret, A(i) + seed)` from which the output
4439 * is currently extracted as `output_block`, while
4440 * `A(i) + seed` is stored in `Ai_with_seed`.
4441 *
4442 * Generating a new block means recalculating `Ai_with_seed`
4443 * from the A(i)-part of it, and afterwards recalculating
4444 * `output_block`.
4445 *
4446 * A(0) is computed at setup time.
4447 *
4448 */
4449
4450 psa_hmac_init_internal( &hmac );
4451
4452 /* We must distinguish the calculation of A(1) from those
4453 * of A(2) and higher, because A(0)=seed has a different
4454 * length than the other A(i). */
4455 if( tls12_prf->block_number == 1 )
4456 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004457 Ai = tls12_prf->Ai_with_seed + hash_length;
4458 Ai_len = tls12_prf->Ai_with_seed_len - hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004459 }
4460 else
4461 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004462 Ai = tls12_prf->Ai_with_seed;
4463 Ai_len = hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004464 }
4465
Hanno Becker3b339e22018-11-13 20:56:14 +00004466 /* Compute A(i+1) = HMAC_hash(secret, A(i)) */
4467 status = psa_hmac_setup_internal( &hmac,
4468 tls12_prf->key,
4469 tls12_prf->key_len,
4470 hash_alg );
4471 if( status != PSA_SUCCESS )
4472 goto cleanup;
4473
4474 status = psa_hash_update( &hmac.hash_ctx,
4475 Ai, Ai_len );
4476 if( status != PSA_SUCCESS )
4477 goto cleanup;
4478
4479 status = psa_hmac_finish_internal( &hmac,
4480 tls12_prf->Ai_with_seed,
4481 hash_length );
4482 if( status != PSA_SUCCESS )
4483 goto cleanup;
4484
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004485 /* Compute the next block `HMAC_hash(secret, A(i+1) + seed)`. */
4486 status = psa_hmac_setup_internal( &hmac,
4487 tls12_prf->key,
4488 tls12_prf->key_len,
4489 hash_alg );
4490 if( status != PSA_SUCCESS )
4491 goto cleanup;
4492
4493 status = psa_hash_update( &hmac.hash_ctx,
4494 tls12_prf->Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00004495 tls12_prf->Ai_with_seed_len );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004496 if( status != PSA_SUCCESS )
4497 goto cleanup;
4498
4499 status = psa_hmac_finish_internal( &hmac,
4500 tls12_prf->output_block,
4501 hash_length );
4502 if( status != PSA_SUCCESS )
4503 goto cleanup;
4504
4505cleanup:
4506
4507 cleanup_status = psa_hmac_abort_internal( &hmac );
4508 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4509 status = cleanup_status;
4510
4511 return( status );
4512}
Janos Follath7742fee2019-06-17 12:58:10 +01004513#else
4514static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4515 psa_tls12_prf_key_derivation_t *tls12_prf,
4516 psa_algorithm_t alg )
4517{
4518 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4519 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004520 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4521 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004522
Janos Follath7742fee2019-06-17 12:58:10 +01004523 /* We can't be wanting more output after block 0xff, otherwise
4524 * the capacity check in psa_key_derivation_output_bytes() would have
4525 * prevented this call. It could happen only if the operation
4526 * object was corrupted or if this function is called directly
4527 * inside the library. */
4528 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004529 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004530
4531 /* We need a new block */
4532 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004533 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004534
4535 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4536 *
4537 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4538 *
4539 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4540 * HMAC_hash(secret, A(2) + seed) +
4541 * HMAC_hash(secret, A(3) + seed) + ...
4542 *
4543 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004544 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004545 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004546 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004547 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004548 * is currently extracted as `output_block` and where i is
4549 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004550 */
4551
Janos Follathea29bfb2019-06-19 12:21:20 +01004552 /* Save the hash context before using it, to preserve the hash state with
4553 * only the inner padding in it. We need this, because inner padding depends
4554 * on the key (secret in the RFC's terminology). */
4555 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4556 if( status != PSA_SUCCESS )
4557 goto cleanup;
4558
4559 /* Calculate A(i) where i = tls12_prf->block_number. */
4560 if( tls12_prf->block_number == 1 )
4561 {
4562 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4563 * the variable seed and in this instance means it in the context of the
4564 * P_hash function, where seed = label + seed.) */
4565 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4566 tls12_prf->label, tls12_prf->label_length );
4567 if( status != PSA_SUCCESS )
4568 goto cleanup;
4569 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4570 tls12_prf->seed, tls12_prf->seed_length );
4571 if( status != PSA_SUCCESS )
4572 goto cleanup;
4573 }
4574 else
4575 {
4576 /* A(i) = HMAC_hash(secret, A(i-1)) */
4577 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4578 tls12_prf->Ai, hash_length );
4579 if( status != PSA_SUCCESS )
4580 goto cleanup;
4581 }
4582
4583 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4584 tls12_prf->Ai, hash_length );
4585 if( status != PSA_SUCCESS )
4586 goto cleanup;
4587 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4588 if( status != PSA_SUCCESS )
4589 goto cleanup;
4590
4591 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4592 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4593 tls12_prf->Ai, hash_length );
4594 if( status != PSA_SUCCESS )
4595 goto cleanup;
4596 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4597 tls12_prf->label, tls12_prf->label_length );
4598 if( status != PSA_SUCCESS )
4599 goto cleanup;
4600 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4601 tls12_prf->seed, tls12_prf->seed_length );
4602 if( status != PSA_SUCCESS )
4603 goto cleanup;
4604 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4605 tls12_prf->output_block, hash_length );
4606 if( status != PSA_SUCCESS )
4607 goto cleanup;
4608 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4609 if( status != PSA_SUCCESS )
4610 goto cleanup;
4611
Janos Follath7742fee2019-06-17 12:58:10 +01004612
4613cleanup:
4614
Janos Follathea29bfb2019-06-19 12:21:20 +01004615 cleanup_status = psa_hash_abort( &backup );
4616 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4617 status = cleanup_status;
4618
4619 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004620}
Janos Follath999f6482019-06-11 12:04:10 +01004621#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004622
Janos Follath999f6482019-06-11 12:04:10 +01004623#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004624/* Read some bytes from an TLS-1.2-PRF-based operation.
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004625 * See Section 5 of RFC 5246. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004626static psa_status_t psa_key_derivation_tls12_prf_read(
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004627 psa_tls12_prf_key_derivation_t *tls12_prf,
4628 psa_algorithm_t alg,
4629 uint8_t *output,
4630 size_t output_length )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004631{
4632 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4633 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4634 psa_status_t status;
4635
4636 while( output_length != 0 )
4637 {
4638 /* Copy what remains of the current block */
4639 uint8_t n = hash_length - tls12_prf->offset_in_block;
4640
4641 /* Check if we have fully processed the current block. */
4642 if( n == 0 )
4643 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004644 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004645 alg );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004646 if( status != PSA_SUCCESS )
4647 return( status );
4648
4649 continue;
4650 }
4651
4652 if( n > output_length )
4653 n = (uint8_t) output_length;
4654 memcpy( output, tls12_prf->output_block + tls12_prf->offset_in_block,
4655 n );
4656 output += n;
4657 output_length -= n;
4658 tls12_prf->offset_in_block += n;
4659 }
4660
4661 return( PSA_SUCCESS );
4662}
Janos Follath844eb0e2019-06-19 12:10:49 +01004663#else
4664static psa_status_t psa_key_derivation_tls12_prf_read(
4665 psa_tls12_prf_key_derivation_t *tls12_prf,
4666 psa_algorithm_t alg,
4667 uint8_t *output,
4668 size_t output_length )
4669{
4670 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4671 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4672 psa_status_t status;
4673 uint8_t offset, length;
4674
4675 while( output_length != 0 )
4676 {
4677 /* Check if we have fully processed the current block. */
4678 if( tls12_prf->left_in_block == 0 )
4679 {
4680 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4681 alg );
4682 if( status != PSA_SUCCESS )
4683 return( status );
4684
4685 continue;
4686 }
4687
4688 if( tls12_prf->left_in_block > output_length )
4689 length = (uint8_t) output_length;
4690 else
4691 length = tls12_prf->left_in_block;
4692
4693 offset = hash_length - tls12_prf->left_in_block;
4694 memcpy( output, tls12_prf->output_block + offset, length );
4695 output += length;
4696 output_length -= length;
4697 tls12_prf->left_in_block -= length;
4698 }
4699
4700 return( PSA_SUCCESS );
4701}
Janos Follath999f6482019-06-11 12:04:10 +01004702#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004703#endif /* MBEDTLS_MD_C */
4704
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004705psa_status_t psa_key_derivation_output_bytes(
4706 psa_key_derivation_operation_t *operation,
4707 uint8_t *output,
4708 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004709{
4710 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004711 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004712
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004713 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004714 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004715 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004716 return PSA_ERROR_BAD_STATE;
4717 }
4718
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004719 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004720 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004721 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004722 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004723 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004724 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004725 goto exit;
4726 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004727 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004728 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004729 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004730 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004731 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4732 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004733 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004734 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004735 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004736 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004737 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004738
Gilles Peskinebef7f142018-07-12 17:22:21 +02004739#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004740 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004741 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004742 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004743 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004744 output, output_length );
4745 }
Janos Follathadbec812019-06-14 11:05:39 +01004746 else
Janos Follathadbec812019-06-14 11:05:39 +01004747 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004748 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004749 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004750 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004751 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004752 output_length );
4753 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004754 else
4755#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004756 {
4757 return( PSA_ERROR_BAD_STATE );
4758 }
4759
4760exit:
4761 if( status != PSA_SUCCESS )
4762 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004763 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004764 * This allows us to differentiate between exhausted operations and
4765 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4766 * operations. */
4767 psa_algorithm_t alg = operation->alg;
4768 psa_key_derivation_abort( operation );
4769 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004770 memset( output, '!', output_length );
4771 }
4772 return( status );
4773}
4774
Gilles Peskine08542d82018-07-19 17:05:42 +02004775#if defined(MBEDTLS_DES_C)
4776static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4777{
4778 if( data_size >= 8 )
4779 mbedtls_des_key_set_parity( data );
4780 if( data_size >= 16 )
4781 mbedtls_des_key_set_parity( data + 8 );
4782 if( data_size >= 24 )
4783 mbedtls_des_key_set_parity( data + 16 );
4784}
4785#endif /* MBEDTLS_DES_C */
4786
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004787static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004788 psa_key_slot_t *slot,
4789 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004790 psa_key_derivation_operation_t *operation )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004791{
4792 uint8_t *data = NULL;
4793 size_t bytes = PSA_BITS_TO_BYTES( bits );
4794 psa_status_t status;
4795
Gilles Peskine8e338702019-07-30 20:06:31 +02004796 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004797 return( PSA_ERROR_INVALID_ARGUMENT );
4798 if( bits % 8 != 0 )
4799 return( PSA_ERROR_INVALID_ARGUMENT );
4800 data = mbedtls_calloc( 1, bytes );
4801 if( data == NULL )
4802 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4803
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004804 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004805 if( status != PSA_SUCCESS )
4806 goto exit;
4807#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004808 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004809 psa_des_set_key_parity( data, bytes );
4810#endif /* MBEDTLS_DES_C */
4811 status = psa_import_key_into_slot( slot, data, bytes );
4812
4813exit:
4814 mbedtls_free( data );
4815 return( status );
4816}
4817
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004818psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004819 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004820 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004821{
4822 psa_status_t status;
4823 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004824 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinedf179142019-07-15 22:02:14 +02004825 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
4826 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004827#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4828 if( driver != NULL )
4829 {
4830 /* Deriving a key in a secure element is not implemented yet. */
4831 status = PSA_ERROR_NOT_SUPPORTED;
4832 }
4833#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004834 if( status == PSA_SUCCESS )
4835 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004836 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004837 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004838 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004839 }
4840 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004841 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004842 if( status != PSA_SUCCESS )
4843 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004844 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004845 *handle = 0;
4846 }
4847 return( status );
4848}
4849
Gilles Peskineeab56e42018-07-12 17:12:33 +02004850
4851
4852/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004853/* Key derivation */
4854/****************************************************************/
4855
Gilles Peskinea05219c2018-11-16 16:02:56 +01004856#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004857#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004858/* Set up an HKDF-based operation. This is exactly the extract phase
Gilles Peskine346797d2018-11-16 16:05:06 +01004859 * of the HKDF algorithm.
4860 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004861 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004862 * to potentially free embedded data structures and wipe confidential data.
4863 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004864static psa_status_t psa_key_derivation_hkdf_setup( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004865 const uint8_t *secret,
4866 size_t secret_length,
4867 psa_algorithm_t hash_alg,
4868 const uint8_t *salt,
4869 size_t salt_length,
4870 const uint8_t *label,
4871 size_t label_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004872{
4873 psa_status_t status;
4874 status = psa_hmac_setup_internal( &hkdf->hmac,
4875 salt, salt_length,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004876 hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004877 if( status != PSA_SUCCESS )
4878 return( status );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004879 status = psa_hash_update( &hkdf->hmac.hash_ctx, secret, secret_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004880 if( status != PSA_SUCCESS )
4881 return( status );
4882 status = psa_hmac_finish_internal( &hkdf->hmac,
4883 hkdf->prk,
4884 sizeof( hkdf->prk ) );
4885 if( status != PSA_SUCCESS )
4886 return( status );
4887 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4888 hkdf->block_number = 0;
4889 hkdf->info_length = label_length;
4890 if( label_length != 0 )
4891 {
4892 hkdf->info = mbedtls_calloc( 1, label_length );
4893 if( hkdf->info == NULL )
4894 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4895 memcpy( hkdf->info, label, label_length );
4896 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004897 hkdf->state = HKDF_STATE_KEYED;
4898 hkdf->info_set = 1;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004899 return( PSA_SUCCESS );
4900}
Janos Follath71a4c912019-06-11 09:14:47 +01004901#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01004902#endif /* MBEDTLS_MD_C */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004903
Gilles Peskinea05219c2018-11-16 16:02:56 +01004904#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004905#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004906/* Set up a TLS-1.2-prf-based operation (see RFC 5246, Section 5).
Gilles Peskine346797d2018-11-16 16:05:06 +01004907 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004908 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004909 * to potentially free embedded data structures and wipe confidential data.
4910 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004911static psa_status_t psa_key_derivation_tls12_prf_setup(
4912 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004913 const uint8_t *key,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004914 size_t key_len,
4915 psa_algorithm_t hash_alg,
4916 const uint8_t *salt,
4917 size_t salt_length,
4918 const uint8_t *label,
4919 size_t label_length )
4920{
4921 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Hanno Becker580fba12018-11-13 20:50:45 +00004922 size_t Ai_with_seed_len = hash_length + salt_length + label_length;
4923 int overflow;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004924
4925 tls12_prf->key = mbedtls_calloc( 1, key_len );
4926 if( tls12_prf->key == NULL )
4927 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4928 tls12_prf->key_len = key_len;
4929 memcpy( tls12_prf->key, key, key_len );
4930
Hanno Becker580fba12018-11-13 20:50:45 +00004931 overflow = ( salt_length + label_length < salt_length ) ||
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004932 ( salt_length + label_length + hash_length < hash_length );
Hanno Becker580fba12018-11-13 20:50:45 +00004933 if( overflow )
4934 return( PSA_ERROR_INVALID_ARGUMENT );
4935
4936 tls12_prf->Ai_with_seed = mbedtls_calloc( 1, Ai_with_seed_len );
4937 if( tls12_prf->Ai_with_seed == NULL )
4938 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4939 tls12_prf->Ai_with_seed_len = Ai_with_seed_len;
4940
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004941 /* Write `label + seed' at the end of the `A(i) + seed` buffer,
4942 * leaving the initial `hash_length` bytes unspecified for now. */
Hanno Becker353e4532018-11-15 09:53:57 +00004943 if( label_length != 0 )
4944 {
4945 memcpy( tls12_prf->Ai_with_seed + hash_length,
4946 label, label_length );
4947 }
4948
4949 if( salt_length != 0 )
4950 {
4951 memcpy( tls12_prf->Ai_with_seed + hash_length + label_length,
4952 salt, salt_length );
4953 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004954
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004955 /* The first block gets generated when
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004956 * psa_key_derivation_output_bytes() is called. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004957 tls12_prf->block_number = 0;
4958 tls12_prf->offset_in_block = hash_length;
4959
4960 return( PSA_SUCCESS );
4961}
Janos Follath71a4c912019-06-11 09:14:47 +01004962#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Becker1aaedc02018-11-16 11:35:34 +00004963
Janos Follath71a4c912019-06-11 09:14:47 +01004964#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004965/* Set up a TLS-1.2-PSK-to-MS-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004966static psa_status_t psa_key_derivation_tls12_psk_to_ms_setup(
4967 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004968 const uint8_t *psk,
Hanno Becker1aaedc02018-11-16 11:35:34 +00004969 size_t psk_len,
4970 psa_algorithm_t hash_alg,
4971 const uint8_t *salt,
4972 size_t salt_length,
4973 const uint8_t *label,
4974 size_t label_length )
4975{
4976 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004977 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
Hanno Becker1aaedc02018-11-16 11:35:34 +00004978
4979 if( psk_len > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4980 return( PSA_ERROR_INVALID_ARGUMENT );
4981
4982 /* Quoting RFC 4279, Section 2:
4983 *
4984 * The premaster secret is formed as follows: if the PSK is N octets
4985 * long, concatenate a uint16 with the value N, N zero octets, a second
4986 * uint16 with the value N, and the PSK itself.
4987 */
4988
4989 pms[0] = ( psk_len >> 8 ) & 0xff;
4990 pms[1] = ( psk_len >> 0 ) & 0xff;
4991 memset( pms + 2, 0, psk_len );
4992 pms[2 + psk_len + 0] = pms[0];
4993 pms[2 + psk_len + 1] = pms[1];
4994 memcpy( pms + 4 + psk_len, psk, psk_len );
4995
Gilles Peskinecbe66502019-05-16 16:59:18 +02004996 status = psa_key_derivation_tls12_prf_setup( tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004997 pms, 4 + 2 * psk_len,
4998 hash_alg,
4999 salt, salt_length,
5000 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005001
Gilles Peskine3f108122018-12-07 18:14:53 +01005002 mbedtls_platform_zeroize( pms, sizeof( pms ) );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005003 return( status );
5004}
Janos Follath71a4c912019-06-11 09:14:47 +01005005#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01005006#endif /* MBEDTLS_MD_C */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005007
Janos Follath71a4c912019-06-11 09:14:47 +01005008#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005009/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005010 * to potentially free embedded data structures and wipe confidential data.
5011 */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005012static psa_status_t psa_key_derivation_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005013 psa_key_derivation_operation_t *operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005014 const uint8_t *secret, size_t secret_length,
5015 psa_algorithm_t alg,
5016 const uint8_t *salt, size_t salt_length,
5017 const uint8_t *label, size_t label_length,
5018 size_t capacity )
5019{
5020 psa_status_t status;
5021 size_t max_capacity;
5022
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005023 /* Set operation->alg even on failure so that abort knows what to do. */
5024 operation->alg = alg;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005025
5026#if defined(MBEDTLS_MD_C)
5027 if( PSA_ALG_IS_HKDF( alg ) )
5028 {
5029 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5030 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5031 if( hash_size == 0 )
5032 return( PSA_ERROR_NOT_SUPPORTED );
5033 max_capacity = 255 * hash_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005034 status = psa_key_derivation_hkdf_setup( &operation->ctx.hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005035 secret, secret_length,
5036 hash_alg,
5037 salt, salt_length,
5038 label, label_length );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005039 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00005040 /* TLS-1.2 PRF and TLS-1.2 PSK-to-MS are very similar, so share code. */
5041 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
5042 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005043 {
5044 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5045 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5046
5047 /* TLS-1.2 PRF supports only SHA-256 and SHA-384. */
5048 if( hash_alg != PSA_ALG_SHA_256 &&
5049 hash_alg != PSA_ALG_SHA_384 )
5050 {
5051 return( PSA_ERROR_NOT_SUPPORTED );
5052 }
5053
5054 max_capacity = 255 * hash_size;
Hanno Becker1aaedc02018-11-16 11:35:34 +00005055
5056 if( PSA_ALG_IS_TLS12_PRF( alg ) )
5057 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005058 status = psa_key_derivation_tls12_prf_setup( &operation->ctx.tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005059 secret, secret_length,
5060 hash_alg, salt, salt_length,
5061 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005062 }
5063 else
5064 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02005065 status = psa_key_derivation_tls12_psk_to_ms_setup(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005066 &operation->ctx.tls12_prf,
Hanno Becker1aaedc02018-11-16 11:35:34 +00005067 secret, secret_length,
5068 hash_alg, salt, salt_length,
5069 label, label_length );
5070 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005071 }
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005072 else
5073#endif
5074 {
5075 return( PSA_ERROR_NOT_SUPPORTED );
5076 }
5077
5078 if( status != PSA_SUCCESS )
5079 return( status );
5080
5081 if( capacity <= max_capacity )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005082 operation->capacity = capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005083 else if( capacity == PSA_KEY_DERIVATION_UNLIMITED_CAPACITY )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005084 operation->capacity = max_capacity;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005085 else
5086 return( PSA_ERROR_INVALID_ARGUMENT );
5087
5088 return( PSA_SUCCESS );
5089}
Janos Follath71a4c912019-06-11 09:14:47 +01005090#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005091
Janos Follath71a4c912019-06-11 09:14:47 +01005092#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005093psa_status_t psa_key_derivation( psa_key_derivation_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01005094 psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +02005095 psa_algorithm_t alg,
5096 const uint8_t *salt,
5097 size_t salt_length,
5098 const uint8_t *label,
5099 size_t label_length,
5100 size_t capacity )
5101{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005102 psa_key_slot_t *slot;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005103 psa_status_t status;
5104
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005105 if( operation->alg != 0 )
Gilles Peskineea0fb492018-07-12 17:17:20 +02005106 return( PSA_ERROR_BAD_STATE );
5107
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005108 /* Make sure that alg is a key derivation algorithm. This prevents
5109 * key selection algorithms, which psa_key_derivation_internal
5110 * accepts for the sake of key agreement. */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005111 if( ! PSA_ALG_IS_KEY_DERIVATION( alg ) )
5112 return( PSA_ERROR_INVALID_ARGUMENT );
5113
Gilles Peskine28f8f302019-07-24 13:30:31 +02005114 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005115 if( status != PSA_SUCCESS )
5116 return( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005117
Gilles Peskine8e338702019-07-30 20:06:31 +02005118 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005119 return( PSA_ERROR_INVALID_ARGUMENT );
5120
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005121 status = psa_key_derivation_internal( operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005122 slot->data.raw.data,
5123 slot->data.raw.bytes,
5124 alg,
5125 salt, salt_length,
5126 label, label_length,
5127 capacity );
5128 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005129 psa_key_derivation_abort( operation );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005130 return( status );
5131}
Janos Follath71a4c912019-06-11 09:14:47 +01005132#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005133
Gilles Peskine969c5d62019-01-16 15:53:06 +01005134static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005135 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005136 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005137{
Janos Follath5fe19732019-06-20 15:09:30 +01005138 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5139 * initialisers for this union leave some bytes unspecified.) */
5140 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5141
Gilles Peskine969c5d62019-01-16 15:53:06 +01005142 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005143#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005144 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5145 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5146 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005147 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005148 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005149 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5150 if( hash_size == 0 )
5151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005152 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5153 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005154 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005155 {
5156 return( PSA_ERROR_NOT_SUPPORTED );
5157 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005158 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005159 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005160 }
5161#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005162 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005163 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005164}
5165
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005166psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005167 psa_algorithm_t alg )
5168{
5169 psa_status_t status;
5170
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005171 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005172 return( PSA_ERROR_BAD_STATE );
5173
Gilles Peskine6843c292019-01-18 16:44:49 +01005174 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5175 return( PSA_ERROR_INVALID_ARGUMENT );
5176 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005177 {
5178 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005179 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005180 }
5181 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5182 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005183 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005184 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005185 else
5186 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005187
5188 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005189 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005190 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005191}
5192
5193#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005194static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005195 psa_algorithm_t hash_alg,
5196 psa_key_derivation_step_t step,
5197 const uint8_t *data,
5198 size_t data_length )
5199{
5200 psa_status_t status;
5201 switch( step )
5202 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005203 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005204 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005205 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005206 status = psa_hmac_setup_internal( &hkdf->hmac,
5207 data, data_length,
5208 hash_alg );
5209 if( status != PSA_SUCCESS )
5210 return( status );
5211 hkdf->state = HKDF_STATE_STARTED;
5212 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005213 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005214 /* If no salt was provided, use an empty salt. */
5215 if( hkdf->state == HKDF_STATE_INIT )
5216 {
5217 status = psa_hmac_setup_internal( &hkdf->hmac,
5218 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005219 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005220 if( status != PSA_SUCCESS )
5221 return( status );
5222 hkdf->state = HKDF_STATE_STARTED;
5223 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005224 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005225 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005226 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5227 data, data_length );
5228 if( status != PSA_SUCCESS )
5229 return( status );
5230 status = psa_hmac_finish_internal( &hkdf->hmac,
5231 hkdf->prk,
5232 sizeof( hkdf->prk ) );
5233 if( status != PSA_SUCCESS )
5234 return( status );
5235 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5236 hkdf->block_number = 0;
5237 hkdf->state = HKDF_STATE_KEYED;
5238 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005239 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005240 if( hkdf->state == HKDF_STATE_OUTPUT )
5241 return( PSA_ERROR_BAD_STATE );
5242 if( hkdf->info_set )
5243 return( PSA_ERROR_BAD_STATE );
5244 hkdf->info_length = data_length;
5245 if( data_length != 0 )
5246 {
5247 hkdf->info = mbedtls_calloc( 1, data_length );
5248 if( hkdf->info == NULL )
5249 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5250 memcpy( hkdf->info, data, data_length );
5251 }
5252 hkdf->info_set = 1;
5253 return( PSA_SUCCESS );
5254 default:
5255 return( PSA_ERROR_INVALID_ARGUMENT );
5256 }
5257}
Janos Follathb03233e2019-06-11 15:30:30 +01005258
5259#if defined(PSA_PRE_1_0_KEY_DERIVATION)
5260static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5261 psa_algorithm_t hash_alg,
5262 psa_key_derivation_step_t step,
5263 const uint8_t *data,
5264 size_t data_length )
5265{
5266 (void) prf;
5267 (void) hash_alg;
5268 (void) step;
5269 (void) data;
5270 (void) data_length;
5271
5272 return( PSA_ERROR_INVALID_ARGUMENT );
5273}
Janos Follath6660f0e2019-06-17 08:44:03 +01005274
5275static psa_status_t psa_tls12_prf_psk_to_ms_input(
5276 psa_tls12_prf_key_derivation_t *prf,
5277 psa_algorithm_t hash_alg,
5278 psa_key_derivation_step_t step,
5279 const uint8_t *data,
5280 size_t data_length )
5281{
5282 (void) prf;
5283 (void) hash_alg;
5284 (void) step;
5285 (void) data;
5286 (void) data_length;
5287
5288 return( PSA_ERROR_INVALID_ARGUMENT );
5289}
Janos Follathb03233e2019-06-11 15:30:30 +01005290#else
Janos Follathf08e2652019-06-13 09:05:41 +01005291static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5292 const uint8_t *data,
5293 size_t data_length )
5294{
5295 if( prf->state != TLS12_PRF_STATE_INIT )
5296 return( PSA_ERROR_BAD_STATE );
5297
Janos Follathd6dce9f2019-07-04 09:11:38 +01005298 if( data_length != 0 )
5299 {
5300 prf->seed = mbedtls_calloc( 1, data_length );
5301 if( prf->seed == NULL )
5302 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005303
Janos Follathd6dce9f2019-07-04 09:11:38 +01005304 memcpy( prf->seed, data, data_length );
5305 prf->seed_length = data_length;
5306 }
Janos Follathf08e2652019-06-13 09:05:41 +01005307
5308 prf->state = TLS12_PRF_STATE_SEED_SET;
5309
5310 return( PSA_SUCCESS );
5311}
5312
Janos Follath81550542019-06-13 14:26:34 +01005313static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5314 psa_algorithm_t hash_alg,
5315 const uint8_t *data,
5316 size_t data_length )
5317{
5318 psa_status_t status;
5319 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5320 return( PSA_ERROR_BAD_STATE );
5321
5322 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5323 if( status != PSA_SUCCESS )
5324 return( status );
5325
5326 prf->state = TLS12_PRF_STATE_KEY_SET;
5327
5328 return( PSA_SUCCESS );
5329}
5330
Janos Follath6660f0e2019-06-17 08:44:03 +01005331static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5332 psa_tls12_prf_key_derivation_t *prf,
5333 psa_algorithm_t hash_alg,
5334 const uint8_t *data,
5335 size_t data_length )
5336{
5337 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005338 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5339 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005340
5341 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5342 return( PSA_ERROR_INVALID_ARGUMENT );
5343
5344 /* Quoting RFC 4279, Section 2:
5345 *
5346 * The premaster secret is formed as follows: if the PSK is N octets
5347 * long, concatenate a uint16 with the value N, N zero octets, a second
5348 * uint16 with the value N, and the PSK itself.
5349 */
5350
Janos Follath40e13932019-06-26 13:22:29 +01005351 *cur++ = ( data_length >> 8 ) & 0xff;
5352 *cur++ = ( data_length >> 0 ) & 0xff;
5353 memset( cur, 0, data_length );
5354 cur += data_length;
5355 *cur++ = pms[0];
5356 *cur++ = pms[1];
5357 memcpy( cur, data, data_length );
5358 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005359
Janos Follath40e13932019-06-26 13:22:29 +01005360 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005361
5362 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5363 return( status );
5364}
5365
Janos Follath63028dd2019-06-13 09:15:47 +01005366static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5367 const uint8_t *data,
5368 size_t data_length )
5369{
5370 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5371 return( PSA_ERROR_BAD_STATE );
5372
Janos Follathd6dce9f2019-07-04 09:11:38 +01005373 if( data_length != 0 )
5374 {
5375 prf->label = mbedtls_calloc( 1, data_length );
5376 if( prf->label == NULL )
5377 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005378
Janos Follathd6dce9f2019-07-04 09:11:38 +01005379 memcpy( prf->label, data, data_length );
5380 prf->label_length = data_length;
5381 }
Janos Follath63028dd2019-06-13 09:15:47 +01005382
5383 prf->state = TLS12_PRF_STATE_LABEL_SET;
5384
5385 return( PSA_SUCCESS );
5386}
5387
Janos Follathb03233e2019-06-11 15:30:30 +01005388static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5389 psa_algorithm_t hash_alg,
5390 psa_key_derivation_step_t step,
5391 const uint8_t *data,
5392 size_t data_length )
5393{
Janos Follathb03233e2019-06-11 15:30:30 +01005394 switch( step )
5395 {
Janos Follathf08e2652019-06-13 09:05:41 +01005396 case PSA_KEY_DERIVATION_INPUT_SEED:
5397 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005398 case PSA_KEY_DERIVATION_INPUT_SECRET:
5399 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005400 case PSA_KEY_DERIVATION_INPUT_LABEL:
5401 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005402 default:
5403 return( PSA_ERROR_INVALID_ARGUMENT );
5404 }
5405}
Janos Follath6660f0e2019-06-17 08:44:03 +01005406
5407static psa_status_t psa_tls12_prf_psk_to_ms_input(
5408 psa_tls12_prf_key_derivation_t *prf,
5409 psa_algorithm_t hash_alg,
5410 psa_key_derivation_step_t step,
5411 const uint8_t *data,
5412 size_t data_length )
5413{
5414 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005415 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005416 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5417 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005418 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005419
5420 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5421}
Janos Follathb03233e2019-06-11 15:30:30 +01005422#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005423#endif /* MBEDTLS_MD_C */
5424
Janos Follathb80a94e2019-06-12 15:54:46 +01005425static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005426 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005427 psa_key_derivation_step_t step,
5428 const uint8_t *data,
5429 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005430{
5431 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005432 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005433
5434#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005435 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005436 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005437 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005438 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005439 step, data, data_length );
5440 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005441 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005442#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005443#if defined(MBEDTLS_MD_C)
Janos Follath6660f0e2019-06-17 08:44:03 +01005444 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005445 {
Janos Follathb03233e2019-06-11 15:30:30 +01005446 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5447 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5448 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005449 }
5450 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5451 {
5452 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5453 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5454 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005455 }
5456 else
5457#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005458 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005459 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005460 return( PSA_ERROR_BAD_STATE );
5461 }
5462
5463 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005464 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005465 return( status );
5466}
5467
Janos Follath51f4a0f2019-06-14 11:35:55 +01005468psa_status_t psa_key_derivation_input_bytes(
5469 psa_key_derivation_operation_t *operation,
5470 psa_key_derivation_step_t step,
5471 const uint8_t *data,
5472 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005473{
Janos Follathc5621512019-06-14 11:27:57 +01005474 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5475 return( PSA_ERROR_INVALID_ARGUMENT );
5476
5477 return( psa_key_derivation_input_internal( operation, step,
5478 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005479}
5480
Janos Follath51f4a0f2019-06-14 11:35:55 +01005481psa_status_t psa_key_derivation_input_key(
5482 psa_key_derivation_operation_t *operation,
5483 psa_key_derivation_step_t step,
5484 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005485{
5486 psa_key_slot_t *slot;
5487 psa_status_t status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02005488 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005489 PSA_KEY_USAGE_DERIVE,
5490 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005491 if( status != PSA_SUCCESS )
5492 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02005493 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005494 return( PSA_ERROR_INVALID_ARGUMENT );
5495 /* Don't allow a key to be used as an input that is usually public.
5496 * This is debatable. It's ok from a cryptographic perspective to
5497 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005498 * the material should be dedicated to a particular input step,
5499 * otherwise this may allow the key to be used in an unintended way
5500 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005501 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005502 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005503 return( psa_key_derivation_input_internal( operation,
5504 step,
5505 slot->data.raw.data,
5506 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005507}
5508
Gilles Peskineea0fb492018-07-12 17:17:20 +02005509
5510
5511/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005512/* Key agreement */
5513/****************************************************************/
5514
Gilles Peskinea05219c2018-11-16 16:02:56 +01005515#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005516static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5517 size_t peer_key_length,
5518 const mbedtls_ecp_keypair *our_key,
5519 uint8_t *shared_secret,
5520 size_t shared_secret_size,
5521 size_t *shared_secret_length )
5522{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005523 mbedtls_ecp_keypair *their_key = NULL;
5524 mbedtls_ecdh_context ecdh;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005525 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005526 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005527
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005528 status = psa_import_ec_public_key(
5529 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5530 peer_key, peer_key_length,
5531 &their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005532 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005533 goto exit;
Gilles Peskineb4086612018-11-14 20:51:23 +01005534
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005535 status = mbedtls_to_psa_error(
5536 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5537 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005538 goto exit;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005539 status = mbedtls_to_psa_error(
5540 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5541 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005542 goto exit;
5543
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005544 status = mbedtls_to_psa_error(
5545 mbedtls_ecdh_calc_secret( &ecdh,
5546 shared_secret_length,
5547 shared_secret, shared_secret_size,
5548 mbedtls_ctr_drbg_random,
5549 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005550
5551exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005552 mbedtls_ecdh_free( &ecdh );
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005553 mbedtls_ecp_keypair_free( their_key );
5554 mbedtls_free( their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005555 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005556}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005557#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005558
Gilles Peskine01d718c2018-09-18 12:01:02 +02005559#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5560
Gilles Peskine0216fe12019-04-11 21:23:21 +02005561static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5562 psa_key_slot_t *private_key,
5563 const uint8_t *peer_key,
5564 size_t peer_key_length,
5565 uint8_t *shared_secret,
5566 size_t shared_secret_size,
5567 size_t *shared_secret_length )
5568{
5569 switch( alg )
5570 {
5571#if defined(MBEDTLS_ECDH_C)
5572 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005573 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005574 return( PSA_ERROR_INVALID_ARGUMENT );
5575 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5576 private_key->data.ecp,
5577 shared_secret, shared_secret_size,
5578 shared_secret_length ) );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005579#endif /* MBEDTLS_ECDH_C */
5580 default:
5581 (void) private_key;
5582 (void) peer_key;
5583 (void) peer_key_length;
5584 (void) shared_secret;
5585 (void) shared_secret_size;
5586 (void) shared_secret_length;
5587 return( PSA_ERROR_NOT_SUPPORTED );
5588 }
5589}
5590
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005591/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005592 * to potentially free embedded data structures and wipe confidential data.
5593 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005594static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005595 psa_key_derivation_step_t step,
Gilles Peskine2f060a82018-12-04 17:12:32 +01005596 psa_key_slot_t *private_key,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005597 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005598 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005599{
5600 psa_status_t status;
5601 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5602 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005603 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005604
5605 /* Step 1: run the secret agreement algorithm to generate the shared
5606 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005607 status = psa_key_agreement_raw_internal( ka_alg,
5608 private_key,
5609 peer_key, peer_key_length,
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005610 shared_secret,
5611 sizeof( shared_secret ),
5612 &shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005613 if( status != PSA_SUCCESS )
5614 goto exit;
5615
5616 /* Step 2: set up the key derivation to generate key material from
5617 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005618 status = psa_key_derivation_input_internal( operation, step,
5619 shared_secret,
5620 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005621
Gilles Peskine01d718c2018-09-18 12:01:02 +02005622exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005623 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005624 return( status );
5625}
5626
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005627psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005628 psa_key_derivation_step_t step,
5629 psa_key_handle_t private_key,
5630 const uint8_t *peer_key,
5631 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005632{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005633 psa_key_slot_t *slot;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005634 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005635 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005636 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005637 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005638 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005639 if( status != PSA_SUCCESS )
5640 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005641 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005642 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005643 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005644 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005645 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005646 return( status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005647}
5648
Gilles Peskinebe697d82019-05-16 18:00:41 +02005649psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5650 psa_key_handle_t private_key,
5651 const uint8_t *peer_key,
5652 size_t peer_key_length,
5653 uint8_t *output,
5654 size_t output_size,
5655 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005656{
5657 psa_key_slot_t *slot;
5658 psa_status_t status;
5659
5660 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5661 {
5662 status = PSA_ERROR_INVALID_ARGUMENT;
5663 goto exit;
5664 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005665 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005666 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005667 if( status != PSA_SUCCESS )
5668 goto exit;
5669
5670 status = psa_key_agreement_raw_internal( alg, slot,
5671 peer_key, peer_key_length,
5672 output, output_size,
5673 output_length );
5674
5675exit:
5676 if( status != PSA_SUCCESS )
5677 {
5678 /* If an error happens and is not handled properly, the output
5679 * may be used as a key to protect sensitive data. Arrange for such
5680 * a key to be random, which is likely to result in decryption or
5681 * verification errors. This is better than filling the buffer with
5682 * some constant data such as zeros, which would result in the data
5683 * being protected with a reproducible, easily knowable key.
5684 */
5685 psa_generate_random( output, output_size );
5686 *output_length = output_size;
5687 }
5688 return( status );
5689}
Gilles Peskine01d718c2018-09-18 12:01:02 +02005690
5691
5692/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005693/* Random generation */
Gilles Peskine05d69892018-06-19 22:00:52 +02005694/****************************************************************/
5695
5696psa_status_t psa_generate_random( uint8_t *output,
5697 size_t output_size )
5698{
itayzafrir0adf0fc2018-09-06 16:24:41 +03005699 int ret;
5700 GUARD_MODULE_INITIALIZED;
5701
Gilles Peskinef181eca2019-08-07 13:49:00 +02005702 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5703 {
5704 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5705 output,
5706 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5707 if( ret != 0 )
5708 return( mbedtls_to_psa_error( ret ) );
5709 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5710 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5711 }
5712
itayzafrir0adf0fc2018-09-06 16:24:41 +03005713 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
Gilles Peskine05d69892018-06-19 22:00:52 +02005714 return( mbedtls_to_psa_error( ret ) );
5715}
5716
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005717#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5718#include "mbedtls/entropy_poll.h"
avolinski13beb102018-11-20 16:51:49 +02005719
Gilles Peskine7228da22019-07-15 11:06:15 +02005720psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005721 size_t seed_size )
5722{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005723 if( global_data.initialized )
5724 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005725
5726 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5727 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5728 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5729 return( PSA_ERROR_INVALID_ARGUMENT );
5730
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005731 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005732}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005733#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005734
Gilles Peskinee56e8782019-04-26 17:34:02 +02005735#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5736static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5737 size_t domain_parameters_size,
5738 int *exponent )
5739{
5740 size_t i;
5741 uint32_t acc = 0;
5742
5743 if( domain_parameters_size == 0 )
5744 {
5745 *exponent = 65537;
5746 return( PSA_SUCCESS );
5747 }
5748
5749 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5750 * support values that fit in a 32-bit integer, which is larger than
5751 * int on just about every platform anyway. */
5752 if( domain_parameters_size > sizeof( acc ) )
5753 return( PSA_ERROR_NOT_SUPPORTED );
5754 for( i = 0; i < domain_parameters_size; i++ )
5755 acc = ( acc << 8 ) | domain_parameters[i];
5756 if( acc > INT_MAX )
5757 return( PSA_ERROR_NOT_SUPPORTED );
5758 *exponent = acc;
5759 return( PSA_SUCCESS );
5760}
5761#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5762
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005763static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005764 psa_key_slot_t *slot, size_t bits,
5765 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskine05d69892018-06-19 22:00:52 +02005766{
Gilles Peskine8e338702019-07-30 20:06:31 +02005767 psa_key_type_t type = slot->attr.type;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005768
Gilles Peskinee56e8782019-04-26 17:34:02 +02005769 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005770 return( PSA_ERROR_INVALID_ARGUMENT );
5771
Gilles Peskine48c0ea12018-06-21 14:15:31 +02005772 if( key_type_is_raw_bytes( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005773 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005774 psa_status_t status;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005775 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005776 if( status != PSA_SUCCESS )
5777 return( status );
5778 status = psa_generate_random( slot->data.raw.data,
5779 slot->data.raw.bytes );
5780 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005781 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005782#if defined(MBEDTLS_DES_C)
5783 if( type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005784 psa_des_set_key_parity( slot->data.raw.data,
5785 slot->data.raw.bytes );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005786#endif /* MBEDTLS_DES_C */
5787 }
5788 else
5789
5790#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005791 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005792 {
5793 mbedtls_rsa_context *rsa;
5794 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005795 int exponent;
5796 psa_status_t status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005797 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5798 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine86a440b2018-11-12 18:39:40 +01005799 /* Accept only byte-aligned keys, for the same reasons as
5800 * in psa_import_rsa_key(). */
5801 if( bits % 8 != 0 )
5802 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005803 status = psa_read_rsa_exponent( domain_parameters,
5804 domain_parameters_size,
5805 &exponent );
5806 if( status != PSA_SUCCESS )
5807 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005808 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5809 if( rsa == NULL )
5810 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5811 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5812 ret = mbedtls_rsa_gen_key( rsa,
5813 mbedtls_ctr_drbg_random,
5814 &global_data.ctr_drbg,
Jaeden Amero23bbb752018-06-26 14:16:54 +01005815 (unsigned int) bits,
Gilles Peskine12313cd2018-06-20 00:20:32 +02005816 exponent );
5817 if( ret != 0 )
5818 {
5819 mbedtls_rsa_free( rsa );
5820 mbedtls_free( rsa );
5821 return( mbedtls_to_psa_error( ret ) );
5822 }
5823 slot->data.rsa = rsa;
5824 }
5825 else
5826#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5827
5828#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005829 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005830 {
5831 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5832 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5833 const mbedtls_ecp_curve_info *curve_info =
5834 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5835 mbedtls_ecp_keypair *ecp;
5836 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005837 if( domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005838 return( PSA_ERROR_NOT_SUPPORTED );
5839 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5840 return( PSA_ERROR_NOT_SUPPORTED );
5841 if( curve_info->bit_size != bits )
5842 return( PSA_ERROR_INVALID_ARGUMENT );
5843 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5844 if( ecp == NULL )
5845 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5846 mbedtls_ecp_keypair_init( ecp );
5847 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5848 mbedtls_ctr_drbg_random,
5849 &global_data.ctr_drbg );
5850 if( ret != 0 )
5851 {
5852 mbedtls_ecp_keypair_free( ecp );
5853 mbedtls_free( ecp );
5854 return( mbedtls_to_psa_error( ret ) );
5855 }
5856 slot->data.ecp = ecp;
5857 }
5858 else
5859#endif /* MBEDTLS_ECP_C */
5860
5861 return( PSA_ERROR_NOT_SUPPORTED );
5862
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005863 return( PSA_SUCCESS );
5864}
5865
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005866psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005867 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005868{
5869 psa_status_t status;
5870 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005871 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinedf179142019-07-15 22:02:14 +02005872 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
5873 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005874#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5875 if( driver != NULL )
5876 {
5877 /* Generating a key in a secure element is not implemented yet. */
5878 status = PSA_ERROR_NOT_SUPPORTED;
5879 }
5880#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005881 if( status == PSA_SUCCESS )
5882 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005883 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005884 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005885 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005886 }
5887 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005888 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005889 if( status != PSA_SUCCESS )
5890 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005891 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005892 *handle = 0;
5893 }
5894 return( status );
5895}
5896
5897
Gilles Peskine05d69892018-06-19 22:00:52 +02005898
5899/****************************************************************/
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01005900/* Module setup */
5901/****************************************************************/
5902
Gilles Peskine5e769522018-11-20 21:59:56 +01005903psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5904 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5905 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5906{
5907 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5908 return( PSA_ERROR_BAD_STATE );
5909 global_data.entropy_init = entropy_init;
5910 global_data.entropy_free = entropy_free;
5911 return( PSA_SUCCESS );
5912}
5913
Gilles Peskinee59236f2018-01-27 23:32:46 +01005914void mbedtls_psa_crypto_free( void )
5915{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005916 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005917 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5918 {
5919 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005920 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005921 }
5922 /* Wipe all remaining data, including configuration.
5923 * In particular, this sets all state indicator to the value
5924 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005925 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005926#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005927 /* Unregister all secure element drivers, so that we restart from
5928 * a pristine state. */
5929 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005930#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005931}
5932
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005933#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5934/** Recover a transaction that was interrupted by a power failure.
5935 *
5936 * This function is called during initialization, before psa_crypto_init()
5937 * returns. If this function returns a failure status, the initialization
5938 * fails.
5939 */
5940static psa_status_t psa_crypto_recover_transaction(
5941 const psa_crypto_transaction_t *transaction )
5942{
5943 switch( transaction->unknown.type )
5944 {
5945 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5946 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
5947 /* TOnogrepDO - fall through to the failure case until this
5948 * is implemented */
5949 default:
5950 /* We found an unsupported transaction in the storage.
5951 * We don't know what state the storage is in. Give up. */
5952 return( PSA_ERROR_STORAGE_FAILURE );
5953 }
5954}
5955#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5956
Gilles Peskinee59236f2018-01-27 23:32:46 +01005957psa_status_t psa_crypto_init( void )
5958{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005959 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005960 const unsigned char drbg_seed[] = "PSA";
5961
Gilles Peskinec6b69072018-11-20 21:42:52 +01005962 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005963 if( global_data.initialized != 0 )
5964 return( PSA_SUCCESS );
5965
Gilles Peskine5e769522018-11-20 21:59:56 +01005966 /* Set default configuration if
5967 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5968 if( global_data.entropy_init == NULL )
5969 global_data.entropy_init = mbedtls_entropy_init;
5970 if( global_data.entropy_free == NULL )
5971 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005972
Gilles Peskinec6b69072018-11-20 21:42:52 +01005973 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005974 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01005975#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5976 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5977 /* The PSA entropy injection feature depends on using NV seed as an entropy
5978 * source. Add NV seed as an entropy source for PSA entropy injection. */
5979 mbedtls_entropy_add_source( &global_data.entropy,
5980 mbedtls_nv_seed_poll, NULL,
5981 MBEDTLS_ENTROPY_BLOCK_SIZE,
5982 MBEDTLS_ENTROPY_SOURCE_STRONG );
5983#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01005984 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005985 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005986 status = mbedtls_to_psa_error(
5987 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5988 mbedtls_entropy_func,
5989 &global_data.entropy,
5990 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5991 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005992 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005993 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005994
Gilles Peskine66fb1262018-12-10 16:29:04 +01005995 status = psa_initialize_key_slots( );
5996 if( status != PSA_SUCCESS )
5997 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005998
Gilles Peskine4b734222019-07-24 15:56:31 +02005999#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006000 status = psa_crypto_load_transaction( );
6001 if( status == PSA_SUCCESS )
6002 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006003 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6004 if( status != PSA_SUCCESS )
6005 goto exit;
6006 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006007 }
6008 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6009 {
6010 /* There's no transaction to complete. It's all good. */
6011 status = PSA_SUCCESS;
6012 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006013#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006014
Gilles Peskinec6b69072018-11-20 21:42:52 +01006015 /* All done. */
Gilles Peskinee4ebc122018-03-07 14:16:44 +01006016 global_data.initialized = 1;
6017
Gilles Peskinee59236f2018-01-27 23:32:46 +01006018exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006019 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006020 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006021 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006022}
6023
6024#endif /* MBEDTLS_PSA_CRYPTO_C */