blob: 086ba82d3f6b216336cf1c380faed0c8d8e68770 [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 Peskined7729582019-08-05 15:55:54 +02001573 /* For a key in a secure element, we need to do three things
1574 * when creating a key (but not when registering an existing key):
Gilles Peskine60450a42019-07-25 11:32:45 +02001575 * create the key file in internal storage, create the
1576 * key inside the secure element, and update the driver's
1577 * persistent data. Start a transaction that will encompass these
1578 * three actions. */
1579 /* The first thing to do is to find a slot number for the new key.
1580 * We save the slot number in persistent storage as part of the
1581 * transaction data. It will be needed to recover if the power
1582 * fails during the key creation process, to clean up on the secure
1583 * element side after restarting. Obtaining a slot number from the
1584 * secure element driver updates its persistent state, but we do not yet
1585 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001586 * we can roll back to a state where the key doesn't exist. */
Gilles Peskined7729582019-08-05 15:55:54 +02001587 if( *p_drv != NULL && method != PSA_KEY_CREATION_REGISTER )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001588 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001589 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001590 &slot->data.se.slot_number );
1591 if( status != PSA_SUCCESS )
1592 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001593 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001594 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001595 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001596 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001597 status = psa_crypto_save_transaction( );
1598 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001599 {
1600 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001601 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001602 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001603 }
1604#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1605
Gilles Peskine4747d192019-04-17 15:05:45 +02001606 return( status );
1607}
1608
1609/** Finalize the creation of a key once its key material has been set.
1610 *
1611 * This entails writing the key to persistent storage.
1612 *
1613 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001614 * See the documentation of psa_start_key_creation() for the intended use
1615 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001616 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001617 * \param[in,out] slot Pointer to the slot with key material.
1618 * \param[in] driver The secure element driver for the key,
1619 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001620 *
1621 * \retval #PSA_SUCCESS
1622 * The key was successfully created. The handle is now valid.
1623 * \return If this function fails, the key slot is an invalid state.
1624 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001625 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001626static psa_status_t psa_finish_key_creation(
1627 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001628 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001629{
1630 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001631 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001632 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001633
1634#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001635 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001636 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001637#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1638 if( driver != NULL )
1639 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001640 psa_se_key_data_storage_t data;
1641#if defined(static_assert)
1642 static_assert( sizeof( slot->data.se.slot_number ) ==
1643 sizeof( data.slot_number ),
1644 "Slot number size does not match psa_se_key_data_storage_t" );
1645 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1646 "Bit-size size does not match psa_se_key_data_storage_t" );
1647#endif
1648 memcpy( &data.slot_number, &slot->data.se.slot_number,
1649 sizeof( slot->data.se.slot_number ) );
1650 memcpy( &data.bits, &slot->attr.bits,
1651 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001652 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001653 (uint8_t*) &data,
1654 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001655 }
1656 else
1657#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1658 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001659 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001660 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001661 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001662 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1663 size_t length = 0;
Gilles Peskine1df83d42019-07-23 16:13:14 +02001664 if( buffer == NULL && buffer_size != 0 )
1665 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1666 status = psa_internal_export_key( slot,
1667 buffer, buffer_size, &length,
1668 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001669 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001670 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001671 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001672
Gilles Peskine1df83d42019-07-23 16:13:14 +02001673 if( buffer_size != 0 )
1674 mbedtls_platform_zeroize( buffer, buffer_size );
1675 mbedtls_free( buffer );
1676 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001677 }
1678#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1679
Gilles Peskinecbaff462019-07-12 23:46:04 +02001680#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001681 /* Finish the transaction for a key creation. This does not
1682 * happen when registering an existing key. Detect this case
1683 * by checking whether a transaction is in progress (actual
1684 * creation of a key in a secure element requires a transaction,
1685 * but registration doesn't use one). */
1686 if( driver != NULL &&
1687 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001688 {
1689 status = psa_save_se_persistent_data( driver );
1690 if( status != PSA_SUCCESS )
1691 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001692 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001693 return( status );
1694 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001695 status = psa_crypto_stop_transaction( );
1696 if( status != PSA_SUCCESS )
1697 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001698 }
1699#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1700
Gilles Peskine4747d192019-04-17 15:05:45 +02001701 return( status );
1702}
1703
1704/** Abort the creation of a key.
1705 *
1706 * You may call this function after calling psa_start_key_creation(),
1707 * or after psa_finish_key_creation() fails. In other circumstances, this
1708 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001709 * See the documentation of psa_start_key_creation() for the intended use
1710 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001711 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001712 * \param[in,out] slot Pointer to the slot with key material.
1713 * \param[in] driver The secure element driver for the key,
1714 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001715 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001716static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001717 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001718{
Gilles Peskine011e4282019-06-26 18:34:38 +02001719 (void) driver;
1720
Gilles Peskine4747d192019-04-17 15:05:45 +02001721 if( slot == NULL )
1722 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001723
1724#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1725 /* TOnogrepDO: If the key has already been created in the secure
1726 * element, and the failure happened later (when saving metadata
1727 * to internal storage), we need to destroy the key in the secure
1728 * element. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001729
Gilles Peskined7729582019-08-05 15:55:54 +02001730 /* Abort the ongoing transaction if any (there may not be one if
1731 * the creation process failed before starting one, or if the
1732 * key creation is a registration of a key in a secure element).
1733 * Earlier functions must already have done what it takes to undo any
1734 * partial creation. All that's left is to update the transaction data
1735 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001736 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001737#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1738
Gilles Peskine4747d192019-04-17 15:05:45 +02001739 psa_wipe_key_slot( slot );
1740}
1741
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001742/** Validate optional attributes during key creation.
1743 *
1744 * Some key attributes are optional during key creation. If they are
1745 * specified in the attributes structure, check that they are consistent
1746 * with the data in the slot.
1747 *
1748 * This function should be called near the end of key creation, after
1749 * the slot in memory is fully populated but before saving persistent data.
1750 */
1751static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001752 const psa_key_slot_t *slot,
1753 const psa_key_attributes_t *attributes )
1754{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001755 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001756 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001757 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001758 return( PSA_ERROR_INVALID_ARGUMENT );
1759 }
1760
1761 if( attributes->domain_parameters_size != 0 )
1762 {
1763#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001764 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001765 {
1766 mbedtls_mpi actual, required;
1767 int ret;
1768 mbedtls_mpi_init( &actual );
1769 mbedtls_mpi_init( &required );
1770 ret = mbedtls_rsa_export( slot->data.rsa,
1771 NULL, NULL, NULL, NULL, &actual );
1772 if( ret != 0 )
1773 goto rsa_exit;
1774 ret = mbedtls_mpi_read_binary( &required,
1775 attributes->domain_parameters,
1776 attributes->domain_parameters_size );
1777 if( ret != 0 )
1778 goto rsa_exit;
1779 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1780 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1781 rsa_exit:
1782 mbedtls_mpi_free( &actual );
1783 mbedtls_mpi_free( &required );
1784 if( ret != 0)
1785 return( mbedtls_to_psa_error( ret ) );
1786 }
1787 else
1788#endif
1789 {
1790 return( PSA_ERROR_INVALID_ARGUMENT );
1791 }
1792 }
1793
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001794 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001795 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001796 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001797 return( PSA_ERROR_INVALID_ARGUMENT );
1798 }
1799
1800 return( PSA_SUCCESS );
1801}
1802
Gilles Peskine4747d192019-04-17 15:05:45 +02001803psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001804 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001805 size_t data_length,
1806 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001807{
1808 psa_status_t status;
1809 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001810 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001811
Gilles Peskinedf179142019-07-15 22:02:14 +02001812 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
1813 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001814 if( status != PSA_SUCCESS )
1815 goto exit;
1816
Gilles Peskine5d309672019-07-12 23:47:28 +02001817#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1818 if( driver != NULL )
1819 {
1820 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001821 size_t bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001822 if( drv->key_management == NULL ||
1823 drv->key_management->p_import == NULL )
1824 {
1825 status = PSA_ERROR_NOT_SUPPORTED;
1826 goto exit;
1827 }
1828 status = drv->key_management->p_import(
1829 psa_get_se_driver_context( driver ),
1830 slot->data.se.slot_number,
Gilles Peskine8e338702019-07-30 20:06:31 +02001831 slot->attr.lifetime, slot->attr.type,
1832 slot->attr.policy.alg, slot->attr.policy.usage,
Gilles Peskine18017402019-07-24 20:25:59 +02001833 data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001834 &bits );
1835 if( status != PSA_SUCCESS )
1836 goto exit;
1837 if( bits > PSA_MAX_KEY_BITS )
1838 {
1839 status = PSA_ERROR_NOT_SUPPORTED;
1840 goto exit;
1841 }
1842 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001843 }
1844 else
1845#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1846 {
1847 status = psa_import_key_into_slot( slot, data, data_length );
1848 if( status != PSA_SUCCESS )
1849 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001850 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001851 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001852 if( status != PSA_SUCCESS )
1853 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001854
Gilles Peskine011e4282019-06-26 18:34:38 +02001855 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001856exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001857 if( status != PSA_SUCCESS )
1858 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001859 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001860 *handle = 0;
1861 }
1862 return( status );
1863}
1864
Gilles Peskined7729582019-08-05 15:55:54 +02001865#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1866psa_status_t mbedtls_psa_register_se_key(
1867 const psa_key_attributes_t *attributes )
1868{
1869 psa_status_t status;
1870 psa_key_slot_t *slot = NULL;
1871 psa_se_drv_table_entry_t *driver = NULL;
1872 const psa_drv_se_t *drv;
1873 psa_key_handle_t handle = 0;
1874
1875 /* Leaving attributes unspecified is not currently supported.
1876 * It could make sense to query the key type and size from the
1877 * secure element, but not all secure elements support this
1878 * and the driver HAL doesn't currently support it. */
1879 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1880 return( PSA_ERROR_NOT_SUPPORTED );
1881 if( psa_get_key_bits( attributes ) == 0 )
1882 return( PSA_ERROR_NOT_SUPPORTED );
1883
1884 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
1885 &handle, &slot, &driver );
1886 if( status != PSA_SUCCESS )
1887 goto exit;
1888
1889 if( driver == NULL )
1890 {
1891 status = PSA_ERROR_INVALID_ARGUMENT;
1892 goto exit;
1893 }
1894 drv = psa_get_se_driver_methods( driver );
1895
1896 if ( psa_get_key_slot_number( attributes,
1897 &slot->data.se.slot_number ) != PSA_SUCCESS )
1898 {
1899 /* The application didn't specify a slot number. This doesn't
1900 * make sense when registering a slot. */
1901 status = PSA_ERROR_INVALID_ARGUMENT;
1902 goto exit;
1903 }
1904
1905 status = psa_finish_key_creation( slot, driver );
1906
1907exit:
1908 if( status != PSA_SUCCESS )
1909 {
1910 psa_fail_key_creation( slot, driver );
1911 }
1912 /* Registration doesn't keep the key in RAM. */
1913 psa_close_key( handle );
1914 return( status );
1915}
1916#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1917
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001918static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001919 psa_key_slot_t *target )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001920{
1921 psa_status_t status;
1922 uint8_t *buffer = NULL;
1923 size_t buffer_size = 0;
1924 size_t length;
1925
Gilles Peskine8e338702019-07-30 20:06:31 +02001926 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001927 psa_get_key_slot_bits( source ) );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001928 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001929 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001930 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001931 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1932 if( status != PSA_SUCCESS )
1933 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001934 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001935 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001936
1937exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001938 if( buffer_size != 0 )
1939 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001940 mbedtls_free( buffer );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001941 return( status );
1942}
1943
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001944psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1945 const psa_key_attributes_t *specified_attributes,
1946 psa_key_handle_t *target_handle )
1947{
1948 psa_status_t status;
1949 psa_key_slot_t *source_slot = NULL;
1950 psa_key_slot_t *target_slot = NULL;
1951 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001952 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001953
Gilles Peskine28f8f302019-07-24 13:30:31 +02001954 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001955 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001956 if( status != PSA_SUCCESS )
1957 goto exit;
1958
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001959 status = psa_validate_optional_attributes( source_slot,
1960 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001961 if( status != PSA_SUCCESS )
1962 goto exit;
1963
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001964 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001965 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001966 if( status != PSA_SUCCESS )
1967 goto exit;
1968
Gilles Peskinedf179142019-07-15 22:02:14 +02001969 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
1970 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001971 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001972 if( status != PSA_SUCCESS )
1973 goto exit;
1974
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001975#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1976 if( driver != NULL )
1977 {
1978 /* Copying to a secure element is not implemented yet. */
1979 status = PSA_ERROR_NOT_SUPPORTED;
1980 goto exit;
1981 }
1982#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1983
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001984 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001985 if( status != PSA_SUCCESS )
1986 goto exit;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001987
Gilles Peskine011e4282019-06-26 18:34:38 +02001988 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001989exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001990 if( status != PSA_SUCCESS )
1991 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001992 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001993 *target_handle = 0;
1994 }
1995 return( status );
1996}
1997
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001998
1999
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002000/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002001/* Message digests */
2002/****************************************************************/
2003
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002004static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002005{
2006 switch( alg )
2007 {
2008#if defined(MBEDTLS_MD2_C)
2009 case PSA_ALG_MD2:
2010 return( &mbedtls_md2_info );
2011#endif
2012#if defined(MBEDTLS_MD4_C)
2013 case PSA_ALG_MD4:
2014 return( &mbedtls_md4_info );
2015#endif
2016#if defined(MBEDTLS_MD5_C)
2017 case PSA_ALG_MD5:
2018 return( &mbedtls_md5_info );
2019#endif
2020#if defined(MBEDTLS_RIPEMD160_C)
2021 case PSA_ALG_RIPEMD160:
2022 return( &mbedtls_ripemd160_info );
2023#endif
2024#if defined(MBEDTLS_SHA1_C)
2025 case PSA_ALG_SHA_1:
2026 return( &mbedtls_sha1_info );
2027#endif
2028#if defined(MBEDTLS_SHA256_C)
2029 case PSA_ALG_SHA_224:
2030 return( &mbedtls_sha224_info );
2031 case PSA_ALG_SHA_256:
2032 return( &mbedtls_sha256_info );
2033#endif
2034#if defined(MBEDTLS_SHA512_C)
2035 case PSA_ALG_SHA_384:
2036 return( &mbedtls_sha384_info );
2037 case PSA_ALG_SHA_512:
2038 return( &mbedtls_sha512_info );
2039#endif
2040 default:
2041 return( NULL );
2042 }
2043}
2044
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002045psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2046{
2047 switch( operation->alg )
2048 {
Gilles Peskine81736312018-06-26 15:04:31 +02002049 case 0:
2050 /* The object has (apparently) been initialized but it is not
2051 * in use. It's ok to call abort on such an object, and there's
2052 * nothing to do. */
2053 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002054#if defined(MBEDTLS_MD2_C)
2055 case PSA_ALG_MD2:
2056 mbedtls_md2_free( &operation->ctx.md2 );
2057 break;
2058#endif
2059#if defined(MBEDTLS_MD4_C)
2060 case PSA_ALG_MD4:
2061 mbedtls_md4_free( &operation->ctx.md4 );
2062 break;
2063#endif
2064#if defined(MBEDTLS_MD5_C)
2065 case PSA_ALG_MD5:
2066 mbedtls_md5_free( &operation->ctx.md5 );
2067 break;
2068#endif
2069#if defined(MBEDTLS_RIPEMD160_C)
2070 case PSA_ALG_RIPEMD160:
2071 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2072 break;
2073#endif
2074#if defined(MBEDTLS_SHA1_C)
2075 case PSA_ALG_SHA_1:
2076 mbedtls_sha1_free( &operation->ctx.sha1 );
2077 break;
2078#endif
2079#if defined(MBEDTLS_SHA256_C)
2080 case PSA_ALG_SHA_224:
2081 case PSA_ALG_SHA_256:
2082 mbedtls_sha256_free( &operation->ctx.sha256 );
2083 break;
2084#endif
2085#if defined(MBEDTLS_SHA512_C)
2086 case PSA_ALG_SHA_384:
2087 case PSA_ALG_SHA_512:
2088 mbedtls_sha512_free( &operation->ctx.sha512 );
2089 break;
2090#endif
2091 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002092 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002093 }
2094 operation->alg = 0;
2095 return( PSA_SUCCESS );
2096}
2097
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002098psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002099 psa_algorithm_t alg )
2100{
2101 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002102
2103 /* A context must be freshly initialized before it can be set up. */
2104 if( operation->alg != 0 )
2105 {
2106 return( PSA_ERROR_BAD_STATE );
2107 }
2108
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002109 switch( alg )
2110 {
2111#if defined(MBEDTLS_MD2_C)
2112 case PSA_ALG_MD2:
2113 mbedtls_md2_init( &operation->ctx.md2 );
2114 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2115 break;
2116#endif
2117#if defined(MBEDTLS_MD4_C)
2118 case PSA_ALG_MD4:
2119 mbedtls_md4_init( &operation->ctx.md4 );
2120 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2121 break;
2122#endif
2123#if defined(MBEDTLS_MD5_C)
2124 case PSA_ALG_MD5:
2125 mbedtls_md5_init( &operation->ctx.md5 );
2126 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2127 break;
2128#endif
2129#if defined(MBEDTLS_RIPEMD160_C)
2130 case PSA_ALG_RIPEMD160:
2131 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2132 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2133 break;
2134#endif
2135#if defined(MBEDTLS_SHA1_C)
2136 case PSA_ALG_SHA_1:
2137 mbedtls_sha1_init( &operation->ctx.sha1 );
2138 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2139 break;
2140#endif
2141#if defined(MBEDTLS_SHA256_C)
2142 case PSA_ALG_SHA_224:
2143 mbedtls_sha256_init( &operation->ctx.sha256 );
2144 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2145 break;
2146 case PSA_ALG_SHA_256:
2147 mbedtls_sha256_init( &operation->ctx.sha256 );
2148 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2149 break;
2150#endif
2151#if defined(MBEDTLS_SHA512_C)
2152 case PSA_ALG_SHA_384:
2153 mbedtls_sha512_init( &operation->ctx.sha512 );
2154 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2155 break;
2156 case PSA_ALG_SHA_512:
2157 mbedtls_sha512_init( &operation->ctx.sha512 );
2158 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2159 break;
2160#endif
2161 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002162 return( PSA_ALG_IS_HASH( alg ) ?
2163 PSA_ERROR_NOT_SUPPORTED :
2164 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002165 }
2166 if( ret == 0 )
2167 operation->alg = alg;
2168 else
2169 psa_hash_abort( operation );
2170 return( mbedtls_to_psa_error( ret ) );
2171}
2172
2173psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2174 const uint8_t *input,
2175 size_t input_length )
2176{
2177 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002178
2179 /* Don't require hash implementations to behave correctly on a
2180 * zero-length input, which may have an invalid pointer. */
2181 if( input_length == 0 )
2182 return( PSA_SUCCESS );
2183
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002184 switch( operation->alg )
2185 {
2186#if defined(MBEDTLS_MD2_C)
2187 case PSA_ALG_MD2:
2188 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2189 input, input_length );
2190 break;
2191#endif
2192#if defined(MBEDTLS_MD4_C)
2193 case PSA_ALG_MD4:
2194 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2195 input, input_length );
2196 break;
2197#endif
2198#if defined(MBEDTLS_MD5_C)
2199 case PSA_ALG_MD5:
2200 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2201 input, input_length );
2202 break;
2203#endif
2204#if defined(MBEDTLS_RIPEMD160_C)
2205 case PSA_ALG_RIPEMD160:
2206 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2207 input, input_length );
2208 break;
2209#endif
2210#if defined(MBEDTLS_SHA1_C)
2211 case PSA_ALG_SHA_1:
2212 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2213 input, input_length );
2214 break;
2215#endif
2216#if defined(MBEDTLS_SHA256_C)
2217 case PSA_ALG_SHA_224:
2218 case PSA_ALG_SHA_256:
2219 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2220 input, input_length );
2221 break;
2222#endif
2223#if defined(MBEDTLS_SHA512_C)
2224 case PSA_ALG_SHA_384:
2225 case PSA_ALG_SHA_512:
2226 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2227 input, input_length );
2228 break;
2229#endif
2230 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002231 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002232 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002233
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002234 if( ret != 0 )
2235 psa_hash_abort( operation );
2236 return( mbedtls_to_psa_error( ret ) );
2237}
2238
2239psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2240 uint8_t *hash,
2241 size_t hash_size,
2242 size_t *hash_length )
2243{
itayzafrir40835d42018-08-02 13:14:17 +03002244 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002245 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002246 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002247
2248 /* Fill the output buffer with something that isn't a valid hash
2249 * (barring an attack on the hash and deliberately-crafted input),
2250 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002251 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002252 /* If hash_size is 0 then hash may be NULL and then the
2253 * call to memset would have undefined behavior. */
2254 if( hash_size != 0 )
2255 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002256
2257 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002258 {
2259 status = PSA_ERROR_BUFFER_TOO_SMALL;
2260 goto exit;
2261 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002262
2263 switch( operation->alg )
2264 {
2265#if defined(MBEDTLS_MD2_C)
2266 case PSA_ALG_MD2:
2267 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2268 break;
2269#endif
2270#if defined(MBEDTLS_MD4_C)
2271 case PSA_ALG_MD4:
2272 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2273 break;
2274#endif
2275#if defined(MBEDTLS_MD5_C)
2276 case PSA_ALG_MD5:
2277 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2278 break;
2279#endif
2280#if defined(MBEDTLS_RIPEMD160_C)
2281 case PSA_ALG_RIPEMD160:
2282 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2283 break;
2284#endif
2285#if defined(MBEDTLS_SHA1_C)
2286 case PSA_ALG_SHA_1:
2287 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2288 break;
2289#endif
2290#if defined(MBEDTLS_SHA256_C)
2291 case PSA_ALG_SHA_224:
2292 case PSA_ALG_SHA_256:
2293 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2294 break;
2295#endif
2296#if defined(MBEDTLS_SHA512_C)
2297 case PSA_ALG_SHA_384:
2298 case PSA_ALG_SHA_512:
2299 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2300 break;
2301#endif
2302 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002303 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002304 }
itayzafrir40835d42018-08-02 13:14:17 +03002305 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002306
itayzafrir40835d42018-08-02 13:14:17 +03002307exit:
2308 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002309 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002310 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002311 return( psa_hash_abort( operation ) );
2312 }
2313 else
2314 {
2315 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002316 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002317 }
2318}
2319
Gilles Peskine2d277862018-06-18 15:41:12 +02002320psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2321 const uint8_t *hash,
2322 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002323{
2324 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2325 size_t actual_hash_length;
2326 psa_status_t status = psa_hash_finish( operation,
2327 actual_hash, sizeof( actual_hash ),
2328 &actual_hash_length );
2329 if( status != PSA_SUCCESS )
2330 return( status );
2331 if( actual_hash_length != hash_length )
2332 return( PSA_ERROR_INVALID_SIGNATURE );
2333 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2334 return( PSA_ERROR_INVALID_SIGNATURE );
2335 return( PSA_SUCCESS );
2336}
2337
Gilles Peskineeb35d782019-01-22 17:56:16 +01002338psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2339 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002340{
2341 if( target_operation->alg != 0 )
2342 return( PSA_ERROR_BAD_STATE );
2343
2344 switch( source_operation->alg )
2345 {
2346 case 0:
2347 return( PSA_ERROR_BAD_STATE );
2348#if defined(MBEDTLS_MD2_C)
2349 case PSA_ALG_MD2:
2350 mbedtls_md2_clone( &target_operation->ctx.md2,
2351 &source_operation->ctx.md2 );
2352 break;
2353#endif
2354#if defined(MBEDTLS_MD4_C)
2355 case PSA_ALG_MD4:
2356 mbedtls_md4_clone( &target_operation->ctx.md4,
2357 &source_operation->ctx.md4 );
2358 break;
2359#endif
2360#if defined(MBEDTLS_MD5_C)
2361 case PSA_ALG_MD5:
2362 mbedtls_md5_clone( &target_operation->ctx.md5,
2363 &source_operation->ctx.md5 );
2364 break;
2365#endif
2366#if defined(MBEDTLS_RIPEMD160_C)
2367 case PSA_ALG_RIPEMD160:
2368 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2369 &source_operation->ctx.ripemd160 );
2370 break;
2371#endif
2372#if defined(MBEDTLS_SHA1_C)
2373 case PSA_ALG_SHA_1:
2374 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2375 &source_operation->ctx.sha1 );
2376 break;
2377#endif
2378#if defined(MBEDTLS_SHA256_C)
2379 case PSA_ALG_SHA_224:
2380 case PSA_ALG_SHA_256:
2381 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2382 &source_operation->ctx.sha256 );
2383 break;
2384#endif
2385#if defined(MBEDTLS_SHA512_C)
2386 case PSA_ALG_SHA_384:
2387 case PSA_ALG_SHA_512:
2388 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2389 &source_operation->ctx.sha512 );
2390 break;
2391#endif
2392 default:
2393 return( PSA_ERROR_NOT_SUPPORTED );
2394 }
2395
2396 target_operation->alg = source_operation->alg;
2397 return( PSA_SUCCESS );
2398}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399
2400
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002401/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002402/* MAC */
2403/****************************************************************/
2404
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002405static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002406 psa_algorithm_t alg,
2407 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002408 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002409 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002411 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002412 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002413
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002414 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002415 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002416
Gilles Peskine8c9def32018-02-08 10:02:12 +01002417 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2418 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002419 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002420 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002421 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002422 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002423 mode = MBEDTLS_MODE_STREAM;
2424 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002425 case PSA_ALG_CTR:
2426 mode = MBEDTLS_MODE_CTR;
2427 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002428 case PSA_ALG_CFB:
2429 mode = MBEDTLS_MODE_CFB;
2430 break;
2431 case PSA_ALG_OFB:
2432 mode = MBEDTLS_MODE_OFB;
2433 break;
2434 case PSA_ALG_CBC_NO_PADDING:
2435 mode = MBEDTLS_MODE_CBC;
2436 break;
2437 case PSA_ALG_CBC_PKCS7:
2438 mode = MBEDTLS_MODE_CBC;
2439 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002440 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441 mode = MBEDTLS_MODE_CCM;
2442 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002443 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002444 mode = MBEDTLS_MODE_GCM;
2445 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002446 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2447 mode = MBEDTLS_MODE_CHACHAPOLY;
2448 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002449 default:
2450 return( NULL );
2451 }
2452 }
2453 else if( alg == PSA_ALG_CMAC )
2454 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002455 else
2456 return( NULL );
2457
2458 switch( key_type )
2459 {
2460 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002461 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002462 break;
2463 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002464 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2465 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002466 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002467 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002468 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002469 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002470 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2471 * but two-key Triple-DES is functionally three-key Triple-DES
2472 * with K1=K3, so that's how we present it to mbedtls. */
2473 if( key_bits == 128 )
2474 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002475 break;
2476 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002477 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478 break;
2479 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002480 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002481 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002482 case PSA_KEY_TYPE_CHACHA20:
2483 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2484 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485 default:
2486 return( NULL );
2487 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002488 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002489 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002490
Jaeden Amero23bbb752018-06-26 14:16:54 +01002491 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2492 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002493}
2494
Gilles Peskinea05219c2018-11-16 16:02:56 +01002495#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002496static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002497{
Gilles Peskine2d277862018-06-18 15:41:12 +02002498 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002499 {
2500 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002501 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002502 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002503 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002504 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002505 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002506 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002507 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002508 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002509 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002510 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002511 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002512 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002513 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002514 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002515 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002516 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002517 return( 128 );
2518 default:
2519 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002520 }
2521}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002522#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002523
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002524/* Initialize the MAC operation structure. Once this function has been
2525 * called, psa_mac_abort can run and will do the right thing. */
2526static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2527 psa_algorithm_t alg )
2528{
2529 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2530
2531 operation->alg = alg;
2532 operation->key_set = 0;
2533 operation->iv_set = 0;
2534 operation->iv_required = 0;
2535 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002536 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002537
2538#if defined(MBEDTLS_CMAC_C)
2539 if( alg == PSA_ALG_CMAC )
2540 {
2541 operation->iv_required = 0;
2542 mbedtls_cipher_init( &operation->ctx.cmac );
2543 status = PSA_SUCCESS;
2544 }
2545 else
2546#endif /* MBEDTLS_CMAC_C */
2547#if defined(MBEDTLS_MD_C)
2548 if( PSA_ALG_IS_HMAC( operation->alg ) )
2549 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002550 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2551 operation->ctx.hmac.hash_ctx.alg = 0;
2552 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002553 }
2554 else
2555#endif /* MBEDTLS_MD_C */
2556 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002557 if( ! PSA_ALG_IS_MAC( alg ) )
2558 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002559 }
2560
2561 if( status != PSA_SUCCESS )
2562 memset( operation, 0, sizeof( *operation ) );
2563 return( status );
2564}
2565
Gilles Peskine01126fa2018-07-12 17:04:55 +02002566#if defined(MBEDTLS_MD_C)
2567static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2568{
Gilles Peskine3f108122018-12-07 18:14:53 +01002569 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002570 return( psa_hash_abort( &hmac->hash_ctx ) );
2571}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002572
Janos Follath999f6482019-06-11 12:04:10 +01002573#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002574static void psa_hmac_init_internal( psa_hmac_internal_data *hmac )
2575{
2576 /* Instances of psa_hash_operation_s can be initialized by zeroization. */
2577 memset( hmac, 0, sizeof( *hmac ) );
2578}
Janos Follath999f6482019-06-11 12:04:10 +01002579#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002580#endif /* MBEDTLS_MD_C */
2581
Gilles Peskine8c9def32018-02-08 10:02:12 +01002582psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2583{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002584 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002585 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002586 /* The object has (apparently) been initialized but it is not
2587 * in use. It's ok to call abort on such an object, and there's
2588 * nothing to do. */
2589 return( PSA_SUCCESS );
2590 }
2591 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002592#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002593 if( operation->alg == PSA_ALG_CMAC )
2594 {
2595 mbedtls_cipher_free( &operation->ctx.cmac );
2596 }
2597 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002598#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002599#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002600 if( PSA_ALG_IS_HMAC( operation->alg ) )
2601 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002602 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002603 }
2604 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002606 {
2607 /* Sanity check (shouldn't happen: operation->alg should
2608 * always have been initialized to a valid value). */
2609 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002610 }
Moran Peker41deec42018-04-04 15:43:05 +03002611
Gilles Peskine8c9def32018-02-08 10:02:12 +01002612 operation->alg = 0;
2613 operation->key_set = 0;
2614 operation->iv_set = 0;
2615 operation->iv_required = 0;
2616 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002617 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002618
Gilles Peskine8c9def32018-02-08 10:02:12 +01002619 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002620
2621bad_state:
2622 /* If abort is called on an uninitialized object, we can't trust
2623 * anything. Wipe the object in case it contains confidential data.
2624 * This may result in a memory leak if a pointer gets overwritten,
2625 * but it's too late to do anything about this. */
2626 memset( operation, 0, sizeof( *operation ) );
2627 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628}
2629
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002630#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002631static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002632 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002633 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002634 const mbedtls_cipher_info_t *cipher_info )
2635{
2636 int ret;
2637
2638 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002639
2640 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2641 if( ret != 0 )
2642 return( ret );
2643
2644 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2645 slot->data.raw.data,
2646 key_bits );
2647 return( ret );
2648}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002649#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002650
Gilles Peskine248051a2018-06-20 16:09:38 +02002651#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002652static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2653 const uint8_t *key,
2654 size_t key_length,
2655 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002656{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002657 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002658 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002659 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002660 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002661 psa_status_t status;
2662
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002663 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2664 * overflow below. This should never trigger if the hash algorithm
2665 * is implemented correctly. */
2666 /* The size checks against the ipad and opad buffers cannot be written
2667 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2668 * because that triggers -Wlogical-op on GCC 7.3. */
2669 if( block_size > sizeof( ipad ) )
2670 return( PSA_ERROR_NOT_SUPPORTED );
2671 if( block_size > sizeof( hmac->opad ) )
2672 return( PSA_ERROR_NOT_SUPPORTED );
2673 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002674 return( PSA_ERROR_NOT_SUPPORTED );
2675
Gilles Peskined223b522018-06-11 18:12:58 +02002676 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002677 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002678 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002679 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002680 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002681 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002682 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002683 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002684 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002685 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002686 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002687 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002688 }
Gilles Peskine96889972018-07-12 17:07:03 +02002689 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2690 * but it is permitted. It is common when HMAC is used in HKDF, for
2691 * example. Don't call `memcpy` in the 0-length because `key` could be
2692 * an invalid pointer which would make the behavior undefined. */
2693 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002694 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002695
Gilles Peskined223b522018-06-11 18:12:58 +02002696 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2697 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002698 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002699 ipad[i] ^= 0x36;
2700 memset( ipad + key_length, 0x36, block_size - key_length );
2701
2702 /* Copy the key material from ipad to opad, flipping the requisite bits,
2703 * and filling the rest of opad with the requisite constant. */
2704 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002705 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2706 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002707
Gilles Peskine01126fa2018-07-12 17:04:55 +02002708 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002709 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002710 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002711
Gilles Peskine01126fa2018-07-12 17:04:55 +02002712 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002713
2714cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002715 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002716
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002717 return( status );
2718}
Gilles Peskine248051a2018-06-20 16:09:38 +02002719#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002720
Gilles Peskine89167cb2018-07-08 20:12:23 +02002721static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002722 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002723 psa_algorithm_t alg,
2724 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002725{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002726 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002727 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002729 psa_key_usage_t usage =
2730 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002731 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002732 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002734 /* A context must be freshly initialized before it can be set up. */
2735 if( operation->alg != 0 )
2736 {
2737 return( PSA_ERROR_BAD_STATE );
2738 }
2739
Gilles Peskined911eb72018-08-14 15:18:45 +02002740 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002741 if( status != PSA_SUCCESS )
2742 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002743 if( is_sign )
2744 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002745
Gilles Peskine28f8f302019-07-24 13:30:31 +02002746 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002747 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002748 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002749 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002750
Gilles Peskine8c9def32018-02-08 10:02:12 +01002751#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002752 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002753 {
2754 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002755 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002756 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002757 int ret;
2758 if( cipher_info == NULL )
2759 {
2760 status = PSA_ERROR_NOT_SUPPORTED;
2761 goto exit;
2762 }
2763 operation->mac_size = cipher_info->block_size;
2764 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2765 status = mbedtls_to_psa_error( ret );
2766 }
2767 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002768#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002769#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002770 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002771 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002772 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002773 if( hash_alg == 0 )
2774 {
2775 status = PSA_ERROR_NOT_SUPPORTED;
2776 goto exit;
2777 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002778
2779 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2780 /* Sanity check. This shouldn't fail on a valid configuration. */
2781 if( operation->mac_size == 0 ||
2782 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2783 {
2784 status = PSA_ERROR_NOT_SUPPORTED;
2785 goto exit;
2786 }
2787
Gilles Peskine8e338702019-07-30 20:06:31 +02002788 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002789 {
2790 status = PSA_ERROR_INVALID_ARGUMENT;
2791 goto exit;
2792 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002793
Gilles Peskine01126fa2018-07-12 17:04:55 +02002794 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2795 slot->data.raw.data,
2796 slot->data.raw.bytes,
2797 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002798 }
2799 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002800#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002801 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002802 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002803 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002804 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002805
Gilles Peskined911eb72018-08-14 15:18:45 +02002806 if( truncated == 0 )
2807 {
2808 /* The "normal" case: untruncated algorithm. Nothing to do. */
2809 }
2810 else if( truncated < 4 )
2811 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002812 /* A very short MAC is too short for security since it can be
2813 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2814 * so we make this our minimum, even though 32 bits is still
2815 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002816 status = PSA_ERROR_NOT_SUPPORTED;
2817 }
2818 else if( truncated > operation->mac_size )
2819 {
2820 /* It's impossible to "truncate" to a larger length. */
2821 status = PSA_ERROR_INVALID_ARGUMENT;
2822 }
2823 else
2824 operation->mac_size = truncated;
2825
Gilles Peskinefbfac682018-07-08 20:51:54 +02002826exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002827 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002828 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002829 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002830 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002831 else
2832 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002833 operation->key_set = 1;
2834 }
2835 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002836}
2837
Gilles Peskine89167cb2018-07-08 20:12:23 +02002838psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002839 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002840 psa_algorithm_t alg )
2841{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002842 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002843}
2844
2845psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002846 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002847 psa_algorithm_t alg )
2848{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002849 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002850}
2851
Gilles Peskine8c9def32018-02-08 10:02:12 +01002852psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2853 const uint8_t *input,
2854 size_t input_length )
2855{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002856 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002857 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002858 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002859 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002860 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002861 operation->has_input = 1;
2862
Gilles Peskine8c9def32018-02-08 10:02:12 +01002863#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002864 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002865 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002866 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2867 input, input_length );
2868 status = mbedtls_to_psa_error( ret );
2869 }
2870 else
2871#endif /* MBEDTLS_CMAC_C */
2872#if defined(MBEDTLS_MD_C)
2873 if( PSA_ALG_IS_HMAC( operation->alg ) )
2874 {
2875 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2876 input_length );
2877 }
2878 else
2879#endif /* MBEDTLS_MD_C */
2880 {
2881 /* This shouldn't happen if `operation` was initialized by
2882 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002883 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002884 }
2885
Gilles Peskinefbfac682018-07-08 20:51:54 +02002886 if( status != PSA_SUCCESS )
2887 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002888 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002889}
2890
Gilles Peskine01126fa2018-07-12 17:04:55 +02002891#if defined(MBEDTLS_MD_C)
2892static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2893 uint8_t *mac,
2894 size_t mac_size )
2895{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002896 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002897 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2898 size_t hash_size = 0;
2899 size_t block_size = psa_get_hash_block_size( hash_alg );
2900 psa_status_t status;
2901
Gilles Peskine01126fa2018-07-12 17:04:55 +02002902 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2903 if( status != PSA_SUCCESS )
2904 return( status );
2905 /* From here on, tmp needs to be wiped. */
2906
2907 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2908 if( status != PSA_SUCCESS )
2909 goto exit;
2910
2911 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2912 if( status != PSA_SUCCESS )
2913 goto exit;
2914
2915 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2916 if( status != PSA_SUCCESS )
2917 goto exit;
2918
Gilles Peskined911eb72018-08-14 15:18:45 +02002919 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2920 if( status != PSA_SUCCESS )
2921 goto exit;
2922
2923 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002924
2925exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002926 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002927 return( status );
2928}
2929#endif /* MBEDTLS_MD_C */
2930
mohammad16036df908f2018-04-02 08:34:15 -07002931static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002932 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002933 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002934{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002935 if( ! operation->key_set )
2936 return( PSA_ERROR_BAD_STATE );
2937 if( operation->iv_required && ! operation->iv_set )
2938 return( PSA_ERROR_BAD_STATE );
2939
Gilles Peskine8c9def32018-02-08 10:02:12 +01002940 if( mac_size < operation->mac_size )
2941 return( PSA_ERROR_BUFFER_TOO_SMALL );
2942
Gilles Peskine8c9def32018-02-08 10:02:12 +01002943#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002944 if( operation->alg == PSA_ALG_CMAC )
2945 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002946 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2947 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2948 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002949 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002950 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002951 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002952 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002953 else
2954#endif /* MBEDTLS_CMAC_C */
2955#if defined(MBEDTLS_MD_C)
2956 if( PSA_ALG_IS_HMAC( operation->alg ) )
2957 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002958 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002959 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002960 }
2961 else
2962#endif /* MBEDTLS_MD_C */
2963 {
2964 /* This shouldn't happen if `operation` was initialized by
2965 * a setup function. */
2966 return( PSA_ERROR_BAD_STATE );
2967 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002968}
2969
Gilles Peskineacd4be32018-07-08 19:56:25 +02002970psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2971 uint8_t *mac,
2972 size_t mac_size,
2973 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002974{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002975 psa_status_t status;
2976
Jaeden Amero252ef282019-02-15 14:05:35 +00002977 if( operation->alg == 0 )
2978 {
2979 return( PSA_ERROR_BAD_STATE );
2980 }
2981
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002982 /* Fill the output buffer with something that isn't a valid mac
2983 * (barring an attack on the mac and deliberately-crafted input),
2984 * in case the caller doesn't check the return status properly. */
2985 *mac_length = mac_size;
2986 /* If mac_size is 0 then mac may be NULL and then the
2987 * call to memset would have undefined behavior. */
2988 if( mac_size != 0 )
2989 memset( mac, '!', mac_size );
2990
Gilles Peskine89167cb2018-07-08 20:12:23 +02002991 if( ! operation->is_sign )
2992 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002993 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002994 }
mohammad16036df908f2018-04-02 08:34:15 -07002995
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002996 status = psa_mac_finish_internal( operation, mac, mac_size );
2997
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002998 if( status == PSA_SUCCESS )
2999 {
3000 status = psa_mac_abort( operation );
3001 if( status == PSA_SUCCESS )
3002 *mac_length = operation->mac_size;
3003 else
3004 memset( mac, '!', mac_size );
3005 }
3006 else
3007 psa_mac_abort( operation );
3008 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003009}
3010
Gilles Peskineacd4be32018-07-08 19:56:25 +02003011psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3012 const uint8_t *mac,
3013 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003014{
Gilles Peskine828ed142018-06-18 23:25:51 +02003015 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003016 psa_status_t status;
3017
Jaeden Amero252ef282019-02-15 14:05:35 +00003018 if( operation->alg == 0 )
3019 {
3020 return( PSA_ERROR_BAD_STATE );
3021 }
3022
Gilles Peskine89167cb2018-07-08 20:12:23 +02003023 if( operation->is_sign )
3024 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003025 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003026 }
3027 if( operation->mac_size != mac_length )
3028 {
3029 status = PSA_ERROR_INVALID_SIGNATURE;
3030 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003031 }
mohammad16036df908f2018-04-02 08:34:15 -07003032
3033 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003034 actual_mac, sizeof( actual_mac ) );
3035
3036 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3037 status = PSA_ERROR_INVALID_SIGNATURE;
3038
3039cleanup:
3040 if( status == PSA_SUCCESS )
3041 status = psa_mac_abort( operation );
3042 else
3043 psa_mac_abort( operation );
3044
Gilles Peskine3f108122018-12-07 18:14:53 +01003045 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003046
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003047 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003048}
3049
3050
Gilles Peskine20035e32018-02-03 22:44:14 +01003051
Gilles Peskine20035e32018-02-03 22:44:14 +01003052/****************************************************************/
3053/* Asymmetric cryptography */
3054/****************************************************************/
3055
Gilles Peskine2b450e32018-06-27 15:42:46 +02003056#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003057/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003058 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003059static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3060 size_t hash_length,
3061 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003062{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003063 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003064 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003065 *md_alg = mbedtls_md_get_type( md_info );
3066
3067 /* The Mbed TLS RSA module uses an unsigned int for hash length
3068 * parameters. Validate that it fits so that we don't risk an
3069 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003070#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003071 if( hash_length > UINT_MAX )
3072 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003073#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003074
3075#if defined(MBEDTLS_PKCS1_V15)
3076 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3077 * must be correct. */
3078 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3079 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003080 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003081 if( md_info == NULL )
3082 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003083 if( mbedtls_md_get_size( md_info ) != hash_length )
3084 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003085 }
3086#endif /* MBEDTLS_PKCS1_V15 */
3087
3088#if defined(MBEDTLS_PKCS1_V21)
3089 /* PSS requires a hash internally. */
3090 if( PSA_ALG_IS_RSA_PSS( alg ) )
3091 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003092 if( md_info == NULL )
3093 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003094 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003095#endif /* MBEDTLS_PKCS1_V21 */
3096
Gilles Peskine61b91d42018-06-08 16:09:36 +02003097 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003098}
3099
Gilles Peskine2b450e32018-06-27 15:42:46 +02003100static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3101 psa_algorithm_t alg,
3102 const uint8_t *hash,
3103 size_t hash_length,
3104 uint8_t *signature,
3105 size_t signature_size,
3106 size_t *signature_length )
3107{
3108 psa_status_t status;
3109 int ret;
3110 mbedtls_md_type_t md_alg;
3111
3112 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3113 if( status != PSA_SUCCESS )
3114 return( status );
3115
Gilles Peskine630a18a2018-06-29 17:49:35 +02003116 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003117 return( PSA_ERROR_BUFFER_TOO_SMALL );
3118
3119#if defined(MBEDTLS_PKCS1_V15)
3120 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3121 {
3122 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3123 MBEDTLS_MD_NONE );
3124 ret = mbedtls_rsa_pkcs1_sign( rsa,
3125 mbedtls_ctr_drbg_random,
3126 &global_data.ctr_drbg,
3127 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003128 md_alg,
3129 (unsigned int) hash_length,
3130 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003131 signature );
3132 }
3133 else
3134#endif /* MBEDTLS_PKCS1_V15 */
3135#if defined(MBEDTLS_PKCS1_V21)
3136 if( PSA_ALG_IS_RSA_PSS( alg ) )
3137 {
3138 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3139 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3140 mbedtls_ctr_drbg_random,
3141 &global_data.ctr_drbg,
3142 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003143 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003144 (unsigned int) hash_length,
3145 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003146 signature );
3147 }
3148 else
3149#endif /* MBEDTLS_PKCS1_V21 */
3150 {
3151 return( PSA_ERROR_INVALID_ARGUMENT );
3152 }
3153
3154 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003155 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003156 return( mbedtls_to_psa_error( ret ) );
3157}
3158
3159static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3160 psa_algorithm_t alg,
3161 const uint8_t *hash,
3162 size_t hash_length,
3163 const uint8_t *signature,
3164 size_t signature_length )
3165{
3166 psa_status_t status;
3167 int ret;
3168 mbedtls_md_type_t md_alg;
3169
3170 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3171 if( status != PSA_SUCCESS )
3172 return( status );
3173
Gilles Peskine630a18a2018-06-29 17:49:35 +02003174 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003175 return( PSA_ERROR_BUFFER_TOO_SMALL );
3176
3177#if defined(MBEDTLS_PKCS1_V15)
3178 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3179 {
3180 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3181 MBEDTLS_MD_NONE );
3182 ret = mbedtls_rsa_pkcs1_verify( rsa,
3183 mbedtls_ctr_drbg_random,
3184 &global_data.ctr_drbg,
3185 MBEDTLS_RSA_PUBLIC,
3186 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003187 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003188 hash,
3189 signature );
3190 }
3191 else
3192#endif /* MBEDTLS_PKCS1_V15 */
3193#if defined(MBEDTLS_PKCS1_V21)
3194 if( PSA_ALG_IS_RSA_PSS( alg ) )
3195 {
3196 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3197 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3198 mbedtls_ctr_drbg_random,
3199 &global_data.ctr_drbg,
3200 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003201 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003202 (unsigned int) hash_length,
3203 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003204 signature );
3205 }
3206 else
3207#endif /* MBEDTLS_PKCS1_V21 */
3208 {
3209 return( PSA_ERROR_INVALID_ARGUMENT );
3210 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003211
3212 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3213 * the rest of the signature is invalid". This has little use in
3214 * practice and PSA doesn't report this distinction. */
3215 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3216 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003217 return( mbedtls_to_psa_error( ret ) );
3218}
3219#endif /* MBEDTLS_RSA_C */
3220
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003221#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003222/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3223 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3224 * (even though these functions don't modify it). */
3225static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3226 psa_algorithm_t alg,
3227 const uint8_t *hash,
3228 size_t hash_length,
3229 uint8_t *signature,
3230 size_t signature_size,
3231 size_t *signature_length )
3232{
3233 int ret;
3234 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003235 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003236 mbedtls_mpi_init( &r );
3237 mbedtls_mpi_init( &s );
3238
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003239 if( signature_size < 2 * curve_bytes )
3240 {
3241 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3242 goto cleanup;
3243 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003244
Gilles Peskinea05219c2018-11-16 16:02:56 +01003245#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003246 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3247 {
3248 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3249 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3250 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3251 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det( &ecp->grp, &r, &s, &ecp->d,
3252 hash, hash_length,
3253 md_alg ) );
3254 }
3255 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003256#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003257 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003258 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003259 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3260 hash, hash_length,
3261 mbedtls_ctr_drbg_random,
3262 &global_data.ctr_drbg ) );
3263 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003264
3265 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3266 signature,
3267 curve_bytes ) );
3268 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3269 signature + curve_bytes,
3270 curve_bytes ) );
3271
3272cleanup:
3273 mbedtls_mpi_free( &r );
3274 mbedtls_mpi_free( &s );
3275 if( ret == 0 )
3276 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003277 return( mbedtls_to_psa_error( ret ) );
3278}
3279
3280static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3281 const uint8_t *hash,
3282 size_t hash_length,
3283 const uint8_t *signature,
3284 size_t signature_length )
3285{
3286 int ret;
3287 mbedtls_mpi r, s;
3288 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3289 mbedtls_mpi_init( &r );
3290 mbedtls_mpi_init( &s );
3291
3292 if( signature_length != 2 * curve_bytes )
3293 return( PSA_ERROR_INVALID_SIGNATURE );
3294
3295 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3296 signature,
3297 curve_bytes ) );
3298 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3299 signature + curve_bytes,
3300 curve_bytes ) );
3301
3302 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3303 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003304
3305cleanup:
3306 mbedtls_mpi_free( &r );
3307 mbedtls_mpi_free( &s );
3308 return( mbedtls_to_psa_error( ret ) );
3309}
3310#endif /* MBEDTLS_ECDSA_C */
3311
Gilles Peskinec5487a82018-12-03 18:08:14 +01003312psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003313 psa_algorithm_t alg,
3314 const uint8_t *hash,
3315 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003316 uint8_t *signature,
3317 size_t signature_size,
3318 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003319{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003320 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003321 psa_status_t status;
3322
3323 *signature_length = signature_size;
3324
Gilles Peskine28f8f302019-07-24 13:30:31 +02003325 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003326 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003327 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003328 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003329 {
3330 status = PSA_ERROR_INVALID_ARGUMENT;
3331 goto exit;
3332 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003333
Gilles Peskine20035e32018-02-03 22:44:14 +01003334#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003335 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003336 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003337 status = psa_rsa_sign( slot->data.rsa,
3338 alg,
3339 hash, hash_length,
3340 signature, signature_size,
3341 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003342 }
3343 else
3344#endif /* defined(MBEDTLS_RSA_C) */
3345#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003346 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003347 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003348#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003349 if(
3350#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3351 PSA_ALG_IS_ECDSA( alg )
3352#else
3353 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3354#endif
3355 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003356 status = psa_ecdsa_sign( slot->data.ecp,
3357 alg,
3358 hash, hash_length,
3359 signature, signature_size,
3360 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003361 else
3362#endif /* defined(MBEDTLS_ECDSA_C) */
3363 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003364 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003365 }
itayzafrir5c753392018-05-08 11:18:38 +03003366 }
3367 else
3368#endif /* defined(MBEDTLS_ECP_C) */
3369 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003370 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003371 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003372
3373exit:
3374 /* Fill the unused part of the output buffer (the whole buffer on error,
3375 * the trailing part on success) with something that isn't a valid mac
3376 * (barring an attack on the mac and deliberately-crafted input),
3377 * in case the caller doesn't check the return status properly. */
3378 if( status == PSA_SUCCESS )
3379 memset( signature + *signature_length, '!',
3380 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003381 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003382 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003383 /* If signature_size is 0 then we have nothing to do. We must not call
3384 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003385 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003386}
3387
Gilles Peskinec5487a82018-12-03 18:08:14 +01003388psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03003389 psa_algorithm_t alg,
3390 const uint8_t *hash,
3391 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02003392 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02003393 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003394{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003395 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003396 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003397
Gilles Peskine28f8f302019-07-24 13:30:31 +02003398 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003399 if( status != PSA_SUCCESS )
3400 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003401
Gilles Peskine61b91d42018-06-08 16:09:36 +02003402#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003403 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003404 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003405 return( psa_rsa_verify( slot->data.rsa,
3406 alg,
3407 hash, hash_length,
3408 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003409 }
3410 else
3411#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003412#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003413 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003414 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003415#if defined(MBEDTLS_ECDSA_C)
3416 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003417 return( psa_ecdsa_verify( slot->data.ecp,
3418 hash, hash_length,
3419 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003420 else
3421#endif /* defined(MBEDTLS_ECDSA_C) */
3422 {
3423 return( PSA_ERROR_INVALID_ARGUMENT );
3424 }
itayzafrir5c753392018-05-08 11:18:38 +03003425 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003426 else
3427#endif /* defined(MBEDTLS_ECP_C) */
3428 {
3429 return( PSA_ERROR_NOT_SUPPORTED );
3430 }
3431}
3432
Gilles Peskine072ac562018-06-30 00:21:29 +02003433#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3434static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3435 mbedtls_rsa_context *rsa )
3436{
3437 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3438 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3439 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3440 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3441}
3442#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3443
Gilles Peskinec5487a82018-12-03 18:08:14 +01003444psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003445 psa_algorithm_t alg,
3446 const uint8_t *input,
3447 size_t input_length,
3448 const uint8_t *salt,
3449 size_t salt_length,
3450 uint8_t *output,
3451 size_t output_size,
3452 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003453{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003454 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003455 psa_status_t status;
3456
Darryl Green5cc689a2018-07-24 15:34:10 +01003457 (void) input;
3458 (void) input_length;
3459 (void) salt;
3460 (void) output;
3461 (void) output_size;
3462
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003463 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003464
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003465 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3466 return( PSA_ERROR_INVALID_ARGUMENT );
3467
Gilles Peskine28f8f302019-07-24 13:30:31 +02003468 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003469 if( status != PSA_SUCCESS )
3470 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003471 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3472 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003473 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003474
3475#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003476 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003477 {
3478 mbedtls_rsa_context *rsa = slot->data.rsa;
3479 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003480 if( output_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine61b91d42018-06-08 16:09:36 +02003481 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003482#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003483 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003484 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003485 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3486 mbedtls_ctr_drbg_random,
3487 &global_data.ctr_drbg,
3488 MBEDTLS_RSA_PUBLIC,
3489 input_length,
3490 input,
3491 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003492 }
3493 else
3494#endif /* MBEDTLS_PKCS1_V15 */
3495#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003496 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003497 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003498 psa_rsa_oaep_set_padding_mode( alg, rsa );
3499 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3500 mbedtls_ctr_drbg_random,
3501 &global_data.ctr_drbg,
3502 MBEDTLS_RSA_PUBLIC,
3503 salt, salt_length,
3504 input_length,
3505 input,
3506 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003507 }
3508 else
3509#endif /* MBEDTLS_PKCS1_V21 */
3510 {
3511 return( PSA_ERROR_INVALID_ARGUMENT );
3512 }
3513 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003514 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003515 return( mbedtls_to_psa_error( ret ) );
3516 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003517 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003518#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003519 {
3520 return( PSA_ERROR_NOT_SUPPORTED );
3521 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003522}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003523
Gilles Peskinec5487a82018-12-03 18:08:14 +01003524psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003525 psa_algorithm_t alg,
3526 const uint8_t *input,
3527 size_t input_length,
3528 const uint8_t *salt,
3529 size_t salt_length,
3530 uint8_t *output,
3531 size_t output_size,
3532 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003533{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003534 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003535 psa_status_t status;
3536
Darryl Green5cc689a2018-07-24 15:34:10 +01003537 (void) input;
3538 (void) input_length;
3539 (void) salt;
3540 (void) output;
3541 (void) output_size;
3542
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003543 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003544
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003545 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3546 return( PSA_ERROR_INVALID_ARGUMENT );
3547
Gilles Peskine28f8f302019-07-24 13:30:31 +02003548 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003549 if( status != PSA_SUCCESS )
3550 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003551 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003552 return( PSA_ERROR_INVALID_ARGUMENT );
3553
3554#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003555 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003556 {
3557 mbedtls_rsa_context *rsa = slot->data.rsa;
3558 int ret;
3559
Gilles Peskine630a18a2018-06-29 17:49:35 +02003560 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003561 return( PSA_ERROR_INVALID_ARGUMENT );
3562
3563#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003564 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003565 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003566 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3567 mbedtls_ctr_drbg_random,
3568 &global_data.ctr_drbg,
3569 MBEDTLS_RSA_PRIVATE,
3570 output_length,
3571 input,
3572 output,
3573 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003574 }
3575 else
3576#endif /* MBEDTLS_PKCS1_V15 */
3577#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003578 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003579 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003580 psa_rsa_oaep_set_padding_mode( alg, rsa );
3581 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3582 mbedtls_ctr_drbg_random,
3583 &global_data.ctr_drbg,
3584 MBEDTLS_RSA_PRIVATE,
3585 salt, salt_length,
3586 output_length,
3587 input,
3588 output,
3589 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003590 }
3591 else
3592#endif /* MBEDTLS_PKCS1_V21 */
3593 {
3594 return( PSA_ERROR_INVALID_ARGUMENT );
3595 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003596
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003597 return( mbedtls_to_psa_error( ret ) );
3598 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003599 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003600#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003601 {
3602 return( PSA_ERROR_NOT_SUPPORTED );
3603 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003604}
Gilles Peskine20035e32018-02-03 22:44:14 +01003605
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003606
3607
mohammad1603503973b2018-03-12 15:59:30 +02003608/****************************************************************/
3609/* Symmetric cryptography */
3610/****************************************************************/
3611
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003612/* Initialize the cipher operation structure. Once this function has been
3613 * called, psa_cipher_abort can run and will do the right thing. */
3614static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3615 psa_algorithm_t alg )
3616{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003617 if( ! PSA_ALG_IS_CIPHER( alg ) )
3618 {
3619 memset( operation, 0, sizeof( *operation ) );
3620 return( PSA_ERROR_INVALID_ARGUMENT );
3621 }
3622
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003623 operation->alg = alg;
3624 operation->key_set = 0;
3625 operation->iv_set = 0;
3626 operation->iv_required = 1;
3627 operation->iv_size = 0;
3628 operation->block_size = 0;
3629 mbedtls_cipher_init( &operation->ctx.cipher );
3630 return( PSA_SUCCESS );
3631}
3632
Gilles Peskinee553c652018-06-04 16:22:46 +02003633static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003634 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003635 psa_algorithm_t alg,
3636 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003637{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003638 int ret = 0;
3639 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003640 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003641 size_t key_bits;
3642 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003643 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3644 PSA_KEY_USAGE_ENCRYPT :
3645 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003646
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003647 /* A context must be freshly initialized before it can be set up. */
3648 if( operation->alg != 0 )
3649 {
3650 return( PSA_ERROR_BAD_STATE );
3651 }
3652
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003653 status = psa_cipher_init( operation, alg );
3654 if( status != PSA_SUCCESS )
3655 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003656
Gilles Peskine28f8f302019-07-24 13:30:31 +02003657 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003658 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003659 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003660 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003661
Gilles Peskine8e338702019-07-30 20:06:31 +02003662 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003663 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003664 {
3665 status = PSA_ERROR_NOT_SUPPORTED;
3666 goto exit;
3667 }
mohammad1603503973b2018-03-12 15:59:30 +02003668
mohammad1603503973b2018-03-12 15:59:30 +02003669 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003670 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003671 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003672
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003673#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003674 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003675 {
3676 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003677 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003678 memcpy( keys, slot->data.raw.data, 16 );
3679 memcpy( keys + 16, slot->data.raw.data, 8 );
3680 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3681 keys,
3682 192, cipher_operation );
3683 }
3684 else
3685#endif
3686 {
3687 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3688 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003689 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003690 }
Moran Peker41deec42018-04-04 15:43:05 +03003691 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003692 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003693
mohammad16038481e742018-03-18 13:57:31 +02003694#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003695 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003696 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003697 case PSA_ALG_CBC_NO_PADDING:
3698 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3699 MBEDTLS_PADDING_NONE );
3700 break;
3701 case PSA_ALG_CBC_PKCS7:
3702 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3703 MBEDTLS_PADDING_PKCS7 );
3704 break;
3705 default:
3706 /* The algorithm doesn't involve padding. */
3707 ret = 0;
3708 break;
3709 }
3710 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003711 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003712#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3713
mohammad1603503973b2018-03-12 15:59:30 +02003714 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003715 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003716 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003717 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003718 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003719 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003720 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003721#if defined(MBEDTLS_CHACHA20_C)
3722 else
3723 if( alg == PSA_ALG_CHACHA20 )
3724 operation->iv_size = 12;
3725#endif
mohammad1603503973b2018-03-12 15:59:30 +02003726
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003727exit:
3728 if( status == 0 )
3729 status = mbedtls_to_psa_error( ret );
3730 if( status != 0 )
3731 psa_cipher_abort( operation );
3732 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003733}
3734
Gilles Peskinefe119512018-07-08 21:39:34 +02003735psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003736 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003737 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003738{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003739 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003740}
3741
Gilles Peskinefe119512018-07-08 21:39:34 +02003742psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003743 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003744 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003745{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003746 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003747}
3748
Gilles Peskinefe119512018-07-08 21:39:34 +02003749psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003750 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003751 size_t iv_size,
3752 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003753{
itayzafrir534bd7c2018-08-02 13:56:32 +03003754 psa_status_t status;
3755 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003756 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003757 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003758 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003759 }
Moran Peker41deec42018-04-04 15:43:05 +03003760 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003761 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003762 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003763 goto exit;
3764 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003765 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3766 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003767 if( ret != 0 )
3768 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003769 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003770 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003771 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003772
mohammad16038481e742018-03-18 13:57:31 +02003773 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003774 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003775
Moran Peker395db872018-05-31 14:07:14 +03003776exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003777 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003778 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003779 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003780}
3781
Gilles Peskinefe119512018-07-08 21:39:34 +02003782psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003783 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003784 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003785{
itayzafrir534bd7c2018-08-02 13:56:32 +03003786 psa_status_t status;
3787 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003788 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003789 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003790 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003791 }
Moran Pekera28258c2018-05-29 16:25:04 +03003792 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003793 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003794 status = PSA_ERROR_INVALID_ARGUMENT;
3795 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003796 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003797 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3798 status = mbedtls_to_psa_error( ret );
3799exit:
3800 if( status == PSA_SUCCESS )
3801 operation->iv_set = 1;
3802 else
mohammad1603503973b2018-03-12 15:59:30 +02003803 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003804 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003805}
3806
Gilles Peskinee553c652018-06-04 16:22:46 +02003807psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3808 const uint8_t *input,
3809 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003810 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003811 size_t output_size,
3812 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003813{
itayzafrir534bd7c2018-08-02 13:56:32 +03003814 psa_status_t status;
3815 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003816 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003817
3818 if( operation->alg == 0 )
3819 {
3820 return( PSA_ERROR_BAD_STATE );
3821 }
3822
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003823 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003824 {
3825 /* Take the unprocessed partial block left over from previous
3826 * update calls, if any, plus the input to this call. Remove
3827 * the last partial block, if any. You get the data that will be
3828 * output in this call. */
3829 expected_output_size =
3830 ( operation->ctx.cipher.unprocessed_len + input_length )
3831 / operation->block_size * operation->block_size;
3832 }
3833 else
3834 {
3835 expected_output_size = input_length;
3836 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003837
Gilles Peskine89d789c2018-06-04 17:17:16 +02003838 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003839 {
3840 status = PSA_ERROR_BUFFER_TOO_SMALL;
3841 goto exit;
3842 }
mohammad160382759612018-03-12 18:16:40 +02003843
mohammad1603503973b2018-03-12 15:59:30 +02003844 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003845 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003846 status = mbedtls_to_psa_error( ret );
3847exit:
3848 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003849 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003850 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003851}
3852
Gilles Peskinee553c652018-06-04 16:22:46 +02003853psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3854 uint8_t *output,
3855 size_t output_size,
3856 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003857{
David Saadab4ecc272019-02-14 13:48:10 +02003858 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003859 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003860 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003861
mohammad1603503973b2018-03-12 15:59:30 +02003862 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003863 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003864 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003865 }
3866 if( operation->iv_required && ! operation->iv_set )
3867 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003868 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003869 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003870
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003871 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003872 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3873 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003874 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003875 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003876 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003877 }
3878
Janos Follath315b51c2018-07-09 16:04:51 +01003879 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3880 temp_output_buffer,
3881 output_length );
3882 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003883 {
Janos Follath315b51c2018-07-09 16:04:51 +01003884 status = mbedtls_to_psa_error( cipher_ret );
3885 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003886 }
Janos Follath315b51c2018-07-09 16:04:51 +01003887
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003888 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003889 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003890 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003891 memcpy( output, temp_output_buffer, *output_length );
3892 else
3893 {
Janos Follath315b51c2018-07-09 16:04:51 +01003894 status = PSA_ERROR_BUFFER_TOO_SMALL;
3895 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003896 }
mohammad1603503973b2018-03-12 15:59:30 +02003897
Gilles Peskine3f108122018-12-07 18:14:53 +01003898 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003899 status = psa_cipher_abort( operation );
3900
3901 return( status );
3902
3903error:
3904
3905 *output_length = 0;
3906
Gilles Peskine3f108122018-12-07 18:14:53 +01003907 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003908 (void) psa_cipher_abort( operation );
3909
3910 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003911}
3912
Gilles Peskinee553c652018-06-04 16:22:46 +02003913psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3914{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003915 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003916 {
3917 /* The object has (apparently) been initialized but it is not
3918 * in use. It's ok to call abort on such an object, and there's
3919 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003920 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003921 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003922
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003923 /* Sanity check (shouldn't happen: operation->alg should
3924 * always have been initialized to a valid value). */
3925 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3926 return( PSA_ERROR_BAD_STATE );
3927
mohammad1603503973b2018-03-12 15:59:30 +02003928 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003929
Moran Peker41deec42018-04-04 15:43:05 +03003930 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003931 operation->key_set = 0;
3932 operation->iv_set = 0;
3933 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003934 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003935 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003936
Moran Peker395db872018-05-31 14:07:14 +03003937 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003938}
3939
Gilles Peskinea0655c32018-04-30 17:06:50 +02003940
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003941
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003942
mohammad16035955c982018-04-26 00:53:03 +03003943/****************************************************************/
3944/* AEAD */
3945/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003946
Gilles Peskineedf9a652018-08-17 18:11:56 +02003947typedef struct
3948{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003949 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003950 const mbedtls_cipher_info_t *cipher_info;
3951 union
3952 {
3953#if defined(MBEDTLS_CCM_C)
3954 mbedtls_ccm_context ccm;
3955#endif /* MBEDTLS_CCM_C */
3956#if defined(MBEDTLS_GCM_C)
3957 mbedtls_gcm_context gcm;
3958#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003959#if defined(MBEDTLS_CHACHAPOLY_C)
3960 mbedtls_chachapoly_context chachapoly;
3961#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003962 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003963 psa_algorithm_t core_alg;
3964 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003965 uint8_t tag_length;
3966} aead_operation_t;
3967
Gilles Peskine30a9e412019-01-14 18:36:12 +01003968static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003969{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003970 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003971 {
3972#if defined(MBEDTLS_CCM_C)
3973 case PSA_ALG_CCM:
3974 mbedtls_ccm_free( &operation->ctx.ccm );
3975 break;
3976#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003977#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003978 case PSA_ALG_GCM:
3979 mbedtls_gcm_free( &operation->ctx.gcm );
3980 break;
3981#endif /* MBEDTLS_GCM_C */
3982 }
3983}
3984
3985static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003986 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003987 psa_key_usage_t usage,
3988 psa_algorithm_t alg )
3989{
3990 psa_status_t status;
3991 size_t key_bits;
3992 mbedtls_cipher_id_t cipher_id;
3993
Gilles Peskine28f8f302019-07-24 13:30:31 +02003994 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003995 if( status != PSA_SUCCESS )
3996 return( status );
3997
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003998 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003999
4000 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004001 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004002 &cipher_id );
4003 if( operation->cipher_info == NULL )
4004 return( PSA_ERROR_NOT_SUPPORTED );
4005
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004006 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004007 {
4008#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004009 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4010 operation->core_alg = PSA_ALG_CCM;
4011 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004012 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4013 * The call to mbedtls_ccm_encrypt_and_tag or
4014 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004015 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004016 return( PSA_ERROR_INVALID_ARGUMENT );
4017 mbedtls_ccm_init( &operation->ctx.ccm );
4018 status = mbedtls_to_psa_error(
4019 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
4020 operation->slot->data.raw.data,
4021 (unsigned int) key_bits ) );
4022 if( status != 0 )
4023 goto cleanup;
4024 break;
4025#endif /* MBEDTLS_CCM_C */
4026
4027#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004028 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4029 operation->core_alg = PSA_ALG_GCM;
4030 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004031 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4032 * The call to mbedtls_gcm_crypt_and_tag or
4033 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004034 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004035 return( PSA_ERROR_INVALID_ARGUMENT );
4036 mbedtls_gcm_init( &operation->ctx.gcm );
4037 status = mbedtls_to_psa_error(
4038 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
4039 operation->slot->data.raw.data,
4040 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004041 if( status != 0 )
4042 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004043 break;
4044#endif /* MBEDTLS_GCM_C */
4045
Gilles Peskine26869f22019-05-06 15:25:00 +02004046#if defined(MBEDTLS_CHACHAPOLY_C)
4047 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4048 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4049 operation->full_tag_length = 16;
4050 /* We only support the default tag length. */
4051 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4052 return( PSA_ERROR_NOT_SUPPORTED );
4053 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4054 status = mbedtls_to_psa_error(
4055 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
4056 operation->slot->data.raw.data ) );
4057 if( status != 0 )
4058 goto cleanup;
4059 break;
4060#endif /* MBEDTLS_CHACHAPOLY_C */
4061
Gilles Peskineedf9a652018-08-17 18:11:56 +02004062 default:
4063 return( PSA_ERROR_NOT_SUPPORTED );
4064 }
4065
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004066 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4067 {
4068 status = PSA_ERROR_INVALID_ARGUMENT;
4069 goto cleanup;
4070 }
4071 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004072
Gilles Peskineedf9a652018-08-17 18:11:56 +02004073 return( PSA_SUCCESS );
4074
4075cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004076 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004077 return( status );
4078}
4079
Gilles Peskinec5487a82018-12-03 18:08:14 +01004080psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004081 psa_algorithm_t alg,
4082 const uint8_t *nonce,
4083 size_t nonce_length,
4084 const uint8_t *additional_data,
4085 size_t additional_data_length,
4086 const uint8_t *plaintext,
4087 size_t plaintext_length,
4088 uint8_t *ciphertext,
4089 size_t ciphertext_size,
4090 size_t *ciphertext_length )
4091{
mohammad16035955c982018-04-26 00:53:03 +03004092 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004093 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004094 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004095
mohammad1603f08a5502018-06-03 15:05:47 +03004096 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004097
Gilles Peskinec5487a82018-12-03 18:08:14 +01004098 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004099 if( status != PSA_SUCCESS )
4100 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004101
Gilles Peskineedf9a652018-08-17 18:11:56 +02004102 /* For all currently supported modes, the tag is at the end of the
4103 * ciphertext. */
4104 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4105 {
4106 status = PSA_ERROR_BUFFER_TOO_SMALL;
4107 goto exit;
4108 }
4109 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004110
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004111#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004112 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004113 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004114 status = mbedtls_to_psa_error(
4115 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4116 MBEDTLS_GCM_ENCRYPT,
4117 plaintext_length,
4118 nonce, nonce_length,
4119 additional_data, additional_data_length,
4120 plaintext, ciphertext,
4121 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004122 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004123 else
4124#endif /* MBEDTLS_GCM_C */
4125#if defined(MBEDTLS_CCM_C)
4126 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004127 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004128 status = mbedtls_to_psa_error(
4129 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4130 plaintext_length,
4131 nonce, nonce_length,
4132 additional_data,
4133 additional_data_length,
4134 plaintext, ciphertext,
4135 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004136 }
mohammad16035c8845f2018-05-09 05:40:09 -07004137 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004138#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004139#if defined(MBEDTLS_CHACHAPOLY_C)
4140 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4141 {
4142 if( nonce_length != 12 || operation.tag_length != 16 )
4143 {
4144 status = PSA_ERROR_NOT_SUPPORTED;
4145 goto exit;
4146 }
4147 status = mbedtls_to_psa_error(
4148 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4149 plaintext_length,
4150 nonce,
4151 additional_data,
4152 additional_data_length,
4153 plaintext,
4154 ciphertext,
4155 tag ) );
4156 }
4157 else
4158#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004159 {
mohammad1603554faad2018-06-03 15:07:38 +03004160 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004161 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004162
Gilles Peskineedf9a652018-08-17 18:11:56 +02004163 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4164 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004165
Gilles Peskineedf9a652018-08-17 18:11:56 +02004166exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004167 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004168 if( status == PSA_SUCCESS )
4169 *ciphertext_length = plaintext_length + operation.tag_length;
4170 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004171}
4172
Gilles Peskineee652a32018-06-01 19:23:52 +02004173/* Locate the tag in a ciphertext buffer containing the encrypted data
4174 * followed by the tag. Return the length of the part preceding the tag in
4175 * *plaintext_length. This is the size of the plaintext in modes where
4176 * the encrypted data has the same size as the plaintext, such as
4177 * CCM and GCM. */
4178static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4179 const uint8_t *ciphertext,
4180 size_t ciphertext_length,
4181 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004182 const uint8_t **p_tag )
4183{
4184 size_t payload_length;
4185 if( tag_length > ciphertext_length )
4186 return( PSA_ERROR_INVALID_ARGUMENT );
4187 payload_length = ciphertext_length - tag_length;
4188 if( payload_length > plaintext_size )
4189 return( PSA_ERROR_BUFFER_TOO_SMALL );
4190 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004191 return( PSA_SUCCESS );
4192}
4193
Gilles Peskinec5487a82018-12-03 18:08:14 +01004194psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004195 psa_algorithm_t alg,
4196 const uint8_t *nonce,
4197 size_t nonce_length,
4198 const uint8_t *additional_data,
4199 size_t additional_data_length,
4200 const uint8_t *ciphertext,
4201 size_t ciphertext_length,
4202 uint8_t *plaintext,
4203 size_t plaintext_size,
4204 size_t *plaintext_length )
4205{
mohammad16035955c982018-04-26 00:53:03 +03004206 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004207 aead_operation_t operation;
4208 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004209
Gilles Peskineee652a32018-06-01 19:23:52 +02004210 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004211
Gilles Peskinec5487a82018-12-03 18:08:14 +01004212 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004213 if( status != PSA_SUCCESS )
4214 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004215
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004216 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4217 ciphertext, ciphertext_length,
4218 plaintext_size, &tag );
4219 if( status != PSA_SUCCESS )
4220 goto exit;
4221
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004222#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004223 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004224 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004225 status = mbedtls_to_psa_error(
4226 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4227 ciphertext_length - operation.tag_length,
4228 nonce, nonce_length,
4229 additional_data,
4230 additional_data_length,
4231 tag, operation.tag_length,
4232 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004233 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004234 else
4235#endif /* MBEDTLS_GCM_C */
4236#if defined(MBEDTLS_CCM_C)
4237 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004238 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004239 status = mbedtls_to_psa_error(
4240 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4241 ciphertext_length - operation.tag_length,
4242 nonce, nonce_length,
4243 additional_data,
4244 additional_data_length,
4245 ciphertext, plaintext,
4246 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004247 }
mohammad160339574652018-06-01 04:39:53 -07004248 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004249#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004250#if defined(MBEDTLS_CHACHAPOLY_C)
4251 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4252 {
4253 if( nonce_length != 12 || operation.tag_length != 16 )
4254 {
4255 status = PSA_ERROR_NOT_SUPPORTED;
4256 goto exit;
4257 }
4258 status = mbedtls_to_psa_error(
4259 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4260 ciphertext_length - operation.tag_length,
4261 nonce,
4262 additional_data,
4263 additional_data_length,
4264 tag,
4265 ciphertext,
4266 plaintext ) );
4267 }
4268 else
4269#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004270 {
mohammad1603554faad2018-06-03 15:07:38 +03004271 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004272 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004273
Gilles Peskineedf9a652018-08-17 18:11:56 +02004274 if( status != PSA_SUCCESS && plaintext_size != 0 )
4275 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004276
Gilles Peskineedf9a652018-08-17 18:11:56 +02004277exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004278 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004279 if( status == PSA_SUCCESS )
4280 *plaintext_length = ciphertext_length - operation.tag_length;
4281 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004282}
4283
Gilles Peskinea0655c32018-04-30 17:06:50 +02004284
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004285
Gilles Peskine20035e32018-02-03 22:44:14 +01004286/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004287/* Generators */
4288/****************************************************************/
4289
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004290#define HKDF_STATE_INIT 0 /* no input yet */
4291#define HKDF_STATE_STARTED 1 /* got salt */
4292#define HKDF_STATE_KEYED 2 /* got key */
4293#define HKDF_STATE_OUTPUT 3 /* output started */
4294
Gilles Peskinecbe66502019-05-16 16:59:18 +02004295static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004296 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004297{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004298 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4299 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004300 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004301 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004302}
4303
4304
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004305psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004306{
4307 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004308 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004309 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004310 {
4311 /* The object has (apparently) been initialized but it is not
4312 * in use. It's ok to call abort on such an object, and there's
4313 * nothing to do. */
4314 }
4315 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004316#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004317 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004318 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004319 mbedtls_free( operation->ctx.hkdf.info );
4320 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004321 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004322 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004323 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004324 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004325 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004326#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004327 if( operation->ctx.tls12_prf.key != NULL )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004328 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004329 mbedtls_platform_zeroize( operation->ctx.tls12_prf.key,
4330 operation->ctx.tls12_prf.key_len );
4331 mbedtls_free( operation->ctx.tls12_prf.key );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004332 }
Hanno Becker580fba12018-11-13 20:50:45 +00004333
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004334 if( operation->ctx.tls12_prf.Ai_with_seed != NULL )
Hanno Becker580fba12018-11-13 20:50:45 +00004335 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004336 mbedtls_platform_zeroize( operation->ctx.tls12_prf.Ai_with_seed,
4337 operation->ctx.tls12_prf.Ai_with_seed_len );
4338 mbedtls_free( operation->ctx.tls12_prf.Ai_with_seed );
Hanno Becker580fba12018-11-13 20:50:45 +00004339 }
Janos Follath6a1d2622019-06-11 10:37:28 +01004340#else
4341 if( operation->ctx.tls12_prf.seed != NULL )
4342 {
4343 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4344 operation->ctx.tls12_prf.seed_length );
4345 mbedtls_free( operation->ctx.tls12_prf.seed );
4346 }
4347
4348 if( operation->ctx.tls12_prf.label != NULL )
4349 {
4350 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4351 operation->ctx.tls12_prf.label_length );
4352 mbedtls_free( operation->ctx.tls12_prf.label );
4353 }
4354
4355 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4356
4357 /* We leave the fields Ai and output_block to be erased safely by the
4358 * mbedtls_platform_zeroize() in the end of this function. */
Janos Follath999f6482019-06-11 12:04:10 +01004359#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004360 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004361 else
4362#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004363 {
4364 status = PSA_ERROR_BAD_STATE;
4365 }
Janos Follath083036a2019-06-11 10:22:26 +01004366 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004367 return( status );
4368}
4369
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004370psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004371 size_t *capacity)
4372{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004373 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004374 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004375 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004376 return PSA_ERROR_BAD_STATE;
4377 }
4378
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004379 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004380 return( PSA_SUCCESS );
4381}
4382
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004383psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004384 size_t capacity )
4385{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004386 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004387 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004388 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004389 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004390 operation->capacity = capacity;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004391 return( PSA_SUCCESS );
4392}
4393
Gilles Peskinebef7f142018-07-12 17:22:21 +02004394#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004395/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004396 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004397static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004398 psa_algorithm_t hash_alg,
4399 uint8_t *output,
4400 size_t output_length )
4401{
4402 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4403 psa_status_t status;
4404
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004405 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4406 return( PSA_ERROR_BAD_STATE );
4407 hkdf->state = HKDF_STATE_OUTPUT;
4408
Gilles Peskinebef7f142018-07-12 17:22:21 +02004409 while( output_length != 0 )
4410 {
4411 /* Copy what remains of the current block */
4412 uint8_t n = hash_length - hkdf->offset_in_block;
4413 if( n > output_length )
4414 n = (uint8_t) output_length;
4415 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4416 output += n;
4417 output_length -= n;
4418 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004419 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004420 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004421 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004422 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004423 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004424 * object was corrupted or if this function is called directly
4425 * inside the library. */
4426 if( hkdf->block_number == 0xff )
4427 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004428
4429 /* We need a new block */
4430 ++hkdf->block_number;
4431 hkdf->offset_in_block = 0;
4432 status = psa_hmac_setup_internal( &hkdf->hmac,
4433 hkdf->prk, hash_length,
4434 hash_alg );
4435 if( status != PSA_SUCCESS )
4436 return( status );
4437 if( hkdf->block_number != 1 )
4438 {
4439 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4440 hkdf->output_block,
4441 hash_length );
4442 if( status != PSA_SUCCESS )
4443 return( status );
4444 }
4445 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4446 hkdf->info,
4447 hkdf->info_length );
4448 if( status != PSA_SUCCESS )
4449 return( status );
4450 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4451 &hkdf->block_number, 1 );
4452 if( status != PSA_SUCCESS )
4453 return( status );
4454 status = psa_hmac_finish_internal( &hkdf->hmac,
4455 hkdf->output_block,
4456 sizeof( hkdf->output_block ) );
4457 if( status != PSA_SUCCESS )
4458 return( status );
4459 }
4460
4461 return( PSA_SUCCESS );
4462}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004463
Janos Follath999f6482019-06-11 12:04:10 +01004464#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004465static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4466 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004467 psa_algorithm_t alg )
4468{
4469 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4470 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4471 psa_hmac_internal_data hmac;
4472 psa_status_t status, cleanup_status;
4473
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004474 uint8_t *Ai;
Hanno Becker3b339e22018-11-13 20:56:14 +00004475 size_t Ai_len;
4476
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004477 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004478 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004479 * prevented this call. It could happen only if the operation
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004480 * object was corrupted or if this function is called directly
4481 * inside the library. */
4482 if( tls12_prf->block_number == 0xff )
4483 return( PSA_ERROR_BAD_STATE );
4484
4485 /* We need a new block */
4486 ++tls12_prf->block_number;
4487 tls12_prf->offset_in_block = 0;
4488
4489 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4490 *
4491 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4492 *
4493 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4494 * HMAC_hash(secret, A(2) + seed) +
4495 * HMAC_hash(secret, A(3) + seed) + ...
4496 *
4497 * A(0) = seed
4498 * A(i) = HMAC_hash( secret, A(i-1) )
4499 *
Gilles Peskinecbe66502019-05-16 16:59:18 +02004500 * The `psa_tls12_prf_key_derivation` structures saves the block
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004501 * `HMAC_hash(secret, A(i) + seed)` from which the output
4502 * is currently extracted as `output_block`, while
4503 * `A(i) + seed` is stored in `Ai_with_seed`.
4504 *
4505 * Generating a new block means recalculating `Ai_with_seed`
4506 * from the A(i)-part of it, and afterwards recalculating
4507 * `output_block`.
4508 *
4509 * A(0) is computed at setup time.
4510 *
4511 */
4512
4513 psa_hmac_init_internal( &hmac );
4514
4515 /* We must distinguish the calculation of A(1) from those
4516 * of A(2) and higher, because A(0)=seed has a different
4517 * length than the other A(i). */
4518 if( tls12_prf->block_number == 1 )
4519 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004520 Ai = tls12_prf->Ai_with_seed + hash_length;
4521 Ai_len = tls12_prf->Ai_with_seed_len - hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004522 }
4523 else
4524 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004525 Ai = tls12_prf->Ai_with_seed;
4526 Ai_len = hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004527 }
4528
Hanno Becker3b339e22018-11-13 20:56:14 +00004529 /* Compute A(i+1) = HMAC_hash(secret, A(i)) */
4530 status = psa_hmac_setup_internal( &hmac,
4531 tls12_prf->key,
4532 tls12_prf->key_len,
4533 hash_alg );
4534 if( status != PSA_SUCCESS )
4535 goto cleanup;
4536
4537 status = psa_hash_update( &hmac.hash_ctx,
4538 Ai, Ai_len );
4539 if( status != PSA_SUCCESS )
4540 goto cleanup;
4541
4542 status = psa_hmac_finish_internal( &hmac,
4543 tls12_prf->Ai_with_seed,
4544 hash_length );
4545 if( status != PSA_SUCCESS )
4546 goto cleanup;
4547
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004548 /* Compute the next block `HMAC_hash(secret, A(i+1) + seed)`. */
4549 status = psa_hmac_setup_internal( &hmac,
4550 tls12_prf->key,
4551 tls12_prf->key_len,
4552 hash_alg );
4553 if( status != PSA_SUCCESS )
4554 goto cleanup;
4555
4556 status = psa_hash_update( &hmac.hash_ctx,
4557 tls12_prf->Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00004558 tls12_prf->Ai_with_seed_len );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004559 if( status != PSA_SUCCESS )
4560 goto cleanup;
4561
4562 status = psa_hmac_finish_internal( &hmac,
4563 tls12_prf->output_block,
4564 hash_length );
4565 if( status != PSA_SUCCESS )
4566 goto cleanup;
4567
4568cleanup:
4569
4570 cleanup_status = psa_hmac_abort_internal( &hmac );
4571 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4572 status = cleanup_status;
4573
4574 return( status );
4575}
Janos Follath7742fee2019-06-17 12:58:10 +01004576#else
4577static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4578 psa_tls12_prf_key_derivation_t *tls12_prf,
4579 psa_algorithm_t alg )
4580{
4581 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4582 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004583 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4584 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004585
Janos Follath7742fee2019-06-17 12:58:10 +01004586 /* We can't be wanting more output after block 0xff, otherwise
4587 * the capacity check in psa_key_derivation_output_bytes() would have
4588 * prevented this call. It could happen only if the operation
4589 * object was corrupted or if this function is called directly
4590 * inside the library. */
4591 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004592 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004593
4594 /* We need a new block */
4595 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004596 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004597
4598 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4599 *
4600 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4601 *
4602 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4603 * HMAC_hash(secret, A(2) + seed) +
4604 * HMAC_hash(secret, A(3) + seed) + ...
4605 *
4606 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004607 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004608 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004609 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004610 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004611 * is currently extracted as `output_block` and where i is
4612 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004613 */
4614
Janos Follathea29bfb2019-06-19 12:21:20 +01004615 /* Save the hash context before using it, to preserve the hash state with
4616 * only the inner padding in it. We need this, because inner padding depends
4617 * on the key (secret in the RFC's terminology). */
4618 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4619 if( status != PSA_SUCCESS )
4620 goto cleanup;
4621
4622 /* Calculate A(i) where i = tls12_prf->block_number. */
4623 if( tls12_prf->block_number == 1 )
4624 {
4625 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4626 * the variable seed and in this instance means it in the context of the
4627 * P_hash function, where seed = label + seed.) */
4628 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4629 tls12_prf->label, tls12_prf->label_length );
4630 if( status != PSA_SUCCESS )
4631 goto cleanup;
4632 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4633 tls12_prf->seed, tls12_prf->seed_length );
4634 if( status != PSA_SUCCESS )
4635 goto cleanup;
4636 }
4637 else
4638 {
4639 /* A(i) = HMAC_hash(secret, A(i-1)) */
4640 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4641 tls12_prf->Ai, hash_length );
4642 if( status != PSA_SUCCESS )
4643 goto cleanup;
4644 }
4645
4646 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4647 tls12_prf->Ai, hash_length );
4648 if( status != PSA_SUCCESS )
4649 goto cleanup;
4650 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4651 if( status != PSA_SUCCESS )
4652 goto cleanup;
4653
4654 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4655 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4656 tls12_prf->Ai, hash_length );
4657 if( status != PSA_SUCCESS )
4658 goto cleanup;
4659 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4660 tls12_prf->label, tls12_prf->label_length );
4661 if( status != PSA_SUCCESS )
4662 goto cleanup;
4663 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4664 tls12_prf->seed, tls12_prf->seed_length );
4665 if( status != PSA_SUCCESS )
4666 goto cleanup;
4667 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4668 tls12_prf->output_block, hash_length );
4669 if( status != PSA_SUCCESS )
4670 goto cleanup;
4671 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4672 if( status != PSA_SUCCESS )
4673 goto cleanup;
4674
Janos Follath7742fee2019-06-17 12:58:10 +01004675
4676cleanup:
4677
Janos Follathea29bfb2019-06-19 12:21:20 +01004678 cleanup_status = psa_hash_abort( &backup );
4679 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4680 status = cleanup_status;
4681
4682 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004683}
Janos Follath999f6482019-06-11 12:04:10 +01004684#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004685
Janos Follath999f6482019-06-11 12:04:10 +01004686#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004687/* Read some bytes from an TLS-1.2-PRF-based operation.
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004688 * See Section 5 of RFC 5246. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004689static psa_status_t psa_key_derivation_tls12_prf_read(
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004690 psa_tls12_prf_key_derivation_t *tls12_prf,
4691 psa_algorithm_t alg,
4692 uint8_t *output,
4693 size_t output_length )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004694{
4695 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4696 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4697 psa_status_t status;
4698
4699 while( output_length != 0 )
4700 {
4701 /* Copy what remains of the current block */
4702 uint8_t n = hash_length - tls12_prf->offset_in_block;
4703
4704 /* Check if we have fully processed the current block. */
4705 if( n == 0 )
4706 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004707 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004708 alg );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004709 if( status != PSA_SUCCESS )
4710 return( status );
4711
4712 continue;
4713 }
4714
4715 if( n > output_length )
4716 n = (uint8_t) output_length;
4717 memcpy( output, tls12_prf->output_block + tls12_prf->offset_in_block,
4718 n );
4719 output += n;
4720 output_length -= n;
4721 tls12_prf->offset_in_block += n;
4722 }
4723
4724 return( PSA_SUCCESS );
4725}
Janos Follath844eb0e2019-06-19 12:10:49 +01004726#else
4727static psa_status_t psa_key_derivation_tls12_prf_read(
4728 psa_tls12_prf_key_derivation_t *tls12_prf,
4729 psa_algorithm_t alg,
4730 uint8_t *output,
4731 size_t output_length )
4732{
4733 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4734 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4735 psa_status_t status;
4736 uint8_t offset, length;
4737
4738 while( output_length != 0 )
4739 {
4740 /* Check if we have fully processed the current block. */
4741 if( tls12_prf->left_in_block == 0 )
4742 {
4743 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4744 alg );
4745 if( status != PSA_SUCCESS )
4746 return( status );
4747
4748 continue;
4749 }
4750
4751 if( tls12_prf->left_in_block > output_length )
4752 length = (uint8_t) output_length;
4753 else
4754 length = tls12_prf->left_in_block;
4755
4756 offset = hash_length - tls12_prf->left_in_block;
4757 memcpy( output, tls12_prf->output_block + offset, length );
4758 output += length;
4759 output_length -= length;
4760 tls12_prf->left_in_block -= length;
4761 }
4762
4763 return( PSA_SUCCESS );
4764}
Janos Follath999f6482019-06-11 12:04:10 +01004765#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004766#endif /* MBEDTLS_MD_C */
4767
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004768psa_status_t psa_key_derivation_output_bytes(
4769 psa_key_derivation_operation_t *operation,
4770 uint8_t *output,
4771 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004772{
4773 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004774 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004775
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004776 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004777 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004778 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004779 return PSA_ERROR_BAD_STATE;
4780 }
4781
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004782 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004783 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004784 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004785 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004786 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004787 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004788 goto exit;
4789 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004790 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004791 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004792 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004793 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004794 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4795 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004796 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004797 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004798 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004799 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004800 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004801
Gilles Peskinebef7f142018-07-12 17:22:21 +02004802#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004803 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004804 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004805 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004806 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004807 output, output_length );
4808 }
Janos Follathadbec812019-06-14 11:05:39 +01004809 else
Janos Follathadbec812019-06-14 11:05:39 +01004810 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004811 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004812 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004813 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004814 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004815 output_length );
4816 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004817 else
4818#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004819 {
4820 return( PSA_ERROR_BAD_STATE );
4821 }
4822
4823exit:
4824 if( status != PSA_SUCCESS )
4825 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004826 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004827 * This allows us to differentiate between exhausted operations and
4828 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4829 * operations. */
4830 psa_algorithm_t alg = operation->alg;
4831 psa_key_derivation_abort( operation );
4832 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004833 memset( output, '!', output_length );
4834 }
4835 return( status );
4836}
4837
Gilles Peskine08542d82018-07-19 17:05:42 +02004838#if defined(MBEDTLS_DES_C)
4839static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4840{
4841 if( data_size >= 8 )
4842 mbedtls_des_key_set_parity( data );
4843 if( data_size >= 16 )
4844 mbedtls_des_key_set_parity( data + 8 );
4845 if( data_size >= 24 )
4846 mbedtls_des_key_set_parity( data + 16 );
4847}
4848#endif /* MBEDTLS_DES_C */
4849
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004850static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004851 psa_key_slot_t *slot,
4852 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004853 psa_key_derivation_operation_t *operation )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004854{
4855 uint8_t *data = NULL;
4856 size_t bytes = PSA_BITS_TO_BYTES( bits );
4857 psa_status_t status;
4858
Gilles Peskine8e338702019-07-30 20:06:31 +02004859 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004860 return( PSA_ERROR_INVALID_ARGUMENT );
4861 if( bits % 8 != 0 )
4862 return( PSA_ERROR_INVALID_ARGUMENT );
4863 data = mbedtls_calloc( 1, bytes );
4864 if( data == NULL )
4865 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4866
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004867 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004868 if( status != PSA_SUCCESS )
4869 goto exit;
4870#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004871 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004872 psa_des_set_key_parity( data, bytes );
4873#endif /* MBEDTLS_DES_C */
4874 status = psa_import_key_into_slot( slot, data, bytes );
4875
4876exit:
4877 mbedtls_free( data );
4878 return( status );
4879}
4880
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004881psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004882 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004883 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004884{
4885 psa_status_t status;
4886 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004887 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinedf179142019-07-15 22:02:14 +02004888 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
4889 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004890#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4891 if( driver != NULL )
4892 {
4893 /* Deriving a key in a secure element is not implemented yet. */
4894 status = PSA_ERROR_NOT_SUPPORTED;
4895 }
4896#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004897 if( status == PSA_SUCCESS )
4898 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004899 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004900 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004901 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004902 }
4903 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004904 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004905 if( status != PSA_SUCCESS )
4906 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004907 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004908 *handle = 0;
4909 }
4910 return( status );
4911}
4912
Gilles Peskineeab56e42018-07-12 17:12:33 +02004913
4914
4915/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004916/* Key derivation */
4917/****************************************************************/
4918
Gilles Peskinea05219c2018-11-16 16:02:56 +01004919#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004920#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004921/* Set up an HKDF-based operation. This is exactly the extract phase
Gilles Peskine346797d2018-11-16 16:05:06 +01004922 * of the HKDF algorithm.
4923 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004924 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004925 * to potentially free embedded data structures and wipe confidential data.
4926 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004927static psa_status_t psa_key_derivation_hkdf_setup( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004928 const uint8_t *secret,
4929 size_t secret_length,
4930 psa_algorithm_t hash_alg,
4931 const uint8_t *salt,
4932 size_t salt_length,
4933 const uint8_t *label,
4934 size_t label_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004935{
4936 psa_status_t status;
4937 status = psa_hmac_setup_internal( &hkdf->hmac,
4938 salt, salt_length,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004939 hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004940 if( status != PSA_SUCCESS )
4941 return( status );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004942 status = psa_hash_update( &hkdf->hmac.hash_ctx, secret, secret_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004943 if( status != PSA_SUCCESS )
4944 return( status );
4945 status = psa_hmac_finish_internal( &hkdf->hmac,
4946 hkdf->prk,
4947 sizeof( hkdf->prk ) );
4948 if( status != PSA_SUCCESS )
4949 return( status );
4950 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4951 hkdf->block_number = 0;
4952 hkdf->info_length = label_length;
4953 if( label_length != 0 )
4954 {
4955 hkdf->info = mbedtls_calloc( 1, label_length );
4956 if( hkdf->info == NULL )
4957 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4958 memcpy( hkdf->info, label, label_length );
4959 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004960 hkdf->state = HKDF_STATE_KEYED;
4961 hkdf->info_set = 1;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004962 return( PSA_SUCCESS );
4963}
Janos Follath71a4c912019-06-11 09:14:47 +01004964#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01004965#endif /* MBEDTLS_MD_C */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004966
Gilles Peskinea05219c2018-11-16 16:02:56 +01004967#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004968#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004969/* Set up a TLS-1.2-prf-based operation (see RFC 5246, Section 5).
Gilles Peskine346797d2018-11-16 16:05:06 +01004970 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004971 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004972 * to potentially free embedded data structures and wipe confidential data.
4973 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004974static psa_status_t psa_key_derivation_tls12_prf_setup(
4975 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004976 const uint8_t *key,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004977 size_t key_len,
4978 psa_algorithm_t hash_alg,
4979 const uint8_t *salt,
4980 size_t salt_length,
4981 const uint8_t *label,
4982 size_t label_length )
4983{
4984 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Hanno Becker580fba12018-11-13 20:50:45 +00004985 size_t Ai_with_seed_len = hash_length + salt_length + label_length;
4986 int overflow;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004987
4988 tls12_prf->key = mbedtls_calloc( 1, key_len );
4989 if( tls12_prf->key == NULL )
4990 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4991 tls12_prf->key_len = key_len;
4992 memcpy( tls12_prf->key, key, key_len );
4993
Hanno Becker580fba12018-11-13 20:50:45 +00004994 overflow = ( salt_length + label_length < salt_length ) ||
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004995 ( salt_length + label_length + hash_length < hash_length );
Hanno Becker580fba12018-11-13 20:50:45 +00004996 if( overflow )
4997 return( PSA_ERROR_INVALID_ARGUMENT );
4998
4999 tls12_prf->Ai_with_seed = mbedtls_calloc( 1, Ai_with_seed_len );
5000 if( tls12_prf->Ai_with_seed == NULL )
5001 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5002 tls12_prf->Ai_with_seed_len = Ai_with_seed_len;
5003
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005004 /* Write `label + seed' at the end of the `A(i) + seed` buffer,
5005 * leaving the initial `hash_length` bytes unspecified for now. */
Hanno Becker353e4532018-11-15 09:53:57 +00005006 if( label_length != 0 )
5007 {
5008 memcpy( tls12_prf->Ai_with_seed + hash_length,
5009 label, label_length );
5010 }
5011
5012 if( salt_length != 0 )
5013 {
5014 memcpy( tls12_prf->Ai_with_seed + hash_length + label_length,
5015 salt, salt_length );
5016 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005017
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005018 /* The first block gets generated when
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005019 * psa_key_derivation_output_bytes() is called. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005020 tls12_prf->block_number = 0;
5021 tls12_prf->offset_in_block = hash_length;
5022
5023 return( PSA_SUCCESS );
5024}
Janos Follath71a4c912019-06-11 09:14:47 +01005025#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Becker1aaedc02018-11-16 11:35:34 +00005026
Janos Follath71a4c912019-06-11 09:14:47 +01005027#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005028/* Set up a TLS-1.2-PSK-to-MS-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005029static psa_status_t psa_key_derivation_tls12_psk_to_ms_setup(
5030 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005031 const uint8_t *psk,
Hanno Becker1aaedc02018-11-16 11:35:34 +00005032 size_t psk_len,
5033 psa_algorithm_t hash_alg,
5034 const uint8_t *salt,
5035 size_t salt_length,
5036 const uint8_t *label,
5037 size_t label_length )
5038{
5039 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005040 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
Hanno Becker1aaedc02018-11-16 11:35:34 +00005041
5042 if( psk_len > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5043 return( PSA_ERROR_INVALID_ARGUMENT );
5044
5045 /* Quoting RFC 4279, Section 2:
5046 *
5047 * The premaster secret is formed as follows: if the PSK is N octets
5048 * long, concatenate a uint16 with the value N, N zero octets, a second
5049 * uint16 with the value N, and the PSK itself.
5050 */
5051
5052 pms[0] = ( psk_len >> 8 ) & 0xff;
5053 pms[1] = ( psk_len >> 0 ) & 0xff;
5054 memset( pms + 2, 0, psk_len );
5055 pms[2 + psk_len + 0] = pms[0];
5056 pms[2 + psk_len + 1] = pms[1];
5057 memcpy( pms + 4 + psk_len, psk, psk_len );
5058
Gilles Peskinecbe66502019-05-16 16:59:18 +02005059 status = psa_key_derivation_tls12_prf_setup( tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005060 pms, 4 + 2 * psk_len,
5061 hash_alg,
5062 salt, salt_length,
5063 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005064
Gilles Peskine3f108122018-12-07 18:14:53 +01005065 mbedtls_platform_zeroize( pms, sizeof( pms ) );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005066 return( status );
5067}
Janos Follath71a4c912019-06-11 09:14:47 +01005068#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01005069#endif /* MBEDTLS_MD_C */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005070
Janos Follath71a4c912019-06-11 09:14:47 +01005071#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005072/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005073 * to potentially free embedded data structures and wipe confidential data.
5074 */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005075static psa_status_t psa_key_derivation_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005076 psa_key_derivation_operation_t *operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005077 const uint8_t *secret, size_t secret_length,
5078 psa_algorithm_t alg,
5079 const uint8_t *salt, size_t salt_length,
5080 const uint8_t *label, size_t label_length,
5081 size_t capacity )
5082{
5083 psa_status_t status;
5084 size_t max_capacity;
5085
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005086 /* Set operation->alg even on failure so that abort knows what to do. */
5087 operation->alg = alg;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005088
5089#if defined(MBEDTLS_MD_C)
5090 if( PSA_ALG_IS_HKDF( alg ) )
5091 {
5092 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5093 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5094 if( hash_size == 0 )
5095 return( PSA_ERROR_NOT_SUPPORTED );
5096 max_capacity = 255 * hash_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005097 status = psa_key_derivation_hkdf_setup( &operation->ctx.hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005098 secret, secret_length,
5099 hash_alg,
5100 salt, salt_length,
5101 label, label_length );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005102 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00005103 /* TLS-1.2 PRF and TLS-1.2 PSK-to-MS are very similar, so share code. */
5104 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
5105 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005106 {
5107 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5108 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5109
5110 /* TLS-1.2 PRF supports only SHA-256 and SHA-384. */
5111 if( hash_alg != PSA_ALG_SHA_256 &&
5112 hash_alg != PSA_ALG_SHA_384 )
5113 {
5114 return( PSA_ERROR_NOT_SUPPORTED );
5115 }
5116
5117 max_capacity = 255 * hash_size;
Hanno Becker1aaedc02018-11-16 11:35:34 +00005118
5119 if( PSA_ALG_IS_TLS12_PRF( alg ) )
5120 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005121 status = psa_key_derivation_tls12_prf_setup( &operation->ctx.tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005122 secret, secret_length,
5123 hash_alg, salt, salt_length,
5124 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005125 }
5126 else
5127 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02005128 status = psa_key_derivation_tls12_psk_to_ms_setup(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005129 &operation->ctx.tls12_prf,
Hanno Becker1aaedc02018-11-16 11:35:34 +00005130 secret, secret_length,
5131 hash_alg, salt, salt_length,
5132 label, label_length );
5133 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005134 }
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005135 else
5136#endif
5137 {
5138 return( PSA_ERROR_NOT_SUPPORTED );
5139 }
5140
5141 if( status != PSA_SUCCESS )
5142 return( status );
5143
5144 if( capacity <= max_capacity )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005145 operation->capacity = capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005146 else if( capacity == PSA_KEY_DERIVATION_UNLIMITED_CAPACITY )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005147 operation->capacity = max_capacity;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005148 else
5149 return( PSA_ERROR_INVALID_ARGUMENT );
5150
5151 return( PSA_SUCCESS );
5152}
Janos Follath71a4c912019-06-11 09:14:47 +01005153#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005154
Janos Follath71a4c912019-06-11 09:14:47 +01005155#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005156psa_status_t psa_key_derivation( psa_key_derivation_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01005157 psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +02005158 psa_algorithm_t alg,
5159 const uint8_t *salt,
5160 size_t salt_length,
5161 const uint8_t *label,
5162 size_t label_length,
5163 size_t capacity )
5164{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005165 psa_key_slot_t *slot;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005166 psa_status_t status;
5167
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005168 if( operation->alg != 0 )
Gilles Peskineea0fb492018-07-12 17:17:20 +02005169 return( PSA_ERROR_BAD_STATE );
5170
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005171 /* Make sure that alg is a key derivation algorithm. This prevents
5172 * key selection algorithms, which psa_key_derivation_internal
5173 * accepts for the sake of key agreement. */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005174 if( ! PSA_ALG_IS_KEY_DERIVATION( alg ) )
5175 return( PSA_ERROR_INVALID_ARGUMENT );
5176
Gilles Peskine28f8f302019-07-24 13:30:31 +02005177 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005178 if( status != PSA_SUCCESS )
5179 return( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005180
Gilles Peskine8e338702019-07-30 20:06:31 +02005181 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005182 return( PSA_ERROR_INVALID_ARGUMENT );
5183
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005184 status = psa_key_derivation_internal( operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005185 slot->data.raw.data,
5186 slot->data.raw.bytes,
5187 alg,
5188 salt, salt_length,
5189 label, label_length,
5190 capacity );
5191 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005192 psa_key_derivation_abort( operation );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005193 return( status );
5194}
Janos Follath71a4c912019-06-11 09:14:47 +01005195#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005196
Gilles Peskine969c5d62019-01-16 15:53:06 +01005197static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005198 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005199 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005200{
Janos Follath5fe19732019-06-20 15:09:30 +01005201 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5202 * initialisers for this union leave some bytes unspecified.) */
5203 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5204
Gilles Peskine969c5d62019-01-16 15:53:06 +01005205 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005206#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005207 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5208 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5209 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005210 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005211 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005212 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5213 if( hash_size == 0 )
5214 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005215 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5216 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005217 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005218 {
5219 return( PSA_ERROR_NOT_SUPPORTED );
5220 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005221 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005222 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005223 }
5224#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005225 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005226 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005227}
5228
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005229psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005230 psa_algorithm_t alg )
5231{
5232 psa_status_t status;
5233
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005234 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005235 return( PSA_ERROR_BAD_STATE );
5236
Gilles Peskine6843c292019-01-18 16:44:49 +01005237 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5238 return( PSA_ERROR_INVALID_ARGUMENT );
5239 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005240 {
5241 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005243 }
5244 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5245 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005246 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005247 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005248 else
5249 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005250
5251 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005252 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005253 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005254}
5255
5256#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005257static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005258 psa_algorithm_t hash_alg,
5259 psa_key_derivation_step_t step,
5260 const uint8_t *data,
5261 size_t data_length )
5262{
5263 psa_status_t status;
5264 switch( step )
5265 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005266 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005267 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005268 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005269 status = psa_hmac_setup_internal( &hkdf->hmac,
5270 data, data_length,
5271 hash_alg );
5272 if( status != PSA_SUCCESS )
5273 return( status );
5274 hkdf->state = HKDF_STATE_STARTED;
5275 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005276 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005277 /* If no salt was provided, use an empty salt. */
5278 if( hkdf->state == HKDF_STATE_INIT )
5279 {
5280 status = psa_hmac_setup_internal( &hkdf->hmac,
5281 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005282 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005283 if( status != PSA_SUCCESS )
5284 return( status );
5285 hkdf->state = HKDF_STATE_STARTED;
5286 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005287 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005288 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005289 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5290 data, data_length );
5291 if( status != PSA_SUCCESS )
5292 return( status );
5293 status = psa_hmac_finish_internal( &hkdf->hmac,
5294 hkdf->prk,
5295 sizeof( hkdf->prk ) );
5296 if( status != PSA_SUCCESS )
5297 return( status );
5298 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5299 hkdf->block_number = 0;
5300 hkdf->state = HKDF_STATE_KEYED;
5301 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005302 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005303 if( hkdf->state == HKDF_STATE_OUTPUT )
5304 return( PSA_ERROR_BAD_STATE );
5305 if( hkdf->info_set )
5306 return( PSA_ERROR_BAD_STATE );
5307 hkdf->info_length = data_length;
5308 if( data_length != 0 )
5309 {
5310 hkdf->info = mbedtls_calloc( 1, data_length );
5311 if( hkdf->info == NULL )
5312 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5313 memcpy( hkdf->info, data, data_length );
5314 }
5315 hkdf->info_set = 1;
5316 return( PSA_SUCCESS );
5317 default:
5318 return( PSA_ERROR_INVALID_ARGUMENT );
5319 }
5320}
Janos Follathb03233e2019-06-11 15:30:30 +01005321
5322#if defined(PSA_PRE_1_0_KEY_DERIVATION)
5323static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5324 psa_algorithm_t hash_alg,
5325 psa_key_derivation_step_t step,
5326 const uint8_t *data,
5327 size_t data_length )
5328{
5329 (void) prf;
5330 (void) hash_alg;
5331 (void) step;
5332 (void) data;
5333 (void) data_length;
5334
5335 return( PSA_ERROR_INVALID_ARGUMENT );
5336}
Janos Follath6660f0e2019-06-17 08:44:03 +01005337
5338static psa_status_t psa_tls12_prf_psk_to_ms_input(
5339 psa_tls12_prf_key_derivation_t *prf,
5340 psa_algorithm_t hash_alg,
5341 psa_key_derivation_step_t step,
5342 const uint8_t *data,
5343 size_t data_length )
5344{
5345 (void) prf;
5346 (void) hash_alg;
5347 (void) step;
5348 (void) data;
5349 (void) data_length;
5350
5351 return( PSA_ERROR_INVALID_ARGUMENT );
5352}
Janos Follathb03233e2019-06-11 15:30:30 +01005353#else
Janos Follathf08e2652019-06-13 09:05:41 +01005354static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5355 const uint8_t *data,
5356 size_t data_length )
5357{
5358 if( prf->state != TLS12_PRF_STATE_INIT )
5359 return( PSA_ERROR_BAD_STATE );
5360
Janos Follathd6dce9f2019-07-04 09:11:38 +01005361 if( data_length != 0 )
5362 {
5363 prf->seed = mbedtls_calloc( 1, data_length );
5364 if( prf->seed == NULL )
5365 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005366
Janos Follathd6dce9f2019-07-04 09:11:38 +01005367 memcpy( prf->seed, data, data_length );
5368 prf->seed_length = data_length;
5369 }
Janos Follathf08e2652019-06-13 09:05:41 +01005370
5371 prf->state = TLS12_PRF_STATE_SEED_SET;
5372
5373 return( PSA_SUCCESS );
5374}
5375
Janos Follath81550542019-06-13 14:26:34 +01005376static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5377 psa_algorithm_t hash_alg,
5378 const uint8_t *data,
5379 size_t data_length )
5380{
5381 psa_status_t status;
5382 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5383 return( PSA_ERROR_BAD_STATE );
5384
5385 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5386 if( status != PSA_SUCCESS )
5387 return( status );
5388
5389 prf->state = TLS12_PRF_STATE_KEY_SET;
5390
5391 return( PSA_SUCCESS );
5392}
5393
Janos Follath6660f0e2019-06-17 08:44:03 +01005394static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5395 psa_tls12_prf_key_derivation_t *prf,
5396 psa_algorithm_t hash_alg,
5397 const uint8_t *data,
5398 size_t data_length )
5399{
5400 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005401 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5402 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005403
5404 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5405 return( PSA_ERROR_INVALID_ARGUMENT );
5406
5407 /* Quoting RFC 4279, Section 2:
5408 *
5409 * The premaster secret is formed as follows: if the PSK is N octets
5410 * long, concatenate a uint16 with the value N, N zero octets, a second
5411 * uint16 with the value N, and the PSK itself.
5412 */
5413
Janos Follath40e13932019-06-26 13:22:29 +01005414 *cur++ = ( data_length >> 8 ) & 0xff;
5415 *cur++ = ( data_length >> 0 ) & 0xff;
5416 memset( cur, 0, data_length );
5417 cur += data_length;
5418 *cur++ = pms[0];
5419 *cur++ = pms[1];
5420 memcpy( cur, data, data_length );
5421 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005422
Janos Follath40e13932019-06-26 13:22:29 +01005423 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005424
5425 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5426 return( status );
5427}
5428
Janos Follath63028dd2019-06-13 09:15:47 +01005429static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5430 const uint8_t *data,
5431 size_t data_length )
5432{
5433 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5434 return( PSA_ERROR_BAD_STATE );
5435
Janos Follathd6dce9f2019-07-04 09:11:38 +01005436 if( data_length != 0 )
5437 {
5438 prf->label = mbedtls_calloc( 1, data_length );
5439 if( prf->label == NULL )
5440 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005441
Janos Follathd6dce9f2019-07-04 09:11:38 +01005442 memcpy( prf->label, data, data_length );
5443 prf->label_length = data_length;
5444 }
Janos Follath63028dd2019-06-13 09:15:47 +01005445
5446 prf->state = TLS12_PRF_STATE_LABEL_SET;
5447
5448 return( PSA_SUCCESS );
5449}
5450
Janos Follathb03233e2019-06-11 15:30:30 +01005451static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5452 psa_algorithm_t hash_alg,
5453 psa_key_derivation_step_t step,
5454 const uint8_t *data,
5455 size_t data_length )
5456{
Janos Follathb03233e2019-06-11 15:30:30 +01005457 switch( step )
5458 {
Janos Follathf08e2652019-06-13 09:05:41 +01005459 case PSA_KEY_DERIVATION_INPUT_SEED:
5460 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005461 case PSA_KEY_DERIVATION_INPUT_SECRET:
5462 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005463 case PSA_KEY_DERIVATION_INPUT_LABEL:
5464 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005465 default:
5466 return( PSA_ERROR_INVALID_ARGUMENT );
5467 }
5468}
Janos Follath6660f0e2019-06-17 08:44:03 +01005469
5470static psa_status_t psa_tls12_prf_psk_to_ms_input(
5471 psa_tls12_prf_key_derivation_t *prf,
5472 psa_algorithm_t hash_alg,
5473 psa_key_derivation_step_t step,
5474 const uint8_t *data,
5475 size_t data_length )
5476{
5477 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005478 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005479 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5480 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005481 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005482
5483 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5484}
Janos Follathb03233e2019-06-11 15:30:30 +01005485#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005486#endif /* MBEDTLS_MD_C */
5487
Janos Follathb80a94e2019-06-12 15:54:46 +01005488static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005489 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005490 psa_key_derivation_step_t step,
5491 const uint8_t *data,
5492 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005493{
5494 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005495 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005496
5497#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005498 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005499 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005500 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005501 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005502 step, data, data_length );
5503 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005504 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005505#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005506#if defined(MBEDTLS_MD_C)
Janos Follath6660f0e2019-06-17 08:44:03 +01005507 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005508 {
Janos Follathb03233e2019-06-11 15:30:30 +01005509 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5510 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5511 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005512 }
5513 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5514 {
5515 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5516 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5517 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005518 }
5519 else
5520#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005521 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005522 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005523 return( PSA_ERROR_BAD_STATE );
5524 }
5525
5526 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005527 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005528 return( status );
5529}
5530
Janos Follath51f4a0f2019-06-14 11:35:55 +01005531psa_status_t psa_key_derivation_input_bytes(
5532 psa_key_derivation_operation_t *operation,
5533 psa_key_derivation_step_t step,
5534 const uint8_t *data,
5535 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005536{
Janos Follathc5621512019-06-14 11:27:57 +01005537 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5538 return( PSA_ERROR_INVALID_ARGUMENT );
5539
5540 return( psa_key_derivation_input_internal( operation, step,
5541 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005542}
5543
Janos Follath51f4a0f2019-06-14 11:35:55 +01005544psa_status_t psa_key_derivation_input_key(
5545 psa_key_derivation_operation_t *operation,
5546 psa_key_derivation_step_t step,
5547 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005548{
5549 psa_key_slot_t *slot;
5550 psa_status_t status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02005551 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005552 PSA_KEY_USAGE_DERIVE,
5553 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005554 if( status != PSA_SUCCESS )
5555 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02005556 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005557 return( PSA_ERROR_INVALID_ARGUMENT );
5558 /* Don't allow a key to be used as an input that is usually public.
5559 * This is debatable. It's ok from a cryptographic perspective to
5560 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005561 * the material should be dedicated to a particular input step,
5562 * otherwise this may allow the key to be used in an unintended way
5563 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005564 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005565 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005566 return( psa_key_derivation_input_internal( operation,
5567 step,
5568 slot->data.raw.data,
5569 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005570}
5571
Gilles Peskineea0fb492018-07-12 17:17:20 +02005572
5573
5574/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005575/* Key agreement */
5576/****************************************************************/
5577
Gilles Peskinea05219c2018-11-16 16:02:56 +01005578#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005579static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5580 size_t peer_key_length,
5581 const mbedtls_ecp_keypair *our_key,
5582 uint8_t *shared_secret,
5583 size_t shared_secret_size,
5584 size_t *shared_secret_length )
5585{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005586 mbedtls_ecp_keypair *their_key = NULL;
5587 mbedtls_ecdh_context ecdh;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005588 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005589 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005590
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005591 status = psa_import_ec_public_key(
5592 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5593 peer_key, peer_key_length,
5594 &their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005595 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005596 goto exit;
Gilles Peskineb4086612018-11-14 20:51:23 +01005597
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005598 status = mbedtls_to_psa_error(
5599 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5600 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005601 goto exit;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005602 status = mbedtls_to_psa_error(
5603 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5604 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005605 goto exit;
5606
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005607 status = mbedtls_to_psa_error(
5608 mbedtls_ecdh_calc_secret( &ecdh,
5609 shared_secret_length,
5610 shared_secret, shared_secret_size,
5611 mbedtls_ctr_drbg_random,
5612 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005613
5614exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005615 mbedtls_ecdh_free( &ecdh );
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005616 mbedtls_ecp_keypair_free( their_key );
5617 mbedtls_free( their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005618 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005619}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005620#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005621
Gilles Peskine01d718c2018-09-18 12:01:02 +02005622#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5623
Gilles Peskine0216fe12019-04-11 21:23:21 +02005624static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5625 psa_key_slot_t *private_key,
5626 const uint8_t *peer_key,
5627 size_t peer_key_length,
5628 uint8_t *shared_secret,
5629 size_t shared_secret_size,
5630 size_t *shared_secret_length )
5631{
5632 switch( alg )
5633 {
5634#if defined(MBEDTLS_ECDH_C)
5635 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005636 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005637 return( PSA_ERROR_INVALID_ARGUMENT );
5638 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5639 private_key->data.ecp,
5640 shared_secret, shared_secret_size,
5641 shared_secret_length ) );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005642#endif /* MBEDTLS_ECDH_C */
5643 default:
5644 (void) private_key;
5645 (void) peer_key;
5646 (void) peer_key_length;
5647 (void) shared_secret;
5648 (void) shared_secret_size;
5649 (void) shared_secret_length;
5650 return( PSA_ERROR_NOT_SUPPORTED );
5651 }
5652}
5653
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005654/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005655 * to potentially free embedded data structures and wipe confidential data.
5656 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005657static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005658 psa_key_derivation_step_t step,
Gilles Peskine2f060a82018-12-04 17:12:32 +01005659 psa_key_slot_t *private_key,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005660 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005661 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005662{
5663 psa_status_t status;
5664 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5665 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005666 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005667
5668 /* Step 1: run the secret agreement algorithm to generate the shared
5669 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005670 status = psa_key_agreement_raw_internal( ka_alg,
5671 private_key,
5672 peer_key, peer_key_length,
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005673 shared_secret,
5674 sizeof( shared_secret ),
5675 &shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005676 if( status != PSA_SUCCESS )
5677 goto exit;
5678
5679 /* Step 2: set up the key derivation to generate key material from
5680 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005681 status = psa_key_derivation_input_internal( operation, step,
5682 shared_secret,
5683 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005684
Gilles Peskine01d718c2018-09-18 12:01:02 +02005685exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005686 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005687 return( status );
5688}
5689
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005690psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005691 psa_key_derivation_step_t step,
5692 psa_key_handle_t private_key,
5693 const uint8_t *peer_key,
5694 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005695{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005696 psa_key_slot_t *slot;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005697 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005698 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005699 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005700 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005701 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005702 if( status != PSA_SUCCESS )
5703 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005704 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005705 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005706 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005707 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005708 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005709 return( status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005710}
5711
Gilles Peskinebe697d82019-05-16 18:00:41 +02005712psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5713 psa_key_handle_t private_key,
5714 const uint8_t *peer_key,
5715 size_t peer_key_length,
5716 uint8_t *output,
5717 size_t output_size,
5718 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005719{
5720 psa_key_slot_t *slot;
5721 psa_status_t status;
5722
5723 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5724 {
5725 status = PSA_ERROR_INVALID_ARGUMENT;
5726 goto exit;
5727 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005728 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005729 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005730 if( status != PSA_SUCCESS )
5731 goto exit;
5732
5733 status = psa_key_agreement_raw_internal( alg, slot,
5734 peer_key, peer_key_length,
5735 output, output_size,
5736 output_length );
5737
5738exit:
5739 if( status != PSA_SUCCESS )
5740 {
5741 /* If an error happens and is not handled properly, the output
5742 * may be used as a key to protect sensitive data. Arrange for such
5743 * a key to be random, which is likely to result in decryption or
5744 * verification errors. This is better than filling the buffer with
5745 * some constant data such as zeros, which would result in the data
5746 * being protected with a reproducible, easily knowable key.
5747 */
5748 psa_generate_random( output, output_size );
5749 *output_length = output_size;
5750 }
5751 return( status );
5752}
Gilles Peskine01d718c2018-09-18 12:01:02 +02005753
5754
5755/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005756/* Random generation */
Gilles Peskine05d69892018-06-19 22:00:52 +02005757/****************************************************************/
5758
5759psa_status_t psa_generate_random( uint8_t *output,
5760 size_t output_size )
5761{
itayzafrir0adf0fc2018-09-06 16:24:41 +03005762 int ret;
5763 GUARD_MODULE_INITIALIZED;
5764
Gilles Peskinef181eca2019-08-07 13:49:00 +02005765 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5766 {
5767 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5768 output,
5769 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5770 if( ret != 0 )
5771 return( mbedtls_to_psa_error( ret ) );
5772 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5773 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5774 }
5775
itayzafrir0adf0fc2018-09-06 16:24:41 +03005776 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
Gilles Peskine05d69892018-06-19 22:00:52 +02005777 return( mbedtls_to_psa_error( ret ) );
5778}
5779
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005780#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5781#include "mbedtls/entropy_poll.h"
avolinski13beb102018-11-20 16:51:49 +02005782
Gilles Peskine7228da22019-07-15 11:06:15 +02005783psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005784 size_t seed_size )
5785{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005786 if( global_data.initialized )
5787 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005788
5789 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5790 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5791 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5792 return( PSA_ERROR_INVALID_ARGUMENT );
5793
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005794 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005795}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005796#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005797
Gilles Peskinee56e8782019-04-26 17:34:02 +02005798#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5799static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5800 size_t domain_parameters_size,
5801 int *exponent )
5802{
5803 size_t i;
5804 uint32_t acc = 0;
5805
5806 if( domain_parameters_size == 0 )
5807 {
5808 *exponent = 65537;
5809 return( PSA_SUCCESS );
5810 }
5811
5812 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5813 * support values that fit in a 32-bit integer, which is larger than
5814 * int on just about every platform anyway. */
5815 if( domain_parameters_size > sizeof( acc ) )
5816 return( PSA_ERROR_NOT_SUPPORTED );
5817 for( i = 0; i < domain_parameters_size; i++ )
5818 acc = ( acc << 8 ) | domain_parameters[i];
5819 if( acc > INT_MAX )
5820 return( PSA_ERROR_NOT_SUPPORTED );
5821 *exponent = acc;
5822 return( PSA_SUCCESS );
5823}
5824#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5825
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005826static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005827 psa_key_slot_t *slot, size_t bits,
5828 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskine05d69892018-06-19 22:00:52 +02005829{
Gilles Peskine8e338702019-07-30 20:06:31 +02005830 psa_key_type_t type = slot->attr.type;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005831
Gilles Peskinee56e8782019-04-26 17:34:02 +02005832 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005833 return( PSA_ERROR_INVALID_ARGUMENT );
5834
Gilles Peskine48c0ea12018-06-21 14:15:31 +02005835 if( key_type_is_raw_bytes( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005836 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005837 psa_status_t status;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005838 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005839 if( status != PSA_SUCCESS )
5840 return( status );
5841 status = psa_generate_random( slot->data.raw.data,
5842 slot->data.raw.bytes );
5843 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005844 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005845#if defined(MBEDTLS_DES_C)
5846 if( type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005847 psa_des_set_key_parity( slot->data.raw.data,
5848 slot->data.raw.bytes );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005849#endif /* MBEDTLS_DES_C */
5850 }
5851 else
5852
5853#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005854 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005855 {
5856 mbedtls_rsa_context *rsa;
5857 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005858 int exponent;
5859 psa_status_t status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005860 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5861 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine86a440b2018-11-12 18:39:40 +01005862 /* Accept only byte-aligned keys, for the same reasons as
5863 * in psa_import_rsa_key(). */
5864 if( bits % 8 != 0 )
5865 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005866 status = psa_read_rsa_exponent( domain_parameters,
5867 domain_parameters_size,
5868 &exponent );
5869 if( status != PSA_SUCCESS )
5870 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005871 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5872 if( rsa == NULL )
5873 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5874 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5875 ret = mbedtls_rsa_gen_key( rsa,
5876 mbedtls_ctr_drbg_random,
5877 &global_data.ctr_drbg,
Jaeden Amero23bbb752018-06-26 14:16:54 +01005878 (unsigned int) bits,
Gilles Peskine12313cd2018-06-20 00:20:32 +02005879 exponent );
5880 if( ret != 0 )
5881 {
5882 mbedtls_rsa_free( rsa );
5883 mbedtls_free( rsa );
5884 return( mbedtls_to_psa_error( ret ) );
5885 }
5886 slot->data.rsa = rsa;
5887 }
5888 else
5889#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5890
5891#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005892 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005893 {
5894 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5895 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5896 const mbedtls_ecp_curve_info *curve_info =
5897 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5898 mbedtls_ecp_keypair *ecp;
5899 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005900 if( domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005901 return( PSA_ERROR_NOT_SUPPORTED );
5902 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5903 return( PSA_ERROR_NOT_SUPPORTED );
5904 if( curve_info->bit_size != bits )
5905 return( PSA_ERROR_INVALID_ARGUMENT );
5906 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5907 if( ecp == NULL )
5908 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5909 mbedtls_ecp_keypair_init( ecp );
5910 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5911 mbedtls_ctr_drbg_random,
5912 &global_data.ctr_drbg );
5913 if( ret != 0 )
5914 {
5915 mbedtls_ecp_keypair_free( ecp );
5916 mbedtls_free( ecp );
5917 return( mbedtls_to_psa_error( ret ) );
5918 }
5919 slot->data.ecp = ecp;
5920 }
5921 else
5922#endif /* MBEDTLS_ECP_C */
5923
5924 return( PSA_ERROR_NOT_SUPPORTED );
5925
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005926 return( PSA_SUCCESS );
5927}
5928
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005929psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005930 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005931{
5932 psa_status_t status;
5933 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005934 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinedf179142019-07-15 22:02:14 +02005935 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
5936 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005937#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5938 if( driver != NULL )
5939 {
5940 /* Generating a key in a secure element is not implemented yet. */
5941 status = PSA_ERROR_NOT_SUPPORTED;
5942 }
5943#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005944 if( status == PSA_SUCCESS )
5945 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005946 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005947 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005948 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005949 }
5950 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005951 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005952 if( status != PSA_SUCCESS )
5953 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005954 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005955 *handle = 0;
5956 }
5957 return( status );
5958}
5959
5960
Gilles Peskine05d69892018-06-19 22:00:52 +02005961
5962/****************************************************************/
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01005963/* Module setup */
5964/****************************************************************/
5965
Gilles Peskine5e769522018-11-20 21:59:56 +01005966psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5967 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5968 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5969{
5970 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5971 return( PSA_ERROR_BAD_STATE );
5972 global_data.entropy_init = entropy_init;
5973 global_data.entropy_free = entropy_free;
5974 return( PSA_SUCCESS );
5975}
5976
Gilles Peskinee59236f2018-01-27 23:32:46 +01005977void mbedtls_psa_crypto_free( void )
5978{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005979 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005980 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5981 {
5982 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005983 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005984 }
5985 /* Wipe all remaining data, including configuration.
5986 * In particular, this sets all state indicator to the value
5987 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005988 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005989#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005990 /* Unregister all secure element drivers, so that we restart from
5991 * a pristine state. */
5992 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005993#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005994}
5995
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005996#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5997/** Recover a transaction that was interrupted by a power failure.
5998 *
5999 * This function is called during initialization, before psa_crypto_init()
6000 * returns. If this function returns a failure status, the initialization
6001 * fails.
6002 */
6003static psa_status_t psa_crypto_recover_transaction(
6004 const psa_crypto_transaction_t *transaction )
6005{
6006 switch( transaction->unknown.type )
6007 {
6008 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6009 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
6010 /* TOnogrepDO - fall through to the failure case until this
6011 * is implemented */
6012 default:
6013 /* We found an unsupported transaction in the storage.
6014 * We don't know what state the storage is in. Give up. */
6015 return( PSA_ERROR_STORAGE_FAILURE );
6016 }
6017}
6018#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6019
Gilles Peskinee59236f2018-01-27 23:32:46 +01006020psa_status_t psa_crypto_init( void )
6021{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006022 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006023 const unsigned char drbg_seed[] = "PSA";
6024
Gilles Peskinec6b69072018-11-20 21:42:52 +01006025 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006026 if( global_data.initialized != 0 )
6027 return( PSA_SUCCESS );
6028
Gilles Peskine5e769522018-11-20 21:59:56 +01006029 /* Set default configuration if
6030 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6031 if( global_data.entropy_init == NULL )
6032 global_data.entropy_init = mbedtls_entropy_init;
6033 if( global_data.entropy_free == NULL )
6034 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006035
Gilles Peskinec6b69072018-11-20 21:42:52 +01006036 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006037 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006038#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6039 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6040 /* The PSA entropy injection feature depends on using NV seed as an entropy
6041 * source. Add NV seed as an entropy source for PSA entropy injection. */
6042 mbedtls_entropy_add_source( &global_data.entropy,
6043 mbedtls_nv_seed_poll, NULL,
6044 MBEDTLS_ENTROPY_BLOCK_SIZE,
6045 MBEDTLS_ENTROPY_SOURCE_STRONG );
6046#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006047 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006048 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006049 status = mbedtls_to_psa_error(
6050 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6051 mbedtls_entropy_func,
6052 &global_data.entropy,
6053 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6054 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006055 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006056 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006057
Gilles Peskine66fb1262018-12-10 16:29:04 +01006058 status = psa_initialize_key_slots( );
6059 if( status != PSA_SUCCESS )
6060 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006061
Gilles Peskine4b734222019-07-24 15:56:31 +02006062#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006063 status = psa_crypto_load_transaction( );
6064 if( status == PSA_SUCCESS )
6065 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006066 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6067 if( status != PSA_SUCCESS )
6068 goto exit;
6069 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006070 }
6071 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6072 {
6073 /* There's no transaction to complete. It's all good. */
6074 status = PSA_SUCCESS;
6075 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006076#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006077
Gilles Peskinec6b69072018-11-20 21:42:52 +01006078 /* All done. */
Gilles Peskinee4ebc122018-03-07 14:16:44 +01006079 global_data.initialized = 1;
6080
Gilles Peskinee59236f2018-01-27 23:32:46 +01006081exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006082 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006083 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006084 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006085}
6086
6087#endif /* MBEDTLS_PSA_CRYPTO_C */