blob: 59edae1cd16bb35fb0b99cdbfc3521bd44d36dd3 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
4/* Copyright (C) 2018, ARM Limited, All Rights Reserved
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS (https://tls.mbed.org)
20 */
21
22#if !defined(MBEDTLS_CONFIG_FILE)
23#include "mbedtls/config.h"
24#else
25#include MBEDTLS_CONFIG_FILE
26#endif
27
28#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030029
itayzafrir7723ab12019-02-14 10:28:02 +020030#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031#include "psa/crypto.h"
32
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020036#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010038#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010039/* Include internal declarations that are useful for implementing persistently
40 * stored keys. */
41#include "psa_crypto_storage.h"
42
Gilles Peskineb46bef22019-07-30 21:32:04 +020043#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include <stdlib.h>
45#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010046#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020047#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#define mbedtls_calloc calloc
49#define mbedtls_free free
50#endif
51
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020053#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000054#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020055#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/blowfish.h"
57#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020058#include "mbedtls/chacha20.h"
59#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/cipher.h"
61#include "mbedtls/ccm.h"
62#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020065#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010067#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/error.h"
69#include "mbedtls/gcm.h"
70#include "mbedtls/md2.h"
71#include "mbedtls/md4.h"
72#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010073#include "mbedtls/md.h"
74#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010075#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010077#include "mbedtls/platform_util.h"
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)
164 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
165#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)
174 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
175#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:
454#if defined(MBEDTLS_MD_C)
455 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200456#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200457 case PSA_KEY_TYPE_DERIVE:
458 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200459#if defined(MBEDTLS_AES_C)
460 case PSA_KEY_TYPE_AES:
461 if( bits != 128 && bits != 192 && bits != 256 )
462 return( PSA_ERROR_INVALID_ARGUMENT );
463 break;
464#endif
465#if defined(MBEDTLS_CAMELLIA_C)
466 case PSA_KEY_TYPE_CAMELLIA:
467 if( bits != 128 && bits != 192 && bits != 256 )
468 return( PSA_ERROR_INVALID_ARGUMENT );
469 break;
470#endif
471#if defined(MBEDTLS_DES_C)
472 case PSA_KEY_TYPE_DES:
473 if( bits != 64 && bits != 128 && bits != 192 )
474 return( PSA_ERROR_INVALID_ARGUMENT );
475 break;
476#endif
477#if defined(MBEDTLS_ARC4_C)
478 case PSA_KEY_TYPE_ARC4:
479 if( bits < 8 || bits > 2048 )
480 return( PSA_ERROR_INVALID_ARGUMENT );
481 break;
482#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200483#if defined(MBEDTLS_CHACHA20_C)
484 case PSA_KEY_TYPE_CHACHA20:
485 if( bits != 256 )
486 return( PSA_ERROR_INVALID_ARGUMENT );
487 break;
488#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200489 default:
490 return( PSA_ERROR_NOT_SUPPORTED );
491 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200492 if( bits % 8 != 0 )
493 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200494
495 /* Allocate memory for the key */
496 raw->bytes = PSA_BITS_TO_BYTES( bits );
497 raw->data = mbedtls_calloc( 1, raw->bytes );
498 if( raw->data == NULL )
499 {
500 raw->bytes = 0;
501 return( PSA_ERROR_INSUFFICIENT_MEMORY );
502 }
503 return( PSA_SUCCESS );
504}
505
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200506#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100507/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
508 * that are not a multiple of 8) well. For example, there is only
509 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
510 * way to return the exact bit size of a key.
511 * To keep things simple, reject non-byte-aligned key sizes. */
512static psa_status_t psa_check_rsa_key_byte_aligned(
513 const mbedtls_rsa_context *rsa )
514{
515 mbedtls_mpi n;
516 psa_status_t status;
517 mbedtls_mpi_init( &n );
518 status = mbedtls_to_psa_error(
519 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
520 if( status == PSA_SUCCESS )
521 {
522 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
523 status = PSA_ERROR_NOT_SUPPORTED;
524 }
525 mbedtls_mpi_free( &n );
526 return( status );
527}
528
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000529static psa_status_t psa_import_rsa_key( psa_key_type_t type,
530 const uint8_t *data,
531 size_t data_length,
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200532 mbedtls_rsa_context **p_rsa )
533{
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000534 psa_status_t status;
535 mbedtls_pk_context pk;
536 mbedtls_rsa_context *rsa;
537 size_t bits;
538
539 mbedtls_pk_init( &pk );
540
541 /* Parse the data. */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200542 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000543 status = mbedtls_to_psa_error(
544 mbedtls_pk_parse_key( &pk, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200545 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
547 mbedtls_pk_parse_public_key( &pk, data, data_length ) );
548 if( status != PSA_SUCCESS )
549 goto exit;
550
551 /* We have something that the pkparse module recognizes. If it is a
552 * valid RSA key, store it. */
553 if( mbedtls_pk_get_type( &pk ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200554 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555 status = PSA_ERROR_INVALID_ARGUMENT;
556 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558
559 rsa = mbedtls_pk_rsa( pk );
560 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
561 * supports non-byte-aligned key sizes, but not well. For example,
562 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
563 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
564 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
565 {
566 status = PSA_ERROR_NOT_SUPPORTED;
567 goto exit;
568 }
569 status = psa_check_rsa_key_byte_aligned( rsa );
570
571exit:
572 /* Free the content of the pk object only on error. */
573 if( status != PSA_SUCCESS )
574 {
575 mbedtls_pk_free( &pk );
576 return( status );
577 }
578
579 /* On success, store the content of the object in the RSA context. */
580 *p_rsa = rsa;
581
582 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200583}
584#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
585
Jaeden Ameroccdce902019-01-10 11:42:27 +0000586#if defined(MBEDTLS_ECP_C)
Gilles Peskine4cd32772019-12-02 20:49:42 +0100587static psa_status_t psa_prepare_import_ec_key( psa_ecc_curve_t curve,
588 mbedtls_ecp_keypair **p_ecp )
589{
590 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
591 *p_ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
592 if( *p_ecp == NULL )
593 return( PSA_ERROR_INSUFFICIENT_MEMORY );
594 mbedtls_ecp_keypair_init( *p_ecp );
595
596 /* Load the group. */
597 grp_id = mbedtls_ecc_group_of_psa( curve );
598 return( mbedtls_to_psa_error(
599 mbedtls_ecp_group_load( &( *p_ecp )->grp, grp_id ) ) );
600}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000601
602/* Import a public key given as the uncompressed representation defined by SEC1
603 * 2.3.3 as the content of an ECPoint. */
604static psa_status_t psa_import_ec_public_key( psa_ecc_curve_t curve,
605 const uint8_t *data,
606 size_t data_length,
607 mbedtls_ecp_keypair **p_ecp )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200608{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200609 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000610 mbedtls_ecp_keypair *ecp = NULL;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000611
Gilles Peskine4cd32772019-12-02 20:49:42 +0100612 status = psa_prepare_import_ec_key( curve, &ecp );
Jaeden Ameroccdce902019-01-10 11:42:27 +0000613 if( status != PSA_SUCCESS )
614 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100615
Jaeden Ameroccdce902019-01-10 11:42:27 +0000616 /* Load the public value. */
617 status = mbedtls_to_psa_error(
618 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
619 data, data_length ) );
620 if( status != PSA_SUCCESS )
621 goto exit;
622
623 /* Check that the point is on the curve. */
624 status = mbedtls_to_psa_error(
625 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
626 if( status != PSA_SUCCESS )
627 goto exit;
628
629 *p_ecp = ecp;
630 return( PSA_SUCCESS );
631
632exit:
633 if( ecp != NULL )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200634 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000635 mbedtls_ecp_keypair_free( ecp );
636 mbedtls_free( ecp );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200637 }
Jaeden Ameroccdce902019-01-10 11:42:27 +0000638 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200639}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200640
Gilles Peskinef76aa772018-10-29 19:24:33 +0100641/* Import a private key given as a byte string which is the private value
642 * in big-endian order. */
643static psa_status_t psa_import_ec_private_key( psa_ecc_curve_t curve,
644 const uint8_t *data,
645 size_t data_length,
646 mbedtls_ecp_keypair **p_ecp )
647{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200648 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100649 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100650
Gilles Peskine2c86ebc2019-05-13 14:21:57 +0200651 if( PSA_BITS_TO_BYTES( PSA_ECC_CURVE_BITS( curve ) ) != data_length )
652 return( PSA_ERROR_INVALID_ARGUMENT );
653
Gilles Peskine4cd32772019-12-02 20:49:42 +0100654 status = psa_prepare_import_ec_key( curve, &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100655 if( status != PSA_SUCCESS )
656 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100657
Gilles Peskinef76aa772018-10-29 19:24:33 +0100658 /* Load the secret value. */
659 status = mbedtls_to_psa_error(
660 mbedtls_mpi_read_binary( &ecp->d, data, data_length ) );
661 if( status != PSA_SUCCESS )
662 goto exit;
663 /* Validate the private key. */
664 status = mbedtls_to_psa_error(
665 mbedtls_ecp_check_privkey( &ecp->grp, &ecp->d ) );
666 if( status != PSA_SUCCESS )
667 goto exit;
668 /* Calculate the public key from the private key. */
669 status = mbedtls_to_psa_error(
670 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
671 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
672 if( status != PSA_SUCCESS )
673 goto exit;
674
675 *p_ecp = ecp;
676 return( PSA_SUCCESS );
677
678exit:
679 if( ecp != NULL )
680 {
681 mbedtls_ecp_keypair_free( ecp );
682 mbedtls_free( ecp );
683 }
684 return( status );
685}
686#endif /* defined(MBEDTLS_ECP_C) */
687
Gilles Peskineb46bef22019-07-30 21:32:04 +0200688
689/** Return the size of the key in the given slot, in bits.
690 *
691 * \param[in] slot A key slot.
692 *
693 * \return The key size in bits, read from the metadata in the slot.
694 */
695static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
696{
697 return( slot->attr.bits );
698}
699
700/** Calculate the size of the key in the given slot, in bits.
701 *
702 * \param[in] slot A key slot containing a transparent key.
703 *
704 * \return The key size in bits, calculated from the key data.
705 */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200706static psa_key_bits_t psa_calculate_key_bits( const psa_key_slot_t *slot )
Gilles Peskineb46bef22019-07-30 21:32:04 +0200707{
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200708 size_t bits = 0; /* return 0 on an empty slot */
709
Gilles Peskineb46bef22019-07-30 21:32:04 +0200710 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200711 bits = PSA_BYTES_TO_BITS( slot->data.raw.bytes );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200712#if defined(MBEDTLS_RSA_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200713 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
714 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200715#endif /* defined(MBEDTLS_RSA_C) */
716#if defined(MBEDTLS_ECP_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200717 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
718 bits = slot->data.ecp->grp.pbits;
Gilles Peskineb46bef22019-07-30 21:32:04 +0200719#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200720
721 /* We know that the size fits in psa_key_bits_t thanks to checks
722 * when the key was created. */
723 return( (psa_key_bits_t) bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200724}
725
Gilles Peskine8e338702019-07-30 20:06:31 +0200726/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100727 * previously. This function assumes that the slot does not contain
728 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100729psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
730 const uint8_t *data,
731 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100732{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200733 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100734
Gilles Peskine8e338702019-07-30 20:06:31 +0200735 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100736 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200737 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200738 /* Ensure that the bytes-to-bit conversion didn't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100739 if( data_length > SIZE_MAX / 8 )
740 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200741 /* Enforce a size limit, and in particular ensure that the bit
742 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200743 if( bit_size > PSA_MAX_KEY_BITS )
744 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine8e338702019-07-30 20:06:31 +0200745 status = prepare_raw_data_slot( slot->attr.type, bit_size,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200746 &slot->data.raw );
747 if( status != PSA_SUCCESS )
748 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200749 if( data_length != 0 )
750 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100751 }
752 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100753#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200754 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100755 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200756 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100757 data, data_length,
758 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100759 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200760 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100761 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000762 status = psa_import_ec_public_key(
Gilles Peskine8e338702019-07-30 20:06:31 +0200763 PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Jaeden Ameroccdce902019-01-10 11:42:27 +0000764 data, data_length,
765 &slot->data.ecp );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100766 }
767 else
Gilles Peskine969ac722018-01-28 18:16:59 +0100768#endif /* MBEDTLS_ECP_C */
Jaeden Ameroccdce902019-01-10 11:42:27 +0000769#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200770 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100771 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200772 status = psa_import_rsa_key( slot->attr.type,
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000773 data, data_length,
774 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100775 }
776 else
Jaeden Ameroccdce902019-01-10 11:42:27 +0000777#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100778 {
779 return( PSA_ERROR_NOT_SUPPORTED );
780 }
Darryl Green940d72c2018-07-13 13:18:51 +0100781
Gilles Peskineb46bef22019-07-30 21:32:04 +0200782 if( status == PSA_SUCCESS )
783 {
784 /* Write the actual key size to the slot.
785 * psa_start_key_creation() wrote the size declared by the
786 * caller, which may be 0 (meaning unspecified) or wrong. */
787 slot->attr.bits = psa_calculate_key_bits( slot );
788 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100789 return( status );
790}
791
Gilles Peskinef603c712019-01-19 13:40:11 +0100792/** Calculate the intersection of two algorithm usage policies.
793 *
794 * Return 0 (which allows no operation) on incompatibility.
795 */
796static psa_algorithm_t psa_key_policy_algorithm_intersection(
797 psa_algorithm_t alg1,
798 psa_algorithm_t alg2 )
799{
Gilles Peskine549ea862019-05-22 11:45:59 +0200800 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100801 if( alg1 == alg2 )
802 return( alg1 );
803 /* If the policies are from the same hash-and-sign family, check
804 * if one is a wildcard. If so the other has the specific algorithm. */
805 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
806 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
807 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
808 {
809 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
810 return( alg2 );
811 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
812 return( alg1 );
813 }
814 /* If the policies are incompatible, allow nothing. */
815 return( 0 );
816}
817
Gilles Peskined6f371b2019-05-10 19:33:38 +0200818static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
819 psa_algorithm_t requested_alg )
820{
Gilles Peskine549ea862019-05-22 11:45:59 +0200821 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200822 if( requested_alg == policy_alg )
823 return( 1 );
824 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200825 * and requested_alg is the same hash-and-sign family with any hash,
826 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200827 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
828 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
829 {
830 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
831 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
832 }
833 /* If it isn't permitted, it's forbidden. */
834 return( 0 );
835}
836
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837/** Test whether a policy permits an algorithm.
838 *
839 * The caller must test usage flags separately.
840 */
841static int psa_key_policy_permits( const psa_key_policy_t *policy,
842 psa_algorithm_t alg )
843{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200844 return( psa_key_algorithm_permits( policy->alg, alg ) ||
845 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100846}
847
Gilles Peskinef603c712019-01-19 13:40:11 +0100848/** Restrict a key policy based on a constraint.
849 *
850 * \param[in,out] policy The policy to restrict.
851 * \param[in] constraint The policy constraint to apply.
852 *
853 * \retval #PSA_SUCCESS
854 * \c *policy contains the intersection of the original value of
855 * \c *policy and \c *constraint.
856 * \retval #PSA_ERROR_INVALID_ARGUMENT
857 * \c *policy and \c *constraint are incompatible.
858 * \c *policy is unchanged.
859 */
860static psa_status_t psa_restrict_key_policy(
861 psa_key_policy_t *policy,
862 const psa_key_policy_t *constraint )
863{
864 psa_algorithm_t intersection_alg =
865 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200866 psa_algorithm_t intersection_alg2 =
867 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
869 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
871 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100872 policy->usage &= constraint->usage;
873 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200874 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 return( PSA_SUCCESS );
876}
877
Darryl Green06fd18d2018-07-16 11:21:11 +0100878/** Retrieve a slot which must contain a key. The key must have allow all the
879 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
880 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100881static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100882 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100883 psa_key_usage_t usage,
884 psa_algorithm_t alg )
885{
886 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100887 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100888
889 *p_slot = NULL;
890
Gilles Peskinec5487a82018-12-03 18:08:14 +0100891 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100892 if( status != PSA_SUCCESS )
893 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100894
895 /* Enforce that usage policy for the key slot contains all the flags
896 * required by the usage parameter. There is one exception: public
897 * keys can always be exported, so we treat public key objects as
898 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200899 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100900 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +0200901 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +0100902 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100903
904 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200905 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100906 return( PSA_ERROR_NOT_PERMITTED );
907
908 *p_slot = slot;
909 return( PSA_SUCCESS );
910}
Darryl Green940d72c2018-07-13 13:18:51 +0100911
Gilles Peskine28f8f302019-07-24 13:30:31 +0200912/** Retrieve a slot which must contain a transparent key.
913 *
914 * A transparent key is a key for which the key material is directly
915 * available, as opposed to a key in a secure element.
916 *
Gilles Peskine60450a42019-07-25 11:32:45 +0200917 * This is a temporary function to use instead of psa_get_key_from_slot()
918 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200919 */
920#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
921static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
922 psa_key_slot_t **p_slot,
923 psa_key_usage_t usage,
924 psa_algorithm_t alg )
925{
926 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
927 if( status != PSA_SUCCESS )
928 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +0200929 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200930 {
931 *p_slot = NULL;
932 return( PSA_ERROR_NOT_SUPPORTED );
933 }
934 return( PSA_SUCCESS );
935}
936#else /* MBEDTLS_PSA_CRYPTO_SE_C */
937/* With no secure element support, all keys are transparent. */
938#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
939 psa_get_key_from_slot( handle, p_slot, usage, alg )
940#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
941
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100942/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100943static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000944{
Gilles Peskine73167e12019-07-12 23:44:37 +0200945#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
946 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000947 {
948 /* No key material to clean. */
949 }
Gilles Peskine73167e12019-07-12 23:44:37 +0200950 else
951#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine8e338702019-07-30 20:06:31 +0200952 if( slot->attr.type == PSA_KEY_TYPE_NONE )
Darryl Green40225ba2018-11-15 14:48:15 +0000953 {
954 /* No key material to clean. */
955 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200956 else if( key_type_is_raw_bytes( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000957 {
958 mbedtls_free( slot->data.raw.data );
959 }
960 else
961#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200962 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000963 {
964 mbedtls_rsa_free( slot->data.rsa );
965 mbedtls_free( slot->data.rsa );
966 }
967 else
968#endif /* defined(MBEDTLS_RSA_C) */
969#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200970 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000971 {
972 mbedtls_ecp_keypair_free( slot->data.ecp );
973 mbedtls_free( slot->data.ecp );
974 }
975 else
976#endif /* defined(MBEDTLS_ECP_C) */
977 {
978 /* Shouldn't happen: the key type is not any type that we
979 * put in. */
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200980 return( PSA_ERROR_CORRUPTION_DETECTED );
Darryl Green40225ba2018-11-15 14:48:15 +0000981 }
982
983 return( PSA_SUCCESS );
984}
985
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100986/** Completely wipe a slot in memory, including its policy.
987 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100988psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100989{
990 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200991 /* Multipart operations may still be using the key. This is safe
992 * because all multipart operation objects are independent from
993 * the key slot: if they need to access the key after the setup
994 * phase, they have a copy of the key. Note that this means that
995 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100996 /* At this point, key material and other type-specific content has
997 * been wiped. Clear remaining metadata. We can call memset and not
998 * zeroize because the metadata is not particularly sensitive. */
999 memset( slot, 0, sizeof( *slot ) );
1000 return( status );
1001}
1002
Gilles Peskinec5487a82018-12-03 18:08:14 +01001003psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001004{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001005 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001006 psa_status_t status; /* status of the last operation */
1007 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001008#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1009 psa_se_drv_table_entry_t *driver;
1010#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001011
Gilles Peskine1841cf42019-10-08 15:48:25 +02001012 if( handle == 0 )
1013 return( PSA_SUCCESS );
1014
Gilles Peskinec5487a82018-12-03 18:08:14 +01001015 status = psa_get_key_slot( handle, &slot );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001016 if( status != PSA_SUCCESS )
1017 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001018
1019#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001020 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001021 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001022 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001023 /* For a key in a secure element, we need to do three things:
1024 * remove the key file in internal storage, destroy the
1025 * key inside the secure element, and update the driver's
1026 * persistent data. Start a transaction that will encompass these
1027 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001028 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001029 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001030 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001031 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001032 status = psa_crypto_save_transaction( );
1033 if( status != PSA_SUCCESS )
1034 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001035 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001036 /* We should still try to destroy the key in the secure
1037 * element and the key metadata in storage. This is especially
1038 * important if the error is that the storage is full.
1039 * But how to do it exactly without risking an inconsistent
1040 * state after a reset?
1041 * https://github.com/ARMmbed/mbed-crypto/issues/215
1042 */
1043 overall_status = status;
1044 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001045 }
1046
Gilles Peskine354f7672019-07-12 23:46:38 +02001047 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001048 if( overall_status == PSA_SUCCESS )
1049 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001050 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001051#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1052
Darryl Greend49a4992018-06-18 17:27:26 +01001053#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001054 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001055 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001056 status = psa_destroy_persistent_key( slot->attr.id );
1057 if( overall_status == PSA_SUCCESS )
1058 overall_status = status;
1059
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001060 /* TODO: other slots may have a copy of the same key. We should
1061 * invalidate them.
1062 * https://github.com/ARMmbed/mbed-crypto/issues/214
1063 */
Darryl Greend49a4992018-06-18 17:27:26 +01001064 }
1065#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001066
Gilles Peskinefc762652019-07-22 19:30:34 +02001067#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1068 if( driver != NULL )
1069 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001070 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001071 if( overall_status == PSA_SUCCESS )
1072 overall_status = status;
1073 status = psa_crypto_stop_transaction( );
1074 if( overall_status == PSA_SUCCESS )
1075 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001076 }
1077#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1078
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1080exit:
1081#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001082 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001083 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1084 if( overall_status == PSA_SUCCESS )
1085 overall_status = status;
1086 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001087}
1088
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001089void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001090{
Gilles Peskineb699f072019-04-26 16:06:02 +02001091 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001092 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001093}
1094
Gilles Peskineb699f072019-04-26 16:06:02 +02001095psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1096 psa_key_type_t type,
1097 const uint8_t *data,
1098 size_t data_length )
1099{
1100 uint8_t *copy = NULL;
1101
1102 if( data_length != 0 )
1103 {
1104 copy = mbedtls_calloc( 1, data_length );
1105 if( copy == NULL )
1106 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1107 memcpy( copy, data, data_length );
1108 }
1109 /* After this point, this function is guaranteed to succeed, so it
1110 * can start modifying `*attributes`. */
1111
1112 if( attributes->domain_parameters != NULL )
1113 {
1114 mbedtls_free( attributes->domain_parameters );
1115 attributes->domain_parameters = NULL;
1116 attributes->domain_parameters_size = 0;
1117 }
1118
1119 attributes->domain_parameters = copy;
1120 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001121 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001122 return( PSA_SUCCESS );
1123}
1124
1125psa_status_t psa_get_key_domain_parameters(
1126 const psa_key_attributes_t *attributes,
1127 uint8_t *data, size_t data_size, size_t *data_length )
1128{
1129 if( attributes->domain_parameters_size > data_size )
1130 return( PSA_ERROR_BUFFER_TOO_SMALL );
1131 *data_length = attributes->domain_parameters_size;
1132 if( attributes->domain_parameters_size != 0 )
1133 memcpy( data, attributes->domain_parameters,
1134 attributes->domain_parameters_size );
1135 return( PSA_SUCCESS );
1136}
1137
1138#if defined(MBEDTLS_RSA_C)
1139static psa_status_t psa_get_rsa_public_exponent(
1140 const mbedtls_rsa_context *rsa,
1141 psa_key_attributes_t *attributes )
1142{
1143 mbedtls_mpi mpi;
1144 int ret;
1145 uint8_t *buffer = NULL;
1146 size_t buflen;
1147 mbedtls_mpi_init( &mpi );
1148
1149 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1150 if( ret != 0 )
1151 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001152 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1153 {
1154 /* It's the default value, which is reported as an empty string,
1155 * so there's nothing to do. */
1156 goto exit;
1157 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001158
1159 buflen = mbedtls_mpi_size( &mpi );
1160 buffer = mbedtls_calloc( 1, buflen );
1161 if( buffer == NULL )
1162 {
1163 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1164 goto exit;
1165 }
1166 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1167 if( ret != 0 )
1168 goto exit;
1169 attributes->domain_parameters = buffer;
1170 attributes->domain_parameters_size = buflen;
1171
1172exit:
1173 mbedtls_mpi_free( &mpi );
1174 if( ret != 0 )
1175 mbedtls_free( buffer );
1176 return( mbedtls_to_psa_error( ret ) );
1177}
1178#endif /* MBEDTLS_RSA_C */
1179
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001180/** Retrieve all the publicly-accessible attributes of a key.
1181 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001182psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1183 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001184{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001185 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001186 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001187
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001188 psa_reset_key_attributes( attributes );
1189
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001190 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001191 if( status != PSA_SUCCESS )
1192 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001193
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001194 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001195 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1196 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1197
1198#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1199 if( psa_key_slot_is_external( slot ) )
1200 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1201#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001202
Gilles Peskine8e338702019-07-30 20:06:31 +02001203 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001204 {
1205#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001206 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001207 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001208#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001209 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001210 * is not yet implemented.
1211 * https://github.com/ARMmbed/mbed-crypto/issues/216
1212 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001213 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001214 break;
1215#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001216 status = psa_get_rsa_public_exponent( slot->data.rsa, attributes );
1217 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001218#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001219 default:
1220 /* Nothing else to do. */
1221 break;
1222 }
1223
1224 if( status != PSA_SUCCESS )
1225 psa_reset_key_attributes( attributes );
1226 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001227}
1228
Gilles Peskinec8000c02019-08-02 20:15:51 +02001229#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1230psa_status_t psa_get_key_slot_number(
1231 const psa_key_attributes_t *attributes,
1232 psa_key_slot_number_t *slot_number )
1233{
1234 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1235 {
1236 *slot_number = attributes->slot_number;
1237 return( PSA_SUCCESS );
1238 }
1239 else
1240 return( PSA_ERROR_INVALID_ARGUMENT );
1241}
1242#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1243
Jaeden Ameroccdce902019-01-10 11:42:27 +00001244#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero25384a22019-01-10 10:23:21 +00001245static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1246 unsigned char *buf, size_t size )
1247{
1248 int ret;
1249 unsigned char *c;
1250 size_t len = 0;
1251
1252 c = buf + size;
1253
1254 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1255
1256 return( (int) len );
1257}
Jaeden Ameroccdce902019-01-10 11:42:27 +00001258#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero25384a22019-01-10 10:23:21 +00001259
Gilles Peskinef603c712019-01-19 13:40:11 +01001260static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1261 uint8_t *data,
1262 size_t data_size,
1263 size_t *data_length,
1264 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001265{
Gilles Peskine5d309672019-07-12 23:47:28 +02001266#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1267 const psa_drv_se_t *drv;
1268 psa_drv_se_context_t *drv_context;
1269#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1270
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001271 *data_length = 0;
1272
Gilles Peskine8e338702019-07-30 20:06:31 +02001273 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001274 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001275
Gilles Peskinef9168942019-09-12 19:20:29 +02001276 /* Reject a zero-length output buffer now, since this can never be a
1277 * valid key representation. This way we know that data must be a valid
1278 * pointer and we can do things like memset(data, ..., data_size). */
1279 if( data_size == 0 )
1280 return( PSA_ERROR_BUFFER_TOO_SMALL );
1281
Gilles Peskine5d309672019-07-12 23:47:28 +02001282#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001283 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001284 {
1285 psa_drv_se_export_key_t method;
1286 if( drv->key_management == NULL )
1287 return( PSA_ERROR_NOT_SUPPORTED );
1288 method = ( export_public_key ?
1289 drv->key_management->p_export_public :
1290 drv->key_management->p_export );
1291 if( method == NULL )
1292 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001293 return( method( drv_context,
1294 slot->data.se.slot_number,
1295 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001296 }
1297#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1298
Gilles Peskine8e338702019-07-30 20:06:31 +02001299 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001300 {
1301 if( slot->data.raw.bytes > data_size )
1302 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinef9168942019-09-12 19:20:29 +02001303 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
1304 memset( data + slot->data.raw.bytes, 0,
1305 data_size - slot->data.raw.bytes );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001306 *data_length = slot->data.raw.bytes;
1307 return( PSA_SUCCESS );
1308 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001309#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001310 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) && !export_public_key )
Gilles Peskine188c71e2018-10-29 19:26:02 +01001311 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001312 psa_status_t status;
1313
Gilles Peskineb46bef22019-07-30 21:32:04 +02001314 size_t bytes = PSA_BITS_TO_BYTES( slot->attr.bits );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001315 if( bytes > data_size )
1316 return( PSA_ERROR_BUFFER_TOO_SMALL );
1317 status = mbedtls_to_psa_error(
1318 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1319 if( status != PSA_SUCCESS )
1320 return( status );
1321 memset( data + bytes, 0, data_size - bytes );
1322 *data_length = bytes;
1323 return( PSA_SUCCESS );
1324 }
1325#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001326 else
Moran Peker17e36e12018-05-02 12:55:20 +03001327 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001328#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001329 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1330 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001331 {
Moran Pekera998bc62018-04-16 18:16:20 +03001332 mbedtls_pk_context pk;
1333 int ret;
Gilles Peskine8e338702019-07-30 20:06:31 +02001334 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001335 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001336#if defined(MBEDTLS_RSA_C)
1337 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001338 pk.pk_info = &mbedtls_rsa_info;
1339 pk.pk_ctx = slot->data.rsa;
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 }
1344 else
1345 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001346#if defined(MBEDTLS_ECP_C)
1347 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001348 pk.pk_info = &mbedtls_eckey_info;
1349 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001350#else
1351 return( PSA_ERROR_NOT_SUPPORTED );
1352#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001353 }
Gilles Peskine8e338702019-07-30 20:06:31 +02001354 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero25384a22019-01-10 10:23:21 +00001355 {
Jaeden Ameroccdce902019-01-10 11:42:27 +00001356 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001357 }
Moran Peker17e36e12018-05-02 12:55:20 +03001358 else
Jaeden Amero25384a22019-01-10 10:23:21 +00001359 {
Moran Peker17e36e12018-05-02 12:55:20 +03001360 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001361 }
Moran Peker60364322018-04-29 11:34:58 +03001362 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001363 {
Gilles Peskinef9168942019-09-12 19:20:29 +02001364 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001365 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001366 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001367 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1368 * Move the data to the beginning and erase remaining data
1369 * at the original location. */
1370 if( 2 * (size_t) ret <= data_size )
1371 {
1372 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001373 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001374 }
1375 else if( (size_t) ret < data_size )
1376 {
1377 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001378 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001379 }
Moran Pekera998bc62018-04-16 18:16:20 +03001380 *data_length = ret;
1381 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001382 }
1383 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001384#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001385 {
1386 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001387 it is valid for a special-purpose implementation to omit
1388 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001389 return( PSA_ERROR_NOT_SUPPORTED );
1390 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001391 }
1392}
1393
Gilles Peskinec5487a82018-12-03 18:08:14 +01001394psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001395 uint8_t *data,
1396 size_t data_size,
1397 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001398{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001399 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001400 psa_status_t status;
1401
1402 /* Set the key to empty now, so that even when there are errors, we always
1403 * set data_length to a value between 0 and data_size. On error, setting
1404 * the key to empty is a good choice because an empty key representation is
1405 * unlikely to be accepted anywhere. */
1406 *data_length = 0;
1407
1408 /* Export requires the EXPORT flag. There is an exception for public keys,
1409 * which don't require any flag, but psa_get_key_from_slot takes
1410 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001411 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001412 if( status != PSA_SUCCESS )
1413 return( status );
1414 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001415 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001416}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001417
Gilles Peskinec5487a82018-12-03 18:08:14 +01001418psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001419 uint8_t *data,
1420 size_t data_size,
1421 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001422{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001423 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001424 psa_status_t status;
1425
1426 /* Set the key to empty now, so that even when there are errors, we always
1427 * set data_length to a value between 0 and data_size. On error, setting
1428 * the key to empty is a good choice because an empty key representation is
1429 * unlikely to be accepted anywhere. */
1430 *data_length = 0;
1431
1432 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001433 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001434 if( status != PSA_SUCCESS )
1435 return( status );
1436 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001437 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001438}
1439
Gilles Peskine91e8c332019-08-02 19:19:39 +02001440#if defined(static_assert)
1441static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1442 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001443static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001444 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001445static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001446 "One or more key attribute flag is listed as both internal-only and external-only" );
1447#endif
1448
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001449/** Validate that a key policy is internally well-formed.
1450 *
1451 * This function only rejects invalid policies. It does not validate the
1452 * consistency of the policy with respect to other attributes of the key
1453 * such as the key type.
1454 */
1455static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001456{
1457 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001458 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001459 PSA_KEY_USAGE_ENCRYPT |
1460 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001461 PSA_KEY_USAGE_SIGN_HASH |
1462 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001463 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1464 return( PSA_ERROR_INVALID_ARGUMENT );
1465
Gilles Peskine4747d192019-04-17 15:05:45 +02001466 return( PSA_SUCCESS );
1467}
1468
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001469/** Validate the internal consistency of key attributes.
1470 *
1471 * This function only rejects invalid attribute values. If does not
1472 * validate the consistency of the attributes with any key data that may
1473 * be involved in the creation of the key.
1474 *
1475 * Call this function early in the key creation process.
1476 *
1477 * \param[in] attributes Key attributes for the new key.
1478 * \param[out] p_drv On any return, the driver for the key, if any.
1479 * NULL for a transparent key.
1480 *
1481 */
1482static psa_status_t psa_validate_key_attributes(
1483 const psa_key_attributes_t *attributes,
1484 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001485{
1486 psa_status_t status;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001487
1488 if( attributes->core.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Green0c6575a2018-11-07 16:05:30 +00001489 {
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001490 status = psa_validate_persistent_key_parameters(
1491 attributes->core.lifetime, attributes->core.id,
1492 p_drv, 1 );
1493 if( status != PSA_SUCCESS )
1494 return( status );
Darryl Green0c6575a2018-11-07 16:05:30 +00001495 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001496
1497 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001498 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001499 return( status );
1500
1501 /* Refuse to create overly large keys.
1502 * Note that this doesn't trigger on import if the attributes don't
1503 * explicitly specify a size (so psa_get_key_bits returns 0), so
1504 * psa_import_key() needs its own checks. */
1505 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1506 return( PSA_ERROR_NOT_SUPPORTED );
1507
Gilles Peskine91e8c332019-08-02 19:19:39 +02001508 /* Reject invalid flags. These should not be reachable through the API. */
1509 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1510 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1511 return( PSA_ERROR_INVALID_ARGUMENT );
1512
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001513 return( PSA_SUCCESS );
1514}
1515
Gilles Peskine4747d192019-04-17 15:05:45 +02001516/** Prepare a key slot to receive key material.
1517 *
1518 * This function allocates a key slot and sets its metadata.
1519 *
1520 * If this function fails, call psa_fail_key_creation().
1521 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001522 * This function is intended to be used as follows:
1523 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1524 * it with the specified attributes, and assign it a handle.
1525 * -# Populate the slot with the key material.
1526 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1527 * In case of failure at any step, stop the sequence and call
1528 * psa_fail_key_creation().
1529 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001530 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001531 * \param[in] attributes Key attributes for the new key.
1532 * \param[out] handle On success, a handle for the allocated slot.
1533 * \param[out] p_slot On success, a pointer to the prepared slot.
1534 * \param[out] p_drv On any return, the driver for the key, if any.
1535 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001536 *
1537 * \retval #PSA_SUCCESS
1538 * The key slot is ready to receive key material.
1539 * \return If this function fails, the key slot is an invalid state.
1540 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001541 */
1542static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001543 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001544 const psa_key_attributes_t *attributes,
1545 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001546 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001547 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001548{
1549 psa_status_t status;
1550 psa_key_slot_t *slot;
1551
Gilles Peskinedf179142019-07-15 22:02:14 +02001552 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001553 *p_drv = NULL;
1554
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001555 status = psa_validate_key_attributes( attributes, p_drv );
1556 if( status != PSA_SUCCESS )
1557 return( status );
1558
Gilles Peskineedbed562019-08-07 18:19:59 +02001559 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001560 if( status != PSA_SUCCESS )
1561 return( status );
1562 slot = *p_slot;
1563
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001564 /* We're storing the declared bit-size of the key. It's up to each
1565 * creation mechanism to verify that this information is correct.
1566 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001567 * an input (generate, device) but not for those where the bit-size
1568 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001569
1570 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001571
Gilles Peskine91e8c332019-08-02 19:19:39 +02001572 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001573 * external-only flags, query `attributes`. Thanks to the check
1574 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001575 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001576 * may have set. */
1577 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001578
Gilles Peskinecbaff462019-07-12 23:46:04 +02001579#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001580 /* For a key in a secure element, we need to do three things
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001581 * when creating or registering a key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001582 * create the key file in internal storage, create the
1583 * key inside the secure element, and update the driver's
1584 * persistent data. Start a transaction that will encompass these
1585 * three actions. */
1586 /* The first thing to do is to find a slot number for the new key.
1587 * We save the slot number in persistent storage as part of the
1588 * transaction data. It will be needed to recover if the power
1589 * fails during the key creation process, to clean up on the secure
1590 * element side after restarting. Obtaining a slot number from the
1591 * secure element driver updates its persistent state, but we do not yet
1592 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001593 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001594 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001595 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001596 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001597 &slot->data.se.slot_number );
1598 if( status != PSA_SUCCESS )
1599 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001600 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001601 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001602 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001603 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001604 status = psa_crypto_save_transaction( );
1605 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001606 {
1607 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001608 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001609 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001610 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001611
1612 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1613 {
1614 /* Key registration only makes sense with a secure element. */
1615 return( PSA_ERROR_INVALID_ARGUMENT );
1616 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001617#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1618
Darryl Green0c6575a2018-11-07 16:05:30 +00001619 return( status );
1620}
Gilles Peskine4747d192019-04-17 15:05:45 +02001621
1622/** Finalize the creation of a key once its key material has been set.
1623 *
1624 * This entails writing the key to persistent storage.
1625 *
1626 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001627 * See the documentation of psa_start_key_creation() for the intended use
1628 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001629 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001630 * \param[in,out] slot Pointer to the slot with key material.
1631 * \param[in] driver The secure element driver for the key,
1632 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001633 *
1634 * \retval #PSA_SUCCESS
1635 * The key was successfully created. The handle is now valid.
1636 * \return If this function fails, the key slot is an invalid state.
1637 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001638 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001639static psa_status_t psa_finish_key_creation(
1640 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001641 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001642{
1643 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001644 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001645 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001646
1647#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001648 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001649 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001650#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1651 if( driver != NULL )
1652 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001653 psa_se_key_data_storage_t data;
1654#if defined(static_assert)
1655 static_assert( sizeof( slot->data.se.slot_number ) ==
1656 sizeof( data.slot_number ),
1657 "Slot number size does not match psa_se_key_data_storage_t" );
1658 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1659 "Bit-size size does not match psa_se_key_data_storage_t" );
1660#endif
1661 memcpy( &data.slot_number, &slot->data.se.slot_number,
1662 sizeof( slot->data.se.slot_number ) );
1663 memcpy( &data.bits, &slot->attr.bits,
1664 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001665 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001666 (uint8_t*) &data,
1667 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001668 }
1669 else
1670#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1671 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001672 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001673 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001674 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001675 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1676 size_t length = 0;
Gilles Peskinef9168942019-09-12 19:20:29 +02001677 if( buffer == NULL )
Gilles Peskine1df83d42019-07-23 16:13:14 +02001678 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1679 status = psa_internal_export_key( slot,
1680 buffer, buffer_size, &length,
1681 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001682 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001683 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001684 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001685
Gilles Peskinef9168942019-09-12 19:20:29 +02001686 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001687 mbedtls_free( buffer );
1688 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001689 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001690#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1691
Gilles Peskinecbaff462019-07-12 23:46:04 +02001692#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001693 /* Finish the transaction for a key creation. This does not
1694 * happen when registering an existing key. Detect this case
1695 * by checking whether a transaction is in progress (actual
1696 * creation of a key in a secure element requires a transaction,
1697 * but registration doesn't use one). */
1698 if( driver != NULL &&
1699 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001700 {
1701 status = psa_save_se_persistent_data( driver );
1702 if( status != PSA_SUCCESS )
1703 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001704 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001705 return( status );
1706 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001707 status = psa_crypto_stop_transaction( );
1708 if( status != PSA_SUCCESS )
1709 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001710 }
1711#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1712
Gilles Peskine4747d192019-04-17 15:05:45 +02001713 return( status );
1714}
1715
1716/** Abort the creation of a key.
1717 *
1718 * You may call this function after calling psa_start_key_creation(),
1719 * or after psa_finish_key_creation() fails. In other circumstances, this
1720 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001721 * See the documentation of psa_start_key_creation() for the intended use
1722 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001723 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001724 * \param[in,out] slot Pointer to the slot with key material.
1725 * \param[in] driver The secure element driver for the key,
1726 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001727 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001728static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001729 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001730{
Gilles Peskine011e4282019-06-26 18:34:38 +02001731 (void) driver;
1732
Gilles Peskine4747d192019-04-17 15:05:45 +02001733 if( slot == NULL )
1734 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001735
1736#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001737 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001738 * element, and the failure happened later (when saving metadata
1739 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001740 * element.
1741 * https://github.com/ARMmbed/mbed-crypto/issues/217
1742 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001743
Gilles Peskined7729582019-08-05 15:55:54 +02001744 /* Abort the ongoing transaction if any (there may not be one if
1745 * the creation process failed before starting one, or if the
1746 * key creation is a registration of a key in a secure element).
1747 * Earlier functions must already have done what it takes to undo any
1748 * partial creation. All that's left is to update the transaction data
1749 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001750 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001751#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1752
Gilles Peskine4747d192019-04-17 15:05:45 +02001753 psa_wipe_key_slot( slot );
1754}
1755
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001756/** Validate optional attributes during key creation.
1757 *
1758 * Some key attributes are optional during key creation. If they are
1759 * specified in the attributes structure, check that they are consistent
1760 * with the data in the slot.
1761 *
1762 * This function should be called near the end of key creation, after
1763 * the slot in memory is fully populated but before saving persistent data.
1764 */
1765static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001766 const psa_key_slot_t *slot,
1767 const psa_key_attributes_t *attributes )
1768{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001769 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001770 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001771 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001772 return( PSA_ERROR_INVALID_ARGUMENT );
1773 }
1774
1775 if( attributes->domain_parameters_size != 0 )
1776 {
1777#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001778 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001779 {
1780 mbedtls_mpi actual, required;
1781 int ret;
1782 mbedtls_mpi_init( &actual );
1783 mbedtls_mpi_init( &required );
1784 ret = mbedtls_rsa_export( slot->data.rsa,
1785 NULL, NULL, NULL, NULL, &actual );
1786 if( ret != 0 )
1787 goto rsa_exit;
1788 ret = mbedtls_mpi_read_binary( &required,
1789 attributes->domain_parameters,
1790 attributes->domain_parameters_size );
1791 if( ret != 0 )
1792 goto rsa_exit;
1793 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1794 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1795 rsa_exit:
1796 mbedtls_mpi_free( &actual );
1797 mbedtls_mpi_free( &required );
1798 if( ret != 0)
1799 return( mbedtls_to_psa_error( ret ) );
1800 }
1801 else
1802#endif
1803 {
1804 return( PSA_ERROR_INVALID_ARGUMENT );
1805 }
1806 }
1807
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001808 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001809 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001810 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001811 return( PSA_ERROR_INVALID_ARGUMENT );
1812 }
1813
1814 return( PSA_SUCCESS );
1815}
1816
Gilles Peskine4747d192019-04-17 15:05:45 +02001817psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001818 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001819 size_t data_length,
1820 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001821{
1822 psa_status_t status;
1823 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001824 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001825
Gilles Peskine0f84d622019-09-12 19:03:13 +02001826 /* Reject zero-length symmetric keys (including raw data key objects).
1827 * This also rejects any key which might be encoded as an empty string,
1828 * which is never valid. */
1829 if( data_length == 0 )
1830 return( PSA_ERROR_INVALID_ARGUMENT );
1831
Gilles Peskinedf179142019-07-15 22:02:14 +02001832 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
1833 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001834 if( status != PSA_SUCCESS )
1835 goto exit;
1836
Gilles Peskine5d309672019-07-12 23:47:28 +02001837#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1838 if( driver != NULL )
1839 {
1840 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001841 /* The driver should set the number of key bits, however in
1842 * case it doesn't, we initialize bits to an invalid value. */
1843 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001844 if( drv->key_management == NULL ||
1845 drv->key_management->p_import == NULL )
1846 {
1847 status = PSA_ERROR_NOT_SUPPORTED;
1848 goto exit;
1849 }
1850 status = drv->key_management->p_import(
1851 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02001852 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001853 &bits );
1854 if( status != PSA_SUCCESS )
1855 goto exit;
1856 if( bits > PSA_MAX_KEY_BITS )
1857 {
1858 status = PSA_ERROR_NOT_SUPPORTED;
1859 goto exit;
1860 }
1861 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001862 }
1863 else
1864#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1865 {
1866 status = psa_import_key_into_slot( slot, data, data_length );
1867 if( status != PSA_SUCCESS )
1868 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001869 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001870 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001871 if( status != PSA_SUCCESS )
1872 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001873
Gilles Peskine011e4282019-06-26 18:34:38 +02001874 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001875exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001876 if( status != PSA_SUCCESS )
1877 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001878 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001879 *handle = 0;
1880 }
1881 return( status );
1882}
1883
Gilles Peskined7729582019-08-05 15:55:54 +02001884#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1885psa_status_t mbedtls_psa_register_se_key(
1886 const psa_key_attributes_t *attributes )
1887{
1888 psa_status_t status;
1889 psa_key_slot_t *slot = NULL;
1890 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02001891 psa_key_handle_t handle = 0;
1892
1893 /* Leaving attributes unspecified is not currently supported.
1894 * It could make sense to query the key type and size from the
1895 * secure element, but not all secure elements support this
1896 * and the driver HAL doesn't currently support it. */
1897 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1898 return( PSA_ERROR_NOT_SUPPORTED );
1899 if( psa_get_key_bits( attributes ) == 0 )
1900 return( PSA_ERROR_NOT_SUPPORTED );
1901
1902 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
1903 &handle, &slot, &driver );
1904 if( status != PSA_SUCCESS )
1905 goto exit;
1906
Gilles Peskined7729582019-08-05 15:55:54 +02001907 status = psa_finish_key_creation( slot, driver );
1908
1909exit:
1910 if( status != PSA_SUCCESS )
1911 {
1912 psa_fail_key_creation( slot, driver );
1913 }
1914 /* Registration doesn't keep the key in RAM. */
1915 psa_close_key( handle );
1916 return( status );
1917}
1918#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1919
Gilles Peskinef603c712019-01-19 13:40:11 +01001920static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001921 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001922{
1923 psa_status_t status;
1924 uint8_t *buffer = NULL;
1925 size_t buffer_size = 0;
1926 size_t length;
1927
Gilles Peskine8e338702019-07-30 20:06:31 +02001928 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001929 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01001930 buffer = mbedtls_calloc( 1, buffer_size );
Gilles Peskinef9168942019-09-12 19:20:29 +02001931 if( buffer == NULL )
Gilles Peskine122d0022019-01-23 10:55:43 +01001932 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01001933 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1934 if( status != PSA_SUCCESS )
1935 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001936 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001937 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01001938
1939exit:
Gilles Peskinef9168942019-09-12 19:20:29 +02001940 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001941 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01001942 return( status );
1943}
1944
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001945psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1946 const psa_key_attributes_t *specified_attributes,
1947 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01001948{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001949 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01001950 psa_key_slot_t *source_slot = NULL;
1951 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001952 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001953 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001954
Gilles Peskine28f8f302019-07-24 13:30:31 +02001955 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001956 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001957 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001958 goto exit;
1959
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001960 status = psa_validate_optional_attributes( source_slot,
1961 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001962 if( status != PSA_SUCCESS )
1963 goto exit;
1964
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001965 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001966 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001967 if( status != PSA_SUCCESS )
1968 goto exit;
1969
Gilles Peskinedf179142019-07-15 22:02:14 +02001970 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
1971 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001972 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001973 if( status != PSA_SUCCESS )
1974 goto exit;
1975
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001976#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1977 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01001978 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001979 /* Copying to a secure element is not implemented yet. */
1980 status = PSA_ERROR_NOT_SUPPORTED;
1981 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001982 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001983#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01001984
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001985 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01001986 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001987 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001988
Gilles Peskine011e4282019-06-26 18:34:38 +02001989 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001990exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001991 if( status != PSA_SUCCESS )
1992 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001993 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001994 *target_handle = 0;
1995 }
1996 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001997}
1998
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001999
2000
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002001/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002002/* Message digests */
2003/****************************************************************/
2004
Gilles Peskineb16841e2019-10-10 20:36:12 +02002005#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002006static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002007{
2008 switch( alg )
2009 {
2010#if defined(MBEDTLS_MD2_C)
2011 case PSA_ALG_MD2:
2012 return( &mbedtls_md2_info );
2013#endif
2014#if defined(MBEDTLS_MD4_C)
2015 case PSA_ALG_MD4:
2016 return( &mbedtls_md4_info );
2017#endif
2018#if defined(MBEDTLS_MD5_C)
2019 case PSA_ALG_MD5:
2020 return( &mbedtls_md5_info );
2021#endif
2022#if defined(MBEDTLS_RIPEMD160_C)
2023 case PSA_ALG_RIPEMD160:
2024 return( &mbedtls_ripemd160_info );
2025#endif
2026#if defined(MBEDTLS_SHA1_C)
2027 case PSA_ALG_SHA_1:
2028 return( &mbedtls_sha1_info );
2029#endif
2030#if defined(MBEDTLS_SHA256_C)
2031 case PSA_ALG_SHA_224:
2032 return( &mbedtls_sha224_info );
2033 case PSA_ALG_SHA_256:
2034 return( &mbedtls_sha256_info );
2035#endif
2036#if defined(MBEDTLS_SHA512_C)
2037 case PSA_ALG_SHA_384:
2038 return( &mbedtls_sha384_info );
2039 case PSA_ALG_SHA_512:
2040 return( &mbedtls_sha512_info );
2041#endif
2042 default:
2043 return( NULL );
2044 }
2045}
Gilles Peskineb16841e2019-10-10 20:36:12 +02002046#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002047
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002048psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2049{
2050 switch( operation->alg )
2051 {
Gilles Peskine81736312018-06-26 15:04:31 +02002052 case 0:
2053 /* The object has (apparently) been initialized but it is not
2054 * in use. It's ok to call abort on such an object, and there's
2055 * nothing to do. */
2056 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002057#if defined(MBEDTLS_MD2_C)
2058 case PSA_ALG_MD2:
2059 mbedtls_md2_free( &operation->ctx.md2 );
2060 break;
2061#endif
2062#if defined(MBEDTLS_MD4_C)
2063 case PSA_ALG_MD4:
2064 mbedtls_md4_free( &operation->ctx.md4 );
2065 break;
2066#endif
2067#if defined(MBEDTLS_MD5_C)
2068 case PSA_ALG_MD5:
2069 mbedtls_md5_free( &operation->ctx.md5 );
2070 break;
2071#endif
2072#if defined(MBEDTLS_RIPEMD160_C)
2073 case PSA_ALG_RIPEMD160:
2074 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2075 break;
2076#endif
2077#if defined(MBEDTLS_SHA1_C)
2078 case PSA_ALG_SHA_1:
2079 mbedtls_sha1_free( &operation->ctx.sha1 );
2080 break;
2081#endif
2082#if defined(MBEDTLS_SHA256_C)
2083 case PSA_ALG_SHA_224:
2084 case PSA_ALG_SHA_256:
2085 mbedtls_sha256_free( &operation->ctx.sha256 );
2086 break;
2087#endif
2088#if defined(MBEDTLS_SHA512_C)
2089 case PSA_ALG_SHA_384:
2090 case PSA_ALG_SHA_512:
2091 mbedtls_sha512_free( &operation->ctx.sha512 );
2092 break;
2093#endif
2094 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002095 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002096 }
2097 operation->alg = 0;
2098 return( PSA_SUCCESS );
2099}
2100
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002101psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002102 psa_algorithm_t alg )
2103{
2104 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002105
2106 /* A context must be freshly initialized before it can be set up. */
2107 if( operation->alg != 0 )
2108 {
2109 return( PSA_ERROR_BAD_STATE );
2110 }
2111
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002112 switch( alg )
2113 {
2114#if defined(MBEDTLS_MD2_C)
2115 case PSA_ALG_MD2:
2116 mbedtls_md2_init( &operation->ctx.md2 );
2117 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2118 break;
2119#endif
2120#if defined(MBEDTLS_MD4_C)
2121 case PSA_ALG_MD4:
2122 mbedtls_md4_init( &operation->ctx.md4 );
2123 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2124 break;
2125#endif
2126#if defined(MBEDTLS_MD5_C)
2127 case PSA_ALG_MD5:
2128 mbedtls_md5_init( &operation->ctx.md5 );
2129 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2130 break;
2131#endif
2132#if defined(MBEDTLS_RIPEMD160_C)
2133 case PSA_ALG_RIPEMD160:
2134 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2135 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2136 break;
2137#endif
2138#if defined(MBEDTLS_SHA1_C)
2139 case PSA_ALG_SHA_1:
2140 mbedtls_sha1_init( &operation->ctx.sha1 );
2141 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2142 break;
2143#endif
2144#if defined(MBEDTLS_SHA256_C)
2145 case PSA_ALG_SHA_224:
2146 mbedtls_sha256_init( &operation->ctx.sha256 );
2147 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2148 break;
2149 case PSA_ALG_SHA_256:
2150 mbedtls_sha256_init( &operation->ctx.sha256 );
2151 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2152 break;
2153#endif
2154#if defined(MBEDTLS_SHA512_C)
2155 case PSA_ALG_SHA_384:
2156 mbedtls_sha512_init( &operation->ctx.sha512 );
2157 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2158 break;
2159 case PSA_ALG_SHA_512:
2160 mbedtls_sha512_init( &operation->ctx.sha512 );
2161 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2162 break;
2163#endif
2164 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002165 return( PSA_ALG_IS_HASH( alg ) ?
2166 PSA_ERROR_NOT_SUPPORTED :
2167 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002168 }
2169 if( ret == 0 )
2170 operation->alg = alg;
2171 else
2172 psa_hash_abort( operation );
2173 return( mbedtls_to_psa_error( ret ) );
2174}
2175
2176psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2177 const uint8_t *input,
2178 size_t input_length )
2179{
2180 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002181
2182 /* Don't require hash implementations to behave correctly on a
2183 * zero-length input, which may have an invalid pointer. */
2184 if( input_length == 0 )
2185 return( PSA_SUCCESS );
2186
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187 switch( operation->alg )
2188 {
2189#if defined(MBEDTLS_MD2_C)
2190 case PSA_ALG_MD2:
2191 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2192 input, input_length );
2193 break;
2194#endif
2195#if defined(MBEDTLS_MD4_C)
2196 case PSA_ALG_MD4:
2197 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2198 input, input_length );
2199 break;
2200#endif
2201#if defined(MBEDTLS_MD5_C)
2202 case PSA_ALG_MD5:
2203 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2204 input, input_length );
2205 break;
2206#endif
2207#if defined(MBEDTLS_RIPEMD160_C)
2208 case PSA_ALG_RIPEMD160:
2209 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2210 input, input_length );
2211 break;
2212#endif
2213#if defined(MBEDTLS_SHA1_C)
2214 case PSA_ALG_SHA_1:
2215 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2216 input, input_length );
2217 break;
2218#endif
2219#if defined(MBEDTLS_SHA256_C)
2220 case PSA_ALG_SHA_224:
2221 case PSA_ALG_SHA_256:
2222 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2223 input, input_length );
2224 break;
2225#endif
2226#if defined(MBEDTLS_SHA512_C)
2227 case PSA_ALG_SHA_384:
2228 case PSA_ALG_SHA_512:
2229 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2230 input, input_length );
2231 break;
2232#endif
2233 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002234 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002235 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002236
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002237 if( ret != 0 )
2238 psa_hash_abort( operation );
2239 return( mbedtls_to_psa_error( ret ) );
2240}
2241
2242psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2243 uint8_t *hash,
2244 size_t hash_size,
2245 size_t *hash_length )
2246{
itayzafrir40835d42018-08-02 13:14:17 +03002247 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002248 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002249 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250
2251 /* Fill the output buffer with something that isn't a valid hash
2252 * (barring an attack on the hash and deliberately-crafted input),
2253 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002254 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002255 /* If hash_size is 0 then hash may be NULL and then the
2256 * call to memset would have undefined behavior. */
2257 if( hash_size != 0 )
2258 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259
2260 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002261 {
2262 status = PSA_ERROR_BUFFER_TOO_SMALL;
2263 goto exit;
2264 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265
2266 switch( operation->alg )
2267 {
2268#if defined(MBEDTLS_MD2_C)
2269 case PSA_ALG_MD2:
2270 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2271 break;
2272#endif
2273#if defined(MBEDTLS_MD4_C)
2274 case PSA_ALG_MD4:
2275 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2276 break;
2277#endif
2278#if defined(MBEDTLS_MD5_C)
2279 case PSA_ALG_MD5:
2280 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2281 break;
2282#endif
2283#if defined(MBEDTLS_RIPEMD160_C)
2284 case PSA_ALG_RIPEMD160:
2285 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2286 break;
2287#endif
2288#if defined(MBEDTLS_SHA1_C)
2289 case PSA_ALG_SHA_1:
2290 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2291 break;
2292#endif
2293#if defined(MBEDTLS_SHA256_C)
2294 case PSA_ALG_SHA_224:
2295 case PSA_ALG_SHA_256:
2296 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2297 break;
2298#endif
2299#if defined(MBEDTLS_SHA512_C)
2300 case PSA_ALG_SHA_384:
2301 case PSA_ALG_SHA_512:
2302 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2303 break;
2304#endif
2305 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002306 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002307 }
itayzafrir40835d42018-08-02 13:14:17 +03002308 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002309
itayzafrir40835d42018-08-02 13:14:17 +03002310exit:
2311 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002312 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002313 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002314 return( psa_hash_abort( operation ) );
2315 }
2316 else
2317 {
2318 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002319 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002320 }
2321}
2322
Gilles Peskine2d277862018-06-18 15:41:12 +02002323psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2324 const uint8_t *hash,
2325 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326{
2327 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2328 size_t actual_hash_length;
2329 psa_status_t status = psa_hash_finish( operation,
2330 actual_hash, sizeof( actual_hash ),
2331 &actual_hash_length );
2332 if( status != PSA_SUCCESS )
2333 return( status );
2334 if( actual_hash_length != hash_length )
2335 return( PSA_ERROR_INVALID_SIGNATURE );
2336 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2337 return( PSA_ERROR_INVALID_SIGNATURE );
2338 return( PSA_SUCCESS );
2339}
2340
Gilles Peskineeb35d782019-01-22 17:56:16 +01002341psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2342 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002343{
2344 if( target_operation->alg != 0 )
2345 return( PSA_ERROR_BAD_STATE );
2346
2347 switch( source_operation->alg )
2348 {
2349 case 0:
2350 return( PSA_ERROR_BAD_STATE );
2351#if defined(MBEDTLS_MD2_C)
2352 case PSA_ALG_MD2:
2353 mbedtls_md2_clone( &target_operation->ctx.md2,
2354 &source_operation->ctx.md2 );
2355 break;
2356#endif
2357#if defined(MBEDTLS_MD4_C)
2358 case PSA_ALG_MD4:
2359 mbedtls_md4_clone( &target_operation->ctx.md4,
2360 &source_operation->ctx.md4 );
2361 break;
2362#endif
2363#if defined(MBEDTLS_MD5_C)
2364 case PSA_ALG_MD5:
2365 mbedtls_md5_clone( &target_operation->ctx.md5,
2366 &source_operation->ctx.md5 );
2367 break;
2368#endif
2369#if defined(MBEDTLS_RIPEMD160_C)
2370 case PSA_ALG_RIPEMD160:
2371 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2372 &source_operation->ctx.ripemd160 );
2373 break;
2374#endif
2375#if defined(MBEDTLS_SHA1_C)
2376 case PSA_ALG_SHA_1:
2377 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2378 &source_operation->ctx.sha1 );
2379 break;
2380#endif
2381#if defined(MBEDTLS_SHA256_C)
2382 case PSA_ALG_SHA_224:
2383 case PSA_ALG_SHA_256:
2384 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2385 &source_operation->ctx.sha256 );
2386 break;
2387#endif
2388#if defined(MBEDTLS_SHA512_C)
2389 case PSA_ALG_SHA_384:
2390 case PSA_ALG_SHA_512:
2391 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2392 &source_operation->ctx.sha512 );
2393 break;
2394#endif
2395 default:
2396 return( PSA_ERROR_NOT_SUPPORTED );
2397 }
2398
2399 target_operation->alg = source_operation->alg;
2400 return( PSA_SUCCESS );
2401}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002402
2403
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002404/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002405/* MAC */
2406/****************************************************************/
2407
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002408static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002409 psa_algorithm_t alg,
2410 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002411 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002412 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002413{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002415 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002416
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002417 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002418 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002419
Gilles Peskine8c9def32018-02-08 10:02:12 +01002420 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2421 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002422 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002423 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002424 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002425 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002426 mode = MBEDTLS_MODE_STREAM;
2427 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002428 case PSA_ALG_CTR:
2429 mode = MBEDTLS_MODE_CTR;
2430 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002431 case PSA_ALG_CFB:
2432 mode = MBEDTLS_MODE_CFB;
2433 break;
2434 case PSA_ALG_OFB:
2435 mode = MBEDTLS_MODE_OFB;
2436 break;
2437 case PSA_ALG_CBC_NO_PADDING:
2438 mode = MBEDTLS_MODE_CBC;
2439 break;
2440 case PSA_ALG_CBC_PKCS7:
2441 mode = MBEDTLS_MODE_CBC;
2442 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002443 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002444 mode = MBEDTLS_MODE_CCM;
2445 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002446 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002447 mode = MBEDTLS_MODE_GCM;
2448 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002449 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2450 mode = MBEDTLS_MODE_CHACHAPOLY;
2451 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002452 default:
2453 return( NULL );
2454 }
2455 }
2456 else if( alg == PSA_ALG_CMAC )
2457 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002458 else
2459 return( NULL );
2460
2461 switch( key_type )
2462 {
2463 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002464 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002465 break;
2466 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002467 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2468 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002469 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002470 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002471 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002472 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002473 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2474 * but two-key Triple-DES is functionally three-key Triple-DES
2475 * with K1=K3, so that's how we present it to mbedtls. */
2476 if( key_bits == 128 )
2477 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478 break;
2479 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002480 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002481 break;
2482 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002483 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002485 case PSA_KEY_TYPE_CHACHA20:
2486 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2487 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002488 default:
2489 return( NULL );
2490 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002491 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002492 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002493
Jaeden Amero23bbb752018-06-26 14:16:54 +01002494 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2495 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002496}
2497
Gilles Peskinea05219c2018-11-16 16:02:56 +01002498#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002499static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002500{
Gilles Peskine2d277862018-06-18 15:41:12 +02002501 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002502 {
2503 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002504 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002505 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002506 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002507 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002508 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002509 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002510 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002511 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002512 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002513 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002514 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002515 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002516 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002517 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002518 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002519 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002520 return( 128 );
2521 default:
2522 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002523 }
2524}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002525#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002526
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002527/* Initialize the MAC operation structure. Once this function has been
2528 * called, psa_mac_abort can run and will do the right thing. */
2529static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2530 psa_algorithm_t alg )
2531{
2532 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2533
2534 operation->alg = alg;
2535 operation->key_set = 0;
2536 operation->iv_set = 0;
2537 operation->iv_required = 0;
2538 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002539 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002540
2541#if defined(MBEDTLS_CMAC_C)
2542 if( alg == PSA_ALG_CMAC )
2543 {
2544 operation->iv_required = 0;
2545 mbedtls_cipher_init( &operation->ctx.cmac );
2546 status = PSA_SUCCESS;
2547 }
2548 else
2549#endif /* MBEDTLS_CMAC_C */
2550#if defined(MBEDTLS_MD_C)
2551 if( PSA_ALG_IS_HMAC( operation->alg ) )
2552 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002553 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2554 operation->ctx.hmac.hash_ctx.alg = 0;
2555 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002556 }
2557 else
2558#endif /* MBEDTLS_MD_C */
2559 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002560 if( ! PSA_ALG_IS_MAC( alg ) )
2561 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002562 }
2563
2564 if( status != PSA_SUCCESS )
2565 memset( operation, 0, sizeof( *operation ) );
2566 return( status );
2567}
2568
Gilles Peskine01126fa2018-07-12 17:04:55 +02002569#if defined(MBEDTLS_MD_C)
2570static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2571{
Gilles Peskine3f108122018-12-07 18:14:53 +01002572 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002573 return( psa_hash_abort( &hmac->hash_ctx ) );
2574}
2575#endif /* MBEDTLS_MD_C */
2576
Gilles Peskine8c9def32018-02-08 10:02:12 +01002577psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2578{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002579 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002580 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002581 /* The object has (apparently) been initialized but it is not
2582 * in use. It's ok to call abort on such an object, and there's
2583 * nothing to do. */
2584 return( PSA_SUCCESS );
2585 }
2586 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002587#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002588 if( operation->alg == PSA_ALG_CMAC )
2589 {
2590 mbedtls_cipher_free( &operation->ctx.cmac );
2591 }
2592 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002593#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002594#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002595 if( PSA_ALG_IS_HMAC( operation->alg ) )
2596 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002597 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002598 }
2599 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002600#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002601 {
2602 /* Sanity check (shouldn't happen: operation->alg should
2603 * always have been initialized to a valid value). */
2604 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605 }
Moran Peker41deec42018-04-04 15:43:05 +03002606
Gilles Peskine8c9def32018-02-08 10:02:12 +01002607 operation->alg = 0;
2608 operation->key_set = 0;
2609 operation->iv_set = 0;
2610 operation->iv_required = 0;
2611 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002612 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002613
Gilles Peskine8c9def32018-02-08 10:02:12 +01002614 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002615
2616bad_state:
2617 /* If abort is called on an uninitialized object, we can't trust
2618 * anything. Wipe the object in case it contains confidential data.
2619 * This may result in a memory leak if a pointer gets overwritten,
2620 * but it's too late to do anything about this. */
2621 memset( operation, 0, sizeof( *operation ) );
2622 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002623}
2624
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002625#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002626static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002627 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002628 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002629 const mbedtls_cipher_info_t *cipher_info )
2630{
2631 int ret;
2632
2633 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002634
2635 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2636 if( ret != 0 )
2637 return( ret );
2638
2639 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2640 slot->data.raw.data,
2641 key_bits );
2642 return( ret );
2643}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002644#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002645
Gilles Peskine248051a2018-06-20 16:09:38 +02002646#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002647static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2648 const uint8_t *key,
2649 size_t key_length,
2650 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002651{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002652 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002653 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002654 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002655 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002656 psa_status_t status;
2657
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002658 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2659 * overflow below. This should never trigger if the hash algorithm
2660 * is implemented correctly. */
2661 /* The size checks against the ipad and opad buffers cannot be written
2662 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2663 * because that triggers -Wlogical-op on GCC 7.3. */
2664 if( block_size > sizeof( ipad ) )
2665 return( PSA_ERROR_NOT_SUPPORTED );
2666 if( block_size > sizeof( hmac->opad ) )
2667 return( PSA_ERROR_NOT_SUPPORTED );
2668 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002669 return( PSA_ERROR_NOT_SUPPORTED );
2670
Gilles Peskined223b522018-06-11 18:12:58 +02002671 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002672 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002673 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002674 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002675 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002676 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002677 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002678 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002679 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002680 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002681 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002682 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002683 }
Gilles Peskine96889972018-07-12 17:07:03 +02002684 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2685 * but it is permitted. It is common when HMAC is used in HKDF, for
2686 * example. Don't call `memcpy` in the 0-length because `key` could be
2687 * an invalid pointer which would make the behavior undefined. */
2688 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002689 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002690
Gilles Peskined223b522018-06-11 18:12:58 +02002691 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2692 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002693 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002694 ipad[i] ^= 0x36;
2695 memset( ipad + key_length, 0x36, block_size - key_length );
2696
2697 /* Copy the key material from ipad to opad, flipping the requisite bits,
2698 * and filling the rest of opad with the requisite constant. */
2699 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002700 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2701 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002702
Gilles Peskine01126fa2018-07-12 17:04:55 +02002703 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002704 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002705 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002706
Gilles Peskine01126fa2018-07-12 17:04:55 +02002707 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002708
2709cleanup:
Ron Eldor296eca62019-09-10 15:21:37 +03002710 mbedtls_platform_zeroize( ipad, sizeof(ipad) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002711
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002712 return( status );
2713}
Gilles Peskine248051a2018-06-20 16:09:38 +02002714#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002715
Gilles Peskine89167cb2018-07-08 20:12:23 +02002716static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002717 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002718 psa_algorithm_t alg,
2719 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002720{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002721 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002722 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002723 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002724 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002725 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002726 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002727 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002729 /* A context must be freshly initialized before it can be set up. */
2730 if( operation->alg != 0 )
2731 {
2732 return( PSA_ERROR_BAD_STATE );
2733 }
2734
Gilles Peskined911eb72018-08-14 15:18:45 +02002735 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002736 if( status != PSA_SUCCESS )
2737 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002738 if( is_sign )
2739 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740
Gilles Peskine28f8f302019-07-24 13:30:31 +02002741 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002742 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002743 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002744 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002745
Gilles Peskine8c9def32018-02-08 10:02:12 +01002746#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002747 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002748 {
2749 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002750 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002751 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002752 int ret;
2753 if( cipher_info == NULL )
2754 {
2755 status = PSA_ERROR_NOT_SUPPORTED;
2756 goto exit;
2757 }
2758 operation->mac_size = cipher_info->block_size;
2759 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2760 status = mbedtls_to_psa_error( ret );
2761 }
2762 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002763#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002764#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002765 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002766 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002767 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002768 if( hash_alg == 0 )
2769 {
2770 status = PSA_ERROR_NOT_SUPPORTED;
2771 goto exit;
2772 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002773
2774 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2775 /* Sanity check. This shouldn't fail on a valid configuration. */
2776 if( operation->mac_size == 0 ||
2777 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2778 {
2779 status = PSA_ERROR_NOT_SUPPORTED;
2780 goto exit;
2781 }
2782
Gilles Peskine8e338702019-07-30 20:06:31 +02002783 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002784 {
2785 status = PSA_ERROR_INVALID_ARGUMENT;
2786 goto exit;
2787 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002788
Gilles Peskine01126fa2018-07-12 17:04:55 +02002789 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2790 slot->data.raw.data,
2791 slot->data.raw.bytes,
2792 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002793 }
2794 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002796 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002797 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002798 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002799 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002800
Gilles Peskined911eb72018-08-14 15:18:45 +02002801 if( truncated == 0 )
2802 {
2803 /* The "normal" case: untruncated algorithm. Nothing to do. */
2804 }
2805 else if( truncated < 4 )
2806 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002807 /* A very short MAC is too short for security since it can be
2808 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2809 * so we make this our minimum, even though 32 bits is still
2810 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002811 status = PSA_ERROR_NOT_SUPPORTED;
2812 }
2813 else if( truncated > operation->mac_size )
2814 {
2815 /* It's impossible to "truncate" to a larger length. */
2816 status = PSA_ERROR_INVALID_ARGUMENT;
2817 }
2818 else
2819 operation->mac_size = truncated;
2820
Gilles Peskinefbfac682018-07-08 20:51:54 +02002821exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002822 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002823 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002824 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002825 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002826 else
2827 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002828 operation->key_set = 1;
2829 }
2830 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002831}
2832
Gilles Peskine89167cb2018-07-08 20:12:23 +02002833psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002834 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002835 psa_algorithm_t alg )
2836{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002837 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002838}
2839
2840psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002841 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002842 psa_algorithm_t alg )
2843{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002844 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002845}
2846
Gilles Peskine8c9def32018-02-08 10:02:12 +01002847psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2848 const uint8_t *input,
2849 size_t input_length )
2850{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002851 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002852 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002853 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002854 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002855 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002856 operation->has_input = 1;
2857
Gilles Peskine8c9def32018-02-08 10:02:12 +01002858#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002859 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002860 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002861 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2862 input, input_length );
2863 status = mbedtls_to_psa_error( ret );
2864 }
2865 else
2866#endif /* MBEDTLS_CMAC_C */
2867#if defined(MBEDTLS_MD_C)
2868 if( PSA_ALG_IS_HMAC( operation->alg ) )
2869 {
2870 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2871 input_length );
2872 }
2873 else
2874#endif /* MBEDTLS_MD_C */
2875 {
2876 /* This shouldn't happen if `operation` was initialized by
2877 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002878 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002879 }
2880
Gilles Peskinefbfac682018-07-08 20:51:54 +02002881 if( status != PSA_SUCCESS )
2882 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002883 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002884}
2885
Gilles Peskine01126fa2018-07-12 17:04:55 +02002886#if defined(MBEDTLS_MD_C)
2887static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2888 uint8_t *mac,
2889 size_t mac_size )
2890{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002891 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002892 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2893 size_t hash_size = 0;
2894 size_t block_size = psa_get_hash_block_size( hash_alg );
2895 psa_status_t status;
2896
Gilles Peskine01126fa2018-07-12 17:04:55 +02002897 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2898 if( status != PSA_SUCCESS )
2899 return( status );
2900 /* From here on, tmp needs to be wiped. */
2901
2902 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2903 if( status != PSA_SUCCESS )
2904 goto exit;
2905
2906 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2907 if( status != PSA_SUCCESS )
2908 goto exit;
2909
2910 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2911 if( status != PSA_SUCCESS )
2912 goto exit;
2913
Gilles Peskined911eb72018-08-14 15:18:45 +02002914 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2915 if( status != PSA_SUCCESS )
2916 goto exit;
2917
2918 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002919
2920exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002921 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002922 return( status );
2923}
2924#endif /* MBEDTLS_MD_C */
2925
mohammad16036df908f2018-04-02 08:34:15 -07002926static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002927 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002928 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002929{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002930 if( ! operation->key_set )
2931 return( PSA_ERROR_BAD_STATE );
2932 if( operation->iv_required && ! operation->iv_set )
2933 return( PSA_ERROR_BAD_STATE );
2934
Gilles Peskine8c9def32018-02-08 10:02:12 +01002935 if( mac_size < operation->mac_size )
2936 return( PSA_ERROR_BUFFER_TOO_SMALL );
2937
Gilles Peskine8c9def32018-02-08 10:02:12 +01002938#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002939 if( operation->alg == PSA_ALG_CMAC )
2940 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002941 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2942 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2943 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002944 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002945 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002946 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002947 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002948 else
2949#endif /* MBEDTLS_CMAC_C */
2950#if defined(MBEDTLS_MD_C)
2951 if( PSA_ALG_IS_HMAC( operation->alg ) )
2952 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002953 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002954 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002955 }
2956 else
2957#endif /* MBEDTLS_MD_C */
2958 {
2959 /* This shouldn't happen if `operation` was initialized by
2960 * a setup function. */
2961 return( PSA_ERROR_BAD_STATE );
2962 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002963}
2964
Gilles Peskineacd4be32018-07-08 19:56:25 +02002965psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2966 uint8_t *mac,
2967 size_t mac_size,
2968 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002969{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002970 psa_status_t status;
2971
Jaeden Amero252ef282019-02-15 14:05:35 +00002972 if( operation->alg == 0 )
2973 {
2974 return( PSA_ERROR_BAD_STATE );
2975 }
2976
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002977 /* Fill the output buffer with something that isn't a valid mac
2978 * (barring an attack on the mac and deliberately-crafted input),
2979 * in case the caller doesn't check the return status properly. */
2980 *mac_length = mac_size;
2981 /* If mac_size is 0 then mac may be NULL and then the
2982 * call to memset would have undefined behavior. */
2983 if( mac_size != 0 )
2984 memset( mac, '!', mac_size );
2985
Gilles Peskine89167cb2018-07-08 20:12:23 +02002986 if( ! operation->is_sign )
2987 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002988 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002989 }
mohammad16036df908f2018-04-02 08:34:15 -07002990
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002991 status = psa_mac_finish_internal( operation, mac, mac_size );
2992
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002993 if( status == PSA_SUCCESS )
2994 {
2995 status = psa_mac_abort( operation );
2996 if( status == PSA_SUCCESS )
2997 *mac_length = operation->mac_size;
2998 else
2999 memset( mac, '!', mac_size );
3000 }
3001 else
3002 psa_mac_abort( operation );
3003 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003004}
3005
Gilles Peskineacd4be32018-07-08 19:56:25 +02003006psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3007 const uint8_t *mac,
3008 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003009{
Gilles Peskine828ed142018-06-18 23:25:51 +02003010 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003011 psa_status_t status;
3012
Jaeden Amero252ef282019-02-15 14:05:35 +00003013 if( operation->alg == 0 )
3014 {
3015 return( PSA_ERROR_BAD_STATE );
3016 }
3017
Gilles Peskine89167cb2018-07-08 20:12:23 +02003018 if( operation->is_sign )
3019 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003020 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003021 }
3022 if( operation->mac_size != mac_length )
3023 {
3024 status = PSA_ERROR_INVALID_SIGNATURE;
3025 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003026 }
mohammad16036df908f2018-04-02 08:34:15 -07003027
3028 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003029 actual_mac, sizeof( actual_mac ) );
3030
3031 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3032 status = PSA_ERROR_INVALID_SIGNATURE;
3033
3034cleanup:
3035 if( status == PSA_SUCCESS )
3036 status = psa_mac_abort( operation );
3037 else
3038 psa_mac_abort( operation );
3039
Gilles Peskine3f108122018-12-07 18:14:53 +01003040 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003041
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003042 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003043}
3044
3045
Gilles Peskine20035e32018-02-03 22:44:14 +01003046
Gilles Peskine20035e32018-02-03 22:44:14 +01003047/****************************************************************/
3048/* Asymmetric cryptography */
3049/****************************************************************/
3050
Gilles Peskine2b450e32018-06-27 15:42:46 +02003051#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003052/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003053 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003054static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3055 size_t hash_length,
3056 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003057{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003058 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003059 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003060 *md_alg = mbedtls_md_get_type( md_info );
3061
3062 /* The Mbed TLS RSA module uses an unsigned int for hash length
3063 * parameters. Validate that it fits so that we don't risk an
3064 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003065#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003066 if( hash_length > UINT_MAX )
3067 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003068#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003069
3070#if defined(MBEDTLS_PKCS1_V15)
3071 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3072 * must be correct. */
3073 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3074 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003075 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003076 if( md_info == NULL )
3077 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003078 if( mbedtls_md_get_size( md_info ) != hash_length )
3079 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003080 }
3081#endif /* MBEDTLS_PKCS1_V15 */
3082
3083#if defined(MBEDTLS_PKCS1_V21)
3084 /* PSS requires a hash internally. */
3085 if( PSA_ALG_IS_RSA_PSS( alg ) )
3086 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003087 if( md_info == NULL )
3088 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003089 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003090#endif /* MBEDTLS_PKCS1_V21 */
3091
Gilles Peskine61b91d42018-06-08 16:09:36 +02003092 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003093}
3094
Gilles Peskine2b450e32018-06-27 15:42:46 +02003095static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3096 psa_algorithm_t alg,
3097 const uint8_t *hash,
3098 size_t hash_length,
3099 uint8_t *signature,
3100 size_t signature_size,
3101 size_t *signature_length )
3102{
3103 psa_status_t status;
3104 int ret;
3105 mbedtls_md_type_t md_alg;
3106
3107 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3108 if( status != PSA_SUCCESS )
3109 return( status );
3110
Gilles Peskine630a18a2018-06-29 17:49:35 +02003111 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003112 return( PSA_ERROR_BUFFER_TOO_SMALL );
3113
3114#if defined(MBEDTLS_PKCS1_V15)
3115 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3116 {
3117 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3118 MBEDTLS_MD_NONE );
3119 ret = mbedtls_rsa_pkcs1_sign( rsa,
3120 mbedtls_ctr_drbg_random,
3121 &global_data.ctr_drbg,
3122 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003123 md_alg,
3124 (unsigned int) hash_length,
3125 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003126 signature );
3127 }
3128 else
3129#endif /* MBEDTLS_PKCS1_V15 */
3130#if defined(MBEDTLS_PKCS1_V21)
3131 if( PSA_ALG_IS_RSA_PSS( alg ) )
3132 {
3133 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3134 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3135 mbedtls_ctr_drbg_random,
3136 &global_data.ctr_drbg,
3137 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003138 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003139 (unsigned int) hash_length,
3140 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003141 signature );
3142 }
3143 else
3144#endif /* MBEDTLS_PKCS1_V21 */
3145 {
3146 return( PSA_ERROR_INVALID_ARGUMENT );
3147 }
3148
3149 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003150 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003151 return( mbedtls_to_psa_error( ret ) );
3152}
3153
3154static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3155 psa_algorithm_t alg,
3156 const uint8_t *hash,
3157 size_t hash_length,
3158 const uint8_t *signature,
3159 size_t signature_length )
3160{
3161 psa_status_t status;
3162 int ret;
3163 mbedtls_md_type_t md_alg;
3164
3165 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3166 if( status != PSA_SUCCESS )
3167 return( status );
3168
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003169 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3170 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003171
3172#if defined(MBEDTLS_PKCS1_V15)
3173 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3174 {
3175 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3176 MBEDTLS_MD_NONE );
3177 ret = mbedtls_rsa_pkcs1_verify( rsa,
3178 mbedtls_ctr_drbg_random,
3179 &global_data.ctr_drbg,
3180 MBEDTLS_RSA_PUBLIC,
3181 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003182 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003183 hash,
3184 signature );
3185 }
3186 else
3187#endif /* MBEDTLS_PKCS1_V15 */
3188#if defined(MBEDTLS_PKCS1_V21)
3189 if( PSA_ALG_IS_RSA_PSS( alg ) )
3190 {
3191 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3192 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3193 mbedtls_ctr_drbg_random,
3194 &global_data.ctr_drbg,
3195 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003196 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003197 (unsigned int) hash_length,
3198 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003199 signature );
3200 }
3201 else
3202#endif /* MBEDTLS_PKCS1_V21 */
3203 {
3204 return( PSA_ERROR_INVALID_ARGUMENT );
3205 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003206
3207 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3208 * the rest of the signature is invalid". This has little use in
3209 * practice and PSA doesn't report this distinction. */
3210 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3211 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003212 return( mbedtls_to_psa_error( ret ) );
3213}
3214#endif /* MBEDTLS_RSA_C */
3215
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003216#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003217/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3218 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3219 * (even though these functions don't modify it). */
3220static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3221 psa_algorithm_t alg,
3222 const uint8_t *hash,
3223 size_t hash_length,
3224 uint8_t *signature,
3225 size_t signature_size,
3226 size_t *signature_length )
3227{
3228 int ret;
3229 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003230 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003231 mbedtls_mpi_init( &r );
3232 mbedtls_mpi_init( &s );
3233
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003234 if( signature_size < 2 * curve_bytes )
3235 {
3236 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3237 goto cleanup;
3238 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003239
Gilles Peskinea05219c2018-11-16 16:02:56 +01003240#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003241 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3242 {
3243 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3244 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3245 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003246 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3247 &ecp->d, hash,
3248 hash_length, md_alg,
3249 mbedtls_ctr_drbg_random,
3250 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003251 }
3252 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003253#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003254 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003255 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003256 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3257 hash, hash_length,
3258 mbedtls_ctr_drbg_random,
3259 &global_data.ctr_drbg ) );
3260 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003261
3262 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3263 signature,
3264 curve_bytes ) );
3265 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3266 signature + curve_bytes,
3267 curve_bytes ) );
3268
3269cleanup:
3270 mbedtls_mpi_free( &r );
3271 mbedtls_mpi_free( &s );
3272 if( ret == 0 )
3273 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003274 return( mbedtls_to_psa_error( ret ) );
3275}
3276
3277static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3278 const uint8_t *hash,
3279 size_t hash_length,
3280 const uint8_t *signature,
3281 size_t signature_length )
3282{
3283 int ret;
3284 mbedtls_mpi r, s;
3285 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3286 mbedtls_mpi_init( &r );
3287 mbedtls_mpi_init( &s );
3288
3289 if( signature_length != 2 * curve_bytes )
3290 return( PSA_ERROR_INVALID_SIGNATURE );
3291
3292 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3293 signature,
3294 curve_bytes ) );
3295 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3296 signature + curve_bytes,
3297 curve_bytes ) );
3298
3299 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3300 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003301
3302cleanup:
3303 mbedtls_mpi_free( &r );
3304 mbedtls_mpi_free( &s );
3305 return( mbedtls_to_psa_error( ret ) );
3306}
3307#endif /* MBEDTLS_ECDSA_C */
3308
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003309psa_status_t psa_sign_hash( psa_key_handle_t handle,
3310 psa_algorithm_t alg,
3311 const uint8_t *hash,
3312 size_t hash_length,
3313 uint8_t *signature,
3314 size_t signature_size,
3315 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003316{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003317 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003318 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003319#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3320 const psa_drv_se_t *drv;
3321 psa_drv_se_context_t *drv_context;
3322#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003323
3324 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003325 /* Immediately reject a zero-length signature buffer. This guarantees
3326 * that signature must be a valid pointer. (On the other hand, the hash
3327 * buffer can in principle be empty since it doesn't actually have
3328 * to be a hash.) */
3329 if( signature_size == 0 )
3330 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003331
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003332 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003333 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003334 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003335 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003336 {
3337 status = PSA_ERROR_INVALID_ARGUMENT;
3338 goto exit;
3339 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003340
Gilles Peskineedc64242019-08-07 21:05:07 +02003341#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3342 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3343 {
3344 if( drv->asymmetric == NULL ||
3345 drv->asymmetric->p_sign == NULL )
3346 {
3347 status = PSA_ERROR_NOT_SUPPORTED;
3348 goto exit;
3349 }
3350 status = drv->asymmetric->p_sign( drv_context,
3351 slot->data.se.slot_number,
3352 alg,
3353 hash, hash_length,
3354 signature, signature_size,
3355 signature_length );
3356 }
3357 else
3358#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine20035e32018-02-03 22:44:14 +01003359#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003360 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003361 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003362 status = psa_rsa_sign( slot->data.rsa,
3363 alg,
3364 hash, hash_length,
3365 signature, signature_size,
3366 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003367 }
3368 else
3369#endif /* defined(MBEDTLS_RSA_C) */
3370#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003371 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003372 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003373#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003374 if(
3375#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3376 PSA_ALG_IS_ECDSA( alg )
3377#else
3378 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3379#endif
3380 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003381 status = psa_ecdsa_sign( slot->data.ecp,
3382 alg,
3383 hash, hash_length,
3384 signature, signature_size,
3385 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003386 else
3387#endif /* defined(MBEDTLS_ECDSA_C) */
3388 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003389 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003390 }
itayzafrir5c753392018-05-08 11:18:38 +03003391 }
3392 else
3393#endif /* defined(MBEDTLS_ECP_C) */
3394 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003395 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003396 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003397
3398exit:
3399 /* Fill the unused part of the output buffer (the whole buffer on error,
3400 * the trailing part on success) with something that isn't a valid mac
3401 * (barring an attack on the mac and deliberately-crafted input),
3402 * in case the caller doesn't check the return status properly. */
3403 if( status == PSA_SUCCESS )
3404 memset( signature + *signature_length, '!',
3405 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003406 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003407 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003408 /* If signature_size is 0 then we have nothing to do. We must not call
3409 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003410 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003411}
3412
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003413psa_status_t psa_verify_hash( psa_key_handle_t handle,
3414 psa_algorithm_t alg,
3415 const uint8_t *hash,
3416 size_t hash_length,
3417 const uint8_t *signature,
3418 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003419{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003420 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003421 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003422#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3423 const psa_drv_se_t *drv;
3424 psa_drv_se_context_t *drv_context;
3425#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003426
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003427 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003428 if( status != PSA_SUCCESS )
3429 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003430
Gilles Peskineedc64242019-08-07 21:05:07 +02003431#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3432 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3433 {
3434 if( drv->asymmetric == NULL ||
3435 drv->asymmetric->p_verify == NULL )
3436 return( PSA_ERROR_NOT_SUPPORTED );
3437 return( drv->asymmetric->p_verify( drv_context,
3438 slot->data.se.slot_number,
3439 alg,
3440 hash, hash_length,
3441 signature, signature_length ) );
3442 }
3443 else
3444#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine61b91d42018-06-08 16:09:36 +02003445#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003446 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003447 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003448 return( psa_rsa_verify( slot->data.rsa,
3449 alg,
3450 hash, hash_length,
3451 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003452 }
3453 else
3454#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003455#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003456 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003457 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003458#if defined(MBEDTLS_ECDSA_C)
3459 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003460 return( psa_ecdsa_verify( slot->data.ecp,
3461 hash, hash_length,
3462 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003463 else
3464#endif /* defined(MBEDTLS_ECDSA_C) */
3465 {
3466 return( PSA_ERROR_INVALID_ARGUMENT );
3467 }
itayzafrir5c753392018-05-08 11:18:38 +03003468 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003469 else
3470#endif /* defined(MBEDTLS_ECP_C) */
3471 {
3472 return( PSA_ERROR_NOT_SUPPORTED );
3473 }
3474}
3475
Gilles Peskine072ac562018-06-30 00:21:29 +02003476#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3477static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3478 mbedtls_rsa_context *rsa )
3479{
3480 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3481 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3482 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3483 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3484}
3485#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3486
Gilles Peskinec5487a82018-12-03 18:08:14 +01003487psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003488 psa_algorithm_t alg,
3489 const uint8_t *input,
3490 size_t input_length,
3491 const uint8_t *salt,
3492 size_t salt_length,
3493 uint8_t *output,
3494 size_t output_size,
3495 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003496{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003497 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003498 psa_status_t status;
3499
Darryl Green5cc689a2018-07-24 15:34:10 +01003500 (void) input;
3501 (void) input_length;
3502 (void) salt;
3503 (void) output;
3504 (void) output_size;
3505
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003506 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003507
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003508 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3509 return( PSA_ERROR_INVALID_ARGUMENT );
3510
Gilles Peskine28f8f302019-07-24 13:30:31 +02003511 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003512 if( status != PSA_SUCCESS )
3513 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003514 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3515 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003516 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003517
3518#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003519 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003520 {
3521 mbedtls_rsa_context *rsa = slot->data.rsa;
3522 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003523 if( output_size < mbedtls_rsa_get_len( rsa ) )
Vikas Katariya21599b62019-08-02 12:26:29 +01003524 return( PSA_ERROR_BUFFER_TOO_SMALL );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003525#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003526 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003527 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003528 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3529 mbedtls_ctr_drbg_random,
3530 &global_data.ctr_drbg,
3531 MBEDTLS_RSA_PUBLIC,
3532 input_length,
3533 input,
3534 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003535 }
3536 else
3537#endif /* MBEDTLS_PKCS1_V15 */
3538#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003539 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003540 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003541 psa_rsa_oaep_set_padding_mode( alg, rsa );
3542 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3543 mbedtls_ctr_drbg_random,
3544 &global_data.ctr_drbg,
3545 MBEDTLS_RSA_PUBLIC,
3546 salt, salt_length,
3547 input_length,
3548 input,
3549 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003550 }
3551 else
3552#endif /* MBEDTLS_PKCS1_V21 */
3553 {
3554 return( PSA_ERROR_INVALID_ARGUMENT );
3555 }
3556 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003557 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003558 return( mbedtls_to_psa_error( ret ) );
3559 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003560 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003561#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003562 {
3563 return( PSA_ERROR_NOT_SUPPORTED );
3564 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003565}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003566
Gilles Peskinec5487a82018-12-03 18:08:14 +01003567psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003568 psa_algorithm_t alg,
3569 const uint8_t *input,
3570 size_t input_length,
3571 const uint8_t *salt,
3572 size_t salt_length,
3573 uint8_t *output,
3574 size_t output_size,
3575 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003576{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003577 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003578 psa_status_t status;
3579
Darryl Green5cc689a2018-07-24 15:34:10 +01003580 (void) input;
3581 (void) input_length;
3582 (void) salt;
3583 (void) output;
3584 (void) output_size;
3585
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003586 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003587
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003588 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3589 return( PSA_ERROR_INVALID_ARGUMENT );
3590
Gilles Peskine28f8f302019-07-24 13:30:31 +02003591 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003592 if( status != PSA_SUCCESS )
3593 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003594 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003595 return( PSA_ERROR_INVALID_ARGUMENT );
3596
3597#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003598 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003599 {
3600 mbedtls_rsa_context *rsa = slot->data.rsa;
3601 int ret;
3602
Gilles Peskine630a18a2018-06-29 17:49:35 +02003603 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003604 return( PSA_ERROR_INVALID_ARGUMENT );
3605
3606#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003607 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003608 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003609 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3610 mbedtls_ctr_drbg_random,
3611 &global_data.ctr_drbg,
3612 MBEDTLS_RSA_PRIVATE,
3613 output_length,
3614 input,
3615 output,
3616 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003617 }
3618 else
3619#endif /* MBEDTLS_PKCS1_V15 */
3620#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003621 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003622 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003623 psa_rsa_oaep_set_padding_mode( alg, rsa );
3624 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3625 mbedtls_ctr_drbg_random,
3626 &global_data.ctr_drbg,
3627 MBEDTLS_RSA_PRIVATE,
3628 salt, salt_length,
3629 output_length,
3630 input,
3631 output,
3632 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003633 }
3634 else
3635#endif /* MBEDTLS_PKCS1_V21 */
3636 {
3637 return( PSA_ERROR_INVALID_ARGUMENT );
3638 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003639
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003640 return( mbedtls_to_psa_error( ret ) );
3641 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003642 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003643#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003644 {
3645 return( PSA_ERROR_NOT_SUPPORTED );
3646 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003647}
Gilles Peskine20035e32018-02-03 22:44:14 +01003648
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003649
3650
mohammad1603503973b2018-03-12 15:59:30 +02003651/****************************************************************/
3652/* Symmetric cryptography */
3653/****************************************************************/
3654
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003655/* Initialize the cipher operation structure. Once this function has been
3656 * called, psa_cipher_abort can run and will do the right thing. */
3657static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3658 psa_algorithm_t alg )
3659{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003660 if( ! PSA_ALG_IS_CIPHER( alg ) )
3661 {
3662 memset( operation, 0, sizeof( *operation ) );
3663 return( PSA_ERROR_INVALID_ARGUMENT );
3664 }
3665
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003666 operation->alg = alg;
3667 operation->key_set = 0;
3668 operation->iv_set = 0;
3669 operation->iv_required = 1;
3670 operation->iv_size = 0;
3671 operation->block_size = 0;
3672 mbedtls_cipher_init( &operation->ctx.cipher );
3673 return( PSA_SUCCESS );
3674}
3675
Gilles Peskinee553c652018-06-04 16:22:46 +02003676static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003677 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003678 psa_algorithm_t alg,
3679 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003680{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003681 int ret = 0;
3682 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003683 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003684 size_t key_bits;
3685 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003686 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3687 PSA_KEY_USAGE_ENCRYPT :
3688 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003689
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003690 /* A context must be freshly initialized before it can be set up. */
3691 if( operation->alg != 0 )
3692 {
3693 return( PSA_ERROR_BAD_STATE );
3694 }
3695
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003696 status = psa_cipher_init( operation, alg );
3697 if( status != PSA_SUCCESS )
3698 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003699
Gilles Peskine28f8f302019-07-24 13:30:31 +02003700 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003701 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003702 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003703 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003704
Gilles Peskine8e338702019-07-30 20:06:31 +02003705 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003706 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003707 {
3708 status = PSA_ERROR_NOT_SUPPORTED;
3709 goto exit;
3710 }
mohammad1603503973b2018-03-12 15:59:30 +02003711
mohammad1603503973b2018-03-12 15:59:30 +02003712 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003713 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003714 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003715
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003716#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003717 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003718 {
3719 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003720 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003721 memcpy( keys, slot->data.raw.data, 16 );
3722 memcpy( keys + 16, slot->data.raw.data, 8 );
3723 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3724 keys,
3725 192, cipher_operation );
3726 }
3727 else
3728#endif
3729 {
3730 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3731 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003732 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003733 }
Moran Peker41deec42018-04-04 15:43:05 +03003734 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003735 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003736
mohammad16038481e742018-03-18 13:57:31 +02003737#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003738 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003739 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003740 case PSA_ALG_CBC_NO_PADDING:
3741 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3742 MBEDTLS_PADDING_NONE );
3743 break;
3744 case PSA_ALG_CBC_PKCS7:
3745 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3746 MBEDTLS_PADDING_PKCS7 );
3747 break;
3748 default:
3749 /* The algorithm doesn't involve padding. */
3750 ret = 0;
3751 break;
3752 }
3753 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003754 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003755#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3756
mohammad1603503973b2018-03-12 15:59:30 +02003757 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003758 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003759 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003760 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003761 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003762 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003763 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003764#if defined(MBEDTLS_CHACHA20_C)
3765 else
3766 if( alg == PSA_ALG_CHACHA20 )
3767 operation->iv_size = 12;
3768#endif
mohammad1603503973b2018-03-12 15:59:30 +02003769
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003770exit:
3771 if( status == 0 )
3772 status = mbedtls_to_psa_error( ret );
3773 if( status != 0 )
3774 psa_cipher_abort( operation );
3775 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003776}
3777
Gilles Peskinefe119512018-07-08 21:39:34 +02003778psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003779 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003780 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003781{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003782 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003783}
3784
Gilles Peskinefe119512018-07-08 21:39:34 +02003785psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003786 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003787 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003788{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003789 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003790}
3791
Gilles Peskinefe119512018-07-08 21:39:34 +02003792psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003793 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003794 size_t iv_size,
3795 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003796{
itayzafrir534bd7c2018-08-02 13:56:32 +03003797 psa_status_t status;
3798 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003799 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003800 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003801 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003802 }
Moran Peker41deec42018-04-04 15:43:05 +03003803 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003804 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003805 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003806 goto exit;
3807 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003808 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3809 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003810 if( ret != 0 )
3811 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003812 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003813 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003814 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003815
mohammad16038481e742018-03-18 13:57:31 +02003816 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003817 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003818
Moran Peker395db872018-05-31 14:07:14 +03003819exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003820 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003821 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003822 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003823}
3824
Gilles Peskinefe119512018-07-08 21:39:34 +02003825psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003826 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003827 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003828{
itayzafrir534bd7c2018-08-02 13:56:32 +03003829 psa_status_t status;
3830 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003831 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003832 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003833 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003834 }
Moran Pekera28258c2018-05-29 16:25:04 +03003835 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003836 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003837 status = PSA_ERROR_INVALID_ARGUMENT;
3838 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003839 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003840 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3841 status = mbedtls_to_psa_error( ret );
3842exit:
3843 if( status == PSA_SUCCESS )
3844 operation->iv_set = 1;
3845 else
mohammad1603503973b2018-03-12 15:59:30 +02003846 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003847 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003848}
3849
Gilles Peskinee553c652018-06-04 16:22:46 +02003850psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3851 const uint8_t *input,
3852 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003853 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003854 size_t output_size,
3855 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003856{
itayzafrir534bd7c2018-08-02 13:56:32 +03003857 psa_status_t status;
3858 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003859 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003860
3861 if( operation->alg == 0 )
3862 {
3863 return( PSA_ERROR_BAD_STATE );
3864 }
3865
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003866 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003867 {
3868 /* Take the unprocessed partial block left over from previous
3869 * update calls, if any, plus the input to this call. Remove
3870 * the last partial block, if any. You get the data that will be
3871 * output in this call. */
3872 expected_output_size =
3873 ( operation->ctx.cipher.unprocessed_len + input_length )
3874 / operation->block_size * operation->block_size;
3875 }
3876 else
3877 {
3878 expected_output_size = input_length;
3879 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003880
Gilles Peskine89d789c2018-06-04 17:17:16 +02003881 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003882 {
3883 status = PSA_ERROR_BUFFER_TOO_SMALL;
3884 goto exit;
3885 }
mohammad160382759612018-03-12 18:16:40 +02003886
mohammad1603503973b2018-03-12 15:59:30 +02003887 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003888 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003889 status = mbedtls_to_psa_error( ret );
3890exit:
3891 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003892 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003893 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003894}
3895
Gilles Peskinee553c652018-06-04 16:22:46 +02003896psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3897 uint8_t *output,
3898 size_t output_size,
3899 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003900{
David Saadab4ecc272019-02-14 13:48:10 +02003901 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003902 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003903 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003904
mohammad1603503973b2018-03-12 15:59:30 +02003905 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003906 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003907 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003908 }
3909 if( operation->iv_required && ! operation->iv_set )
3910 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003911 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003912 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003913
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003914 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003915 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3916 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003917 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003918 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003919 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003920 }
3921
Janos Follath315b51c2018-07-09 16:04:51 +01003922 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3923 temp_output_buffer,
3924 output_length );
3925 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003926 {
Janos Follath315b51c2018-07-09 16:04:51 +01003927 status = mbedtls_to_psa_error( cipher_ret );
3928 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003929 }
Janos Follath315b51c2018-07-09 16:04:51 +01003930
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003931 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003932 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003933 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003934 memcpy( output, temp_output_buffer, *output_length );
3935 else
3936 {
Janos Follath315b51c2018-07-09 16:04:51 +01003937 status = PSA_ERROR_BUFFER_TOO_SMALL;
3938 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003939 }
mohammad1603503973b2018-03-12 15:59:30 +02003940
Gilles Peskine3f108122018-12-07 18:14:53 +01003941 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003942 status = psa_cipher_abort( operation );
3943
3944 return( status );
3945
3946error:
3947
3948 *output_length = 0;
3949
Gilles Peskine3f108122018-12-07 18:14:53 +01003950 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003951 (void) psa_cipher_abort( operation );
3952
3953 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003954}
3955
Gilles Peskinee553c652018-06-04 16:22:46 +02003956psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3957{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003958 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003959 {
3960 /* The object has (apparently) been initialized but it is not
3961 * in use. It's ok to call abort on such an object, and there's
3962 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003963 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003964 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003965
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003966 /* Sanity check (shouldn't happen: operation->alg should
3967 * always have been initialized to a valid value). */
3968 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3969 return( PSA_ERROR_BAD_STATE );
3970
mohammad1603503973b2018-03-12 15:59:30 +02003971 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003972
Moran Peker41deec42018-04-04 15:43:05 +03003973 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003974 operation->key_set = 0;
3975 operation->iv_set = 0;
3976 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003977 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003978 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003979
Moran Peker395db872018-05-31 14:07:14 +03003980 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003981}
3982
Gilles Peskinea0655c32018-04-30 17:06:50 +02003983
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003984
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003985
mohammad16035955c982018-04-26 00:53:03 +03003986/****************************************************************/
3987/* AEAD */
3988/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003989
Gilles Peskineedf9a652018-08-17 18:11:56 +02003990typedef struct
3991{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003992 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003993 const mbedtls_cipher_info_t *cipher_info;
3994 union
3995 {
3996#if defined(MBEDTLS_CCM_C)
3997 mbedtls_ccm_context ccm;
3998#endif /* MBEDTLS_CCM_C */
3999#if defined(MBEDTLS_GCM_C)
4000 mbedtls_gcm_context gcm;
4001#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004002#if defined(MBEDTLS_CHACHAPOLY_C)
4003 mbedtls_chachapoly_context chachapoly;
4004#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004005 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004006 psa_algorithm_t core_alg;
4007 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004008 uint8_t tag_length;
4009} aead_operation_t;
4010
Gilles Peskine30a9e412019-01-14 18:36:12 +01004011static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004012{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004013 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004014 {
4015#if defined(MBEDTLS_CCM_C)
4016 case PSA_ALG_CCM:
4017 mbedtls_ccm_free( &operation->ctx.ccm );
4018 break;
4019#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004020#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004021 case PSA_ALG_GCM:
4022 mbedtls_gcm_free( &operation->ctx.gcm );
4023 break;
4024#endif /* MBEDTLS_GCM_C */
4025 }
4026}
4027
4028static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004029 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004030 psa_key_usage_t usage,
4031 psa_algorithm_t alg )
4032{
4033 psa_status_t status;
4034 size_t key_bits;
4035 mbedtls_cipher_id_t cipher_id;
4036
Gilles Peskine28f8f302019-07-24 13:30:31 +02004037 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004038 if( status != PSA_SUCCESS )
4039 return( status );
4040
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004041 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004042
4043 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004044 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004045 &cipher_id );
4046 if( operation->cipher_info == NULL )
4047 return( PSA_ERROR_NOT_SUPPORTED );
4048
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004049 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004050 {
4051#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004052 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4053 operation->core_alg = PSA_ALG_CCM;
4054 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004055 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4056 * The call to mbedtls_ccm_encrypt_and_tag or
4057 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004058 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004059 return( PSA_ERROR_INVALID_ARGUMENT );
4060 mbedtls_ccm_init( &operation->ctx.ccm );
4061 status = mbedtls_to_psa_error(
4062 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
4063 operation->slot->data.raw.data,
4064 (unsigned int) key_bits ) );
4065 if( status != 0 )
4066 goto cleanup;
4067 break;
4068#endif /* MBEDTLS_CCM_C */
4069
4070#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004071 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4072 operation->core_alg = PSA_ALG_GCM;
4073 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004074 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4075 * The call to mbedtls_gcm_crypt_and_tag or
4076 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004077 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004078 return( PSA_ERROR_INVALID_ARGUMENT );
4079 mbedtls_gcm_init( &operation->ctx.gcm );
4080 status = mbedtls_to_psa_error(
4081 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
4082 operation->slot->data.raw.data,
4083 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004084 if( status != 0 )
4085 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004086 break;
4087#endif /* MBEDTLS_GCM_C */
4088
Gilles Peskine26869f22019-05-06 15:25:00 +02004089#if defined(MBEDTLS_CHACHAPOLY_C)
4090 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4091 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4092 operation->full_tag_length = 16;
4093 /* We only support the default tag length. */
4094 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4095 return( PSA_ERROR_NOT_SUPPORTED );
4096 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4097 status = mbedtls_to_psa_error(
4098 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
4099 operation->slot->data.raw.data ) );
4100 if( status != 0 )
4101 goto cleanup;
4102 break;
4103#endif /* MBEDTLS_CHACHAPOLY_C */
4104
Gilles Peskineedf9a652018-08-17 18:11:56 +02004105 default:
4106 return( PSA_ERROR_NOT_SUPPORTED );
4107 }
4108
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004109 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4110 {
4111 status = PSA_ERROR_INVALID_ARGUMENT;
4112 goto cleanup;
4113 }
4114 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004115
Gilles Peskineedf9a652018-08-17 18:11:56 +02004116 return( PSA_SUCCESS );
4117
4118cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004119 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004120 return( status );
4121}
4122
Gilles Peskinec5487a82018-12-03 18:08:14 +01004123psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004124 psa_algorithm_t alg,
4125 const uint8_t *nonce,
4126 size_t nonce_length,
4127 const uint8_t *additional_data,
4128 size_t additional_data_length,
4129 const uint8_t *plaintext,
4130 size_t plaintext_length,
4131 uint8_t *ciphertext,
4132 size_t ciphertext_size,
4133 size_t *ciphertext_length )
4134{
mohammad16035955c982018-04-26 00:53:03 +03004135 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004136 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004137 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004138
mohammad1603f08a5502018-06-03 15:05:47 +03004139 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004140
Gilles Peskinec5487a82018-12-03 18:08:14 +01004141 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004142 if( status != PSA_SUCCESS )
4143 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004144
Gilles Peskineedf9a652018-08-17 18:11:56 +02004145 /* For all currently supported modes, the tag is at the end of the
4146 * ciphertext. */
4147 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4148 {
4149 status = PSA_ERROR_BUFFER_TOO_SMALL;
4150 goto exit;
4151 }
4152 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004153
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004154#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004155 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004156 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004157 status = mbedtls_to_psa_error(
4158 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4159 MBEDTLS_GCM_ENCRYPT,
4160 plaintext_length,
4161 nonce, nonce_length,
4162 additional_data, additional_data_length,
4163 plaintext, ciphertext,
4164 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004165 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004166 else
4167#endif /* MBEDTLS_GCM_C */
4168#if defined(MBEDTLS_CCM_C)
4169 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004170 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004171 status = mbedtls_to_psa_error(
4172 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4173 plaintext_length,
4174 nonce, nonce_length,
4175 additional_data,
4176 additional_data_length,
4177 plaintext, ciphertext,
4178 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004179 }
mohammad16035c8845f2018-05-09 05:40:09 -07004180 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004181#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004182#if defined(MBEDTLS_CHACHAPOLY_C)
4183 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4184 {
4185 if( nonce_length != 12 || operation.tag_length != 16 )
4186 {
4187 status = PSA_ERROR_NOT_SUPPORTED;
4188 goto exit;
4189 }
4190 status = mbedtls_to_psa_error(
4191 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4192 plaintext_length,
4193 nonce,
4194 additional_data,
4195 additional_data_length,
4196 plaintext,
4197 ciphertext,
4198 tag ) );
4199 }
4200 else
4201#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004202 {
mohammad1603554faad2018-06-03 15:07:38 +03004203 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004204 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004205
Gilles Peskineedf9a652018-08-17 18:11:56 +02004206 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4207 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004208
Gilles Peskineedf9a652018-08-17 18:11:56 +02004209exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004210 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004211 if( status == PSA_SUCCESS )
4212 *ciphertext_length = plaintext_length + operation.tag_length;
4213 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004214}
4215
Gilles Peskineee652a32018-06-01 19:23:52 +02004216/* Locate the tag in a ciphertext buffer containing the encrypted data
4217 * followed by the tag. Return the length of the part preceding the tag in
4218 * *plaintext_length. This is the size of the plaintext in modes where
4219 * the encrypted data has the same size as the plaintext, such as
4220 * CCM and GCM. */
4221static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4222 const uint8_t *ciphertext,
4223 size_t ciphertext_length,
4224 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004225 const uint8_t **p_tag )
4226{
4227 size_t payload_length;
4228 if( tag_length > ciphertext_length )
4229 return( PSA_ERROR_INVALID_ARGUMENT );
4230 payload_length = ciphertext_length - tag_length;
4231 if( payload_length > plaintext_size )
4232 return( PSA_ERROR_BUFFER_TOO_SMALL );
4233 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004234 return( PSA_SUCCESS );
4235}
4236
Gilles Peskinec5487a82018-12-03 18:08:14 +01004237psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004238 psa_algorithm_t alg,
4239 const uint8_t *nonce,
4240 size_t nonce_length,
4241 const uint8_t *additional_data,
4242 size_t additional_data_length,
4243 const uint8_t *ciphertext,
4244 size_t ciphertext_length,
4245 uint8_t *plaintext,
4246 size_t plaintext_size,
4247 size_t *plaintext_length )
4248{
mohammad16035955c982018-04-26 00:53:03 +03004249 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004250 aead_operation_t operation;
4251 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004252
Gilles Peskineee652a32018-06-01 19:23:52 +02004253 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004254
Gilles Peskinec5487a82018-12-03 18:08:14 +01004255 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004256 if( status != PSA_SUCCESS )
4257 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004258
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004259 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4260 ciphertext, ciphertext_length,
4261 plaintext_size, &tag );
4262 if( status != PSA_SUCCESS )
4263 goto exit;
4264
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004265#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004266 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004267 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004268 status = mbedtls_to_psa_error(
4269 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4270 ciphertext_length - operation.tag_length,
4271 nonce, nonce_length,
4272 additional_data,
4273 additional_data_length,
4274 tag, operation.tag_length,
4275 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004276 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004277 else
4278#endif /* MBEDTLS_GCM_C */
4279#if defined(MBEDTLS_CCM_C)
4280 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004281 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004282 status = mbedtls_to_psa_error(
4283 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4284 ciphertext_length - operation.tag_length,
4285 nonce, nonce_length,
4286 additional_data,
4287 additional_data_length,
4288 ciphertext, plaintext,
4289 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004290 }
mohammad160339574652018-06-01 04:39:53 -07004291 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004292#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004293#if defined(MBEDTLS_CHACHAPOLY_C)
4294 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4295 {
4296 if( nonce_length != 12 || operation.tag_length != 16 )
4297 {
4298 status = PSA_ERROR_NOT_SUPPORTED;
4299 goto exit;
4300 }
4301 status = mbedtls_to_psa_error(
4302 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4303 ciphertext_length - operation.tag_length,
4304 nonce,
4305 additional_data,
4306 additional_data_length,
4307 tag,
4308 ciphertext,
4309 plaintext ) );
4310 }
4311 else
4312#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004313 {
mohammad1603554faad2018-06-03 15:07:38 +03004314 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004315 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004316
Gilles Peskineedf9a652018-08-17 18:11:56 +02004317 if( status != PSA_SUCCESS && plaintext_size != 0 )
4318 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004319
Gilles Peskineedf9a652018-08-17 18:11:56 +02004320exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004321 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004322 if( status == PSA_SUCCESS )
4323 *plaintext_length = ciphertext_length - operation.tag_length;
4324 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004325}
4326
Gilles Peskinea0655c32018-04-30 17:06:50 +02004327
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004328
Gilles Peskine20035e32018-02-03 22:44:14 +01004329/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004330/* Generators */
4331/****************************************************************/
4332
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004333#define HKDF_STATE_INIT 0 /* no input yet */
4334#define HKDF_STATE_STARTED 1 /* got salt */
4335#define HKDF_STATE_KEYED 2 /* got key */
4336#define HKDF_STATE_OUTPUT 3 /* output started */
4337
Gilles Peskinecbe66502019-05-16 16:59:18 +02004338static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004339 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004340{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004341 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4342 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004343 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004344 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004345}
4346
4347
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004348psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004349{
4350 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004351 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004352 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004353 {
4354 /* The object has (apparently) been initialized but it is not
4355 * in use. It's ok to call abort on such an object, and there's
4356 * nothing to do. */
4357 }
4358 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004359#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004360 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004361 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004362 mbedtls_free( operation->ctx.hkdf.info );
4363 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004364 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004365 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004366 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004367 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004368 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004369 if( operation->ctx.tls12_prf.seed != NULL )
4370 {
4371 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4372 operation->ctx.tls12_prf.seed_length );
4373 mbedtls_free( operation->ctx.tls12_prf.seed );
4374 }
4375
4376 if( operation->ctx.tls12_prf.label != NULL )
4377 {
4378 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4379 operation->ctx.tls12_prf.label_length );
4380 mbedtls_free( operation->ctx.tls12_prf.label );
4381 }
4382
4383 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4384
4385 /* We leave the fields Ai and output_block to be erased safely by the
4386 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004387 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004388 else
4389#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004390 {
4391 status = PSA_ERROR_BAD_STATE;
4392 }
Janos Follath083036a2019-06-11 10:22:26 +01004393 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004394 return( status );
4395}
4396
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004397psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004398 size_t *capacity)
4399{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004400 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004401 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004402 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004403 return PSA_ERROR_BAD_STATE;
4404 }
4405
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004406 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004407 return( PSA_SUCCESS );
4408}
4409
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004410psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004411 size_t capacity )
4412{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004413 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004414 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004415 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004416 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004417 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004418 return( PSA_SUCCESS );
4419}
4420
Gilles Peskinebef7f142018-07-12 17:22:21 +02004421#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004422/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004423 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004424static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004425 psa_algorithm_t hash_alg,
4426 uint8_t *output,
4427 size_t output_length )
4428{
4429 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4430 psa_status_t status;
4431
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004432 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4433 return( PSA_ERROR_BAD_STATE );
4434 hkdf->state = HKDF_STATE_OUTPUT;
4435
Gilles Peskinebef7f142018-07-12 17:22:21 +02004436 while( output_length != 0 )
4437 {
4438 /* Copy what remains of the current block */
4439 uint8_t n = hash_length - hkdf->offset_in_block;
4440 if( n > output_length )
4441 n = (uint8_t) output_length;
4442 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4443 output += n;
4444 output_length -= n;
4445 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004446 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004447 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004448 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004449 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004450 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004451 * object was corrupted or if this function is called directly
4452 * inside the library. */
4453 if( hkdf->block_number == 0xff )
4454 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004455
4456 /* We need a new block */
4457 ++hkdf->block_number;
4458 hkdf->offset_in_block = 0;
4459 status = psa_hmac_setup_internal( &hkdf->hmac,
4460 hkdf->prk, hash_length,
4461 hash_alg );
4462 if( status != PSA_SUCCESS )
4463 return( status );
4464 if( hkdf->block_number != 1 )
4465 {
4466 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4467 hkdf->output_block,
4468 hash_length );
4469 if( status != PSA_SUCCESS )
4470 return( status );
4471 }
4472 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4473 hkdf->info,
4474 hkdf->info_length );
4475 if( status != PSA_SUCCESS )
4476 return( status );
4477 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4478 &hkdf->block_number, 1 );
4479 if( status != PSA_SUCCESS )
4480 return( status );
4481 status = psa_hmac_finish_internal( &hkdf->hmac,
4482 hkdf->output_block,
4483 sizeof( hkdf->output_block ) );
4484 if( status != PSA_SUCCESS )
4485 return( status );
4486 }
4487
4488 return( PSA_SUCCESS );
4489}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004490
Janos Follath7742fee2019-06-17 12:58:10 +01004491static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4492 psa_tls12_prf_key_derivation_t *tls12_prf,
4493 psa_algorithm_t alg )
4494{
4495 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4496 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004497 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4498 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004499
Janos Follath7742fee2019-06-17 12:58:10 +01004500 /* We can't be wanting more output after block 0xff, otherwise
4501 * the capacity check in psa_key_derivation_output_bytes() would have
4502 * prevented this call. It could happen only if the operation
4503 * object was corrupted or if this function is called directly
4504 * inside the library. */
4505 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004506 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004507
4508 /* We need a new block */
4509 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004510 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004511
4512 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4513 *
4514 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4515 *
4516 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4517 * HMAC_hash(secret, A(2) + seed) +
4518 * HMAC_hash(secret, A(3) + seed) + ...
4519 *
4520 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004521 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004522 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004523 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004524 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004525 * is currently extracted as `output_block` and where i is
4526 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004527 */
4528
Janos Follathea29bfb2019-06-19 12:21:20 +01004529 /* Save the hash context before using it, to preserve the hash state with
4530 * only the inner padding in it. We need this, because inner padding depends
4531 * on the key (secret in the RFC's terminology). */
4532 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4533 if( status != PSA_SUCCESS )
4534 goto cleanup;
4535
4536 /* Calculate A(i) where i = tls12_prf->block_number. */
4537 if( tls12_prf->block_number == 1 )
4538 {
4539 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4540 * the variable seed and in this instance means it in the context of the
4541 * P_hash function, where seed = label + seed.) */
4542 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4543 tls12_prf->label, tls12_prf->label_length );
4544 if( status != PSA_SUCCESS )
4545 goto cleanup;
4546 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4547 tls12_prf->seed, tls12_prf->seed_length );
4548 if( status != PSA_SUCCESS )
4549 goto cleanup;
4550 }
4551 else
4552 {
4553 /* A(i) = HMAC_hash(secret, A(i-1)) */
4554 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4555 tls12_prf->Ai, hash_length );
4556 if( status != PSA_SUCCESS )
4557 goto cleanup;
4558 }
4559
4560 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4561 tls12_prf->Ai, hash_length );
4562 if( status != PSA_SUCCESS )
4563 goto cleanup;
4564 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4565 if( status != PSA_SUCCESS )
4566 goto cleanup;
4567
4568 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4569 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4570 tls12_prf->Ai, hash_length );
4571 if( status != PSA_SUCCESS )
4572 goto cleanup;
4573 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4574 tls12_prf->label, tls12_prf->label_length );
4575 if( status != PSA_SUCCESS )
4576 goto cleanup;
4577 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4578 tls12_prf->seed, tls12_prf->seed_length );
4579 if( status != PSA_SUCCESS )
4580 goto cleanup;
4581 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4582 tls12_prf->output_block, hash_length );
4583 if( status != PSA_SUCCESS )
4584 goto cleanup;
4585 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4586 if( status != PSA_SUCCESS )
4587 goto cleanup;
4588
Janos Follath7742fee2019-06-17 12:58:10 +01004589
4590cleanup:
4591
Janos Follathea29bfb2019-06-19 12:21:20 +01004592 cleanup_status = psa_hash_abort( &backup );
4593 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4594 status = cleanup_status;
4595
4596 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004597}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004598
Janos Follath844eb0e2019-06-19 12:10:49 +01004599static psa_status_t psa_key_derivation_tls12_prf_read(
4600 psa_tls12_prf_key_derivation_t *tls12_prf,
4601 psa_algorithm_t alg,
4602 uint8_t *output,
4603 size_t output_length )
4604{
4605 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4606 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4607 psa_status_t status;
4608 uint8_t offset, length;
4609
4610 while( output_length != 0 )
4611 {
4612 /* Check if we have fully processed the current block. */
4613 if( tls12_prf->left_in_block == 0 )
4614 {
4615 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4616 alg );
4617 if( status != PSA_SUCCESS )
4618 return( status );
4619
4620 continue;
4621 }
4622
4623 if( tls12_prf->left_in_block > output_length )
4624 length = (uint8_t) output_length;
4625 else
4626 length = tls12_prf->left_in_block;
4627
4628 offset = hash_length - tls12_prf->left_in_block;
4629 memcpy( output, tls12_prf->output_block + offset, length );
4630 output += length;
4631 output_length -= length;
4632 tls12_prf->left_in_block -= length;
4633 }
4634
4635 return( PSA_SUCCESS );
4636}
Gilles Peskinebef7f142018-07-12 17:22:21 +02004637#endif /* MBEDTLS_MD_C */
4638
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004639psa_status_t psa_key_derivation_output_bytes(
4640 psa_key_derivation_operation_t *operation,
4641 uint8_t *output,
4642 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004643{
4644 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004645 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004646
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004647 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004648 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004649 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004650 return PSA_ERROR_BAD_STATE;
4651 }
4652
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004653 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004654 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004655 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004656 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004657 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004658 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004659 goto exit;
4660 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004661 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004662 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004663 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004664 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004665 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4666 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004667 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004668 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004669 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004670 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004671 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004672
Gilles Peskinebef7f142018-07-12 17:22:21 +02004673#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004674 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004675 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004676 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004677 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004678 output, output_length );
4679 }
Janos Follathadbec812019-06-14 11:05:39 +01004680 else
Janos Follathadbec812019-06-14 11:05:39 +01004681 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004682 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004683 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004684 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004685 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004686 output_length );
4687 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004688 else
4689#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004690 {
4691 return( PSA_ERROR_BAD_STATE );
4692 }
4693
4694exit:
4695 if( status != PSA_SUCCESS )
4696 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004697 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004698 * This allows us to differentiate between exhausted operations and
4699 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4700 * operations. */
4701 psa_algorithm_t alg = operation->alg;
4702 psa_key_derivation_abort( operation );
4703 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004704 memset( output, '!', output_length );
4705 }
4706 return( status );
4707}
4708
Gilles Peskine08542d82018-07-19 17:05:42 +02004709#if defined(MBEDTLS_DES_C)
4710static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4711{
4712 if( data_size >= 8 )
4713 mbedtls_des_key_set_parity( data );
4714 if( data_size >= 16 )
4715 mbedtls_des_key_set_parity( data + 8 );
4716 if( data_size >= 24 )
4717 mbedtls_des_key_set_parity( data + 16 );
4718}
4719#endif /* MBEDTLS_DES_C */
4720
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004721static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004722 psa_key_slot_t *slot,
4723 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004724 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004725{
4726 uint8_t *data = NULL;
4727 size_t bytes = PSA_BITS_TO_BYTES( bits );
4728 psa_status_t status;
4729
Gilles Peskine8e338702019-07-30 20:06:31 +02004730 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004731 return( PSA_ERROR_INVALID_ARGUMENT );
4732 if( bits % 8 != 0 )
4733 return( PSA_ERROR_INVALID_ARGUMENT );
4734 data = mbedtls_calloc( 1, bytes );
4735 if( data == NULL )
4736 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4737
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004738 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004739 if( status != PSA_SUCCESS )
4740 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02004741#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004742 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004743 psa_des_set_key_parity( data, bytes );
4744#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004745 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004746
4747exit:
4748 mbedtls_free( data );
4749 return( status );
4750}
4751
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004752psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004753 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004754 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004755{
4756 psa_status_t status;
4757 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004758 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004759
4760 /* Reject any attempt to create a zero-length key so that we don't
4761 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4762 if( psa_get_key_bits( attributes ) == 0 )
4763 return( PSA_ERROR_INVALID_ARGUMENT );
4764
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004765 if( ! operation->can_output_key )
4766 return( PSA_ERROR_NOT_PERMITTED );
4767
Gilles Peskinedf179142019-07-15 22:02:14 +02004768 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
4769 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004770#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4771 if( driver != NULL )
4772 {
4773 /* Deriving a key in a secure element is not implemented yet. */
4774 status = PSA_ERROR_NOT_SUPPORTED;
4775 }
4776#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004777 if( status == PSA_SUCCESS )
4778 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004779 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004780 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004781 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004782 }
4783 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004784 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004785 if( status != PSA_SUCCESS )
4786 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004787 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004788 *handle = 0;
4789 }
4790 return( status );
4791}
4792
Gilles Peskineeab56e42018-07-12 17:12:33 +02004793
4794
4795/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004796/* Key derivation */
4797/****************************************************************/
4798
Gilles Peskine969c5d62019-01-16 15:53:06 +01004799static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004800 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004801 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004802{
Janos Follath5fe19732019-06-20 15:09:30 +01004803 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4804 * initialisers for this union leave some bytes unspecified.) */
4805 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4806
Gilles Peskine969c5d62019-01-16 15:53:06 +01004807 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004808#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004809 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
4810 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4811 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004812 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004813 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004814 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4815 if( hash_size == 0 )
4816 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004817 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4818 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004819 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004820 {
4821 return( PSA_ERROR_NOT_SUPPORTED );
4822 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004823 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004824 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004825 }
4826#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004827 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004828 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004829}
4830
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004831psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004832 psa_algorithm_t alg )
4833{
4834 psa_status_t status;
4835
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004836 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004837 return( PSA_ERROR_BAD_STATE );
4838
Gilles Peskine6843c292019-01-18 16:44:49 +01004839 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4840 return( PSA_ERROR_INVALID_ARGUMENT );
4841 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004842 {
4843 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004844 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004845 }
4846 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4847 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004848 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004849 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004850 else
4851 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004852
4853 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004854 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004855 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004856}
4857
4858#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004859static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004860 psa_algorithm_t hash_alg,
4861 psa_key_derivation_step_t step,
4862 const uint8_t *data,
4863 size_t data_length )
4864{
4865 psa_status_t status;
4866 switch( step )
4867 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004868 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004869 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004870 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004871 status = psa_hmac_setup_internal( &hkdf->hmac,
4872 data, data_length,
4873 hash_alg );
4874 if( status != PSA_SUCCESS )
4875 return( status );
4876 hkdf->state = HKDF_STATE_STARTED;
4877 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004878 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004879 /* If no salt was provided, use an empty salt. */
4880 if( hkdf->state == HKDF_STATE_INIT )
4881 {
4882 status = psa_hmac_setup_internal( &hkdf->hmac,
4883 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004884 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004885 if( status != PSA_SUCCESS )
4886 return( status );
4887 hkdf->state = HKDF_STATE_STARTED;
4888 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004889 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004890 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004891 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4892 data, data_length );
4893 if( status != PSA_SUCCESS )
4894 return( status );
4895 status = psa_hmac_finish_internal( &hkdf->hmac,
4896 hkdf->prk,
4897 sizeof( hkdf->prk ) );
4898 if( status != PSA_SUCCESS )
4899 return( status );
4900 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4901 hkdf->block_number = 0;
4902 hkdf->state = HKDF_STATE_KEYED;
4903 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004904 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004905 if( hkdf->state == HKDF_STATE_OUTPUT )
4906 return( PSA_ERROR_BAD_STATE );
4907 if( hkdf->info_set )
4908 return( PSA_ERROR_BAD_STATE );
4909 hkdf->info_length = data_length;
4910 if( data_length != 0 )
4911 {
4912 hkdf->info = mbedtls_calloc( 1, data_length );
4913 if( hkdf->info == NULL )
4914 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4915 memcpy( hkdf->info, data, data_length );
4916 }
4917 hkdf->info_set = 1;
4918 return( PSA_SUCCESS );
4919 default:
4920 return( PSA_ERROR_INVALID_ARGUMENT );
4921 }
4922}
Janos Follathb03233e2019-06-11 15:30:30 +01004923
Janos Follathf08e2652019-06-13 09:05:41 +01004924static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4925 const uint8_t *data,
4926 size_t data_length )
4927{
4928 if( prf->state != TLS12_PRF_STATE_INIT )
4929 return( PSA_ERROR_BAD_STATE );
4930
Janos Follathd6dce9f2019-07-04 09:11:38 +01004931 if( data_length != 0 )
4932 {
4933 prf->seed = mbedtls_calloc( 1, data_length );
4934 if( prf->seed == NULL )
4935 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004936
Janos Follathd6dce9f2019-07-04 09:11:38 +01004937 memcpy( prf->seed, data, data_length );
4938 prf->seed_length = data_length;
4939 }
Janos Follathf08e2652019-06-13 09:05:41 +01004940
4941 prf->state = TLS12_PRF_STATE_SEED_SET;
4942
4943 return( PSA_SUCCESS );
4944}
4945
Janos Follath81550542019-06-13 14:26:34 +01004946static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4947 psa_algorithm_t hash_alg,
4948 const uint8_t *data,
4949 size_t data_length )
4950{
4951 psa_status_t status;
4952 if( prf->state != TLS12_PRF_STATE_SEED_SET )
4953 return( PSA_ERROR_BAD_STATE );
4954
4955 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4956 if( status != PSA_SUCCESS )
4957 return( status );
4958
4959 prf->state = TLS12_PRF_STATE_KEY_SET;
4960
4961 return( PSA_SUCCESS );
4962}
4963
Janos Follath6660f0e2019-06-17 08:44:03 +01004964static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4965 psa_tls12_prf_key_derivation_t *prf,
4966 psa_algorithm_t hash_alg,
4967 const uint8_t *data,
4968 size_t data_length )
4969{
4970 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004971 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
4972 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01004973
4974 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4975 return( PSA_ERROR_INVALID_ARGUMENT );
4976
4977 /* Quoting RFC 4279, Section 2:
4978 *
4979 * The premaster secret is formed as follows: if the PSK is N octets
4980 * long, concatenate a uint16 with the value N, N zero octets, a second
4981 * uint16 with the value N, and the PSK itself.
4982 */
4983
Janos Follath40e13932019-06-26 13:22:29 +01004984 *cur++ = ( data_length >> 8 ) & 0xff;
4985 *cur++ = ( data_length >> 0 ) & 0xff;
4986 memset( cur, 0, data_length );
4987 cur += data_length;
4988 *cur++ = pms[0];
4989 *cur++ = pms[1];
4990 memcpy( cur, data, data_length );
4991 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01004992
Janos Follath40e13932019-06-26 13:22:29 +01004993 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01004994
4995 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4996 return( status );
4997}
4998
Janos Follath63028dd2019-06-13 09:15:47 +01004999static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5000 const uint8_t *data,
5001 size_t data_length )
5002{
5003 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5004 return( PSA_ERROR_BAD_STATE );
5005
Janos Follathd6dce9f2019-07-04 09:11:38 +01005006 if( data_length != 0 )
5007 {
5008 prf->label = mbedtls_calloc( 1, data_length );
5009 if( prf->label == NULL )
5010 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005011
Janos Follathd6dce9f2019-07-04 09:11:38 +01005012 memcpy( prf->label, data, data_length );
5013 prf->label_length = data_length;
5014 }
Janos Follath63028dd2019-06-13 09:15:47 +01005015
5016 prf->state = TLS12_PRF_STATE_LABEL_SET;
5017
5018 return( PSA_SUCCESS );
5019}
5020
Janos Follathb03233e2019-06-11 15:30:30 +01005021static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5022 psa_algorithm_t hash_alg,
5023 psa_key_derivation_step_t step,
5024 const uint8_t *data,
5025 size_t data_length )
5026{
Janos Follathb03233e2019-06-11 15:30:30 +01005027 switch( step )
5028 {
Janos Follathf08e2652019-06-13 09:05:41 +01005029 case PSA_KEY_DERIVATION_INPUT_SEED:
5030 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005031 case PSA_KEY_DERIVATION_INPUT_SECRET:
5032 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005033 case PSA_KEY_DERIVATION_INPUT_LABEL:
5034 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005035 default:
5036 return( PSA_ERROR_INVALID_ARGUMENT );
5037 }
5038}
Janos Follath6660f0e2019-06-17 08:44:03 +01005039
5040static psa_status_t psa_tls12_prf_psk_to_ms_input(
5041 psa_tls12_prf_key_derivation_t *prf,
5042 psa_algorithm_t hash_alg,
5043 psa_key_derivation_step_t step,
5044 const uint8_t *data,
5045 size_t data_length )
5046{
5047 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005048 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005049 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5050 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005051 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005052
5053 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5054}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005055#endif /* MBEDTLS_MD_C */
5056
Gilles Peskineb8965192019-09-24 16:21:10 +02005057/** Check whether the given key type is acceptable for the given
5058 * input step of a key derivation.
5059 *
5060 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5061 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5062 * Both secret and non-secret inputs can alternatively have the type
5063 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5064 * that the input was passed as a buffer rather than via a key object.
5065 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005066static int psa_key_derivation_check_input_type(
5067 psa_key_derivation_step_t step,
5068 psa_key_type_t key_type )
5069{
5070 switch( step )
5071 {
5072 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005073 if( key_type == PSA_KEY_TYPE_DERIVE )
5074 return( PSA_SUCCESS );
5075 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005076 return( PSA_SUCCESS );
5077 break;
5078 case PSA_KEY_DERIVATION_INPUT_LABEL:
5079 case PSA_KEY_DERIVATION_INPUT_SALT:
5080 case PSA_KEY_DERIVATION_INPUT_INFO:
5081 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005082 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5083 return( PSA_SUCCESS );
5084 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005085 return( PSA_SUCCESS );
5086 break;
5087 }
5088 return( PSA_ERROR_INVALID_ARGUMENT );
5089}
5090
Janos Follathb80a94e2019-06-12 15:54:46 +01005091static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005092 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005093 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005094 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005095 const uint8_t *data,
5096 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005097{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005098 psa_status_t status;
5099 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5100
5101 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005102 if( status != PSA_SUCCESS )
5103 goto exit;
5104
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005105#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005106 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005107 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005108 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005109 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005110 step, data, data_length );
5111 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005112 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005113 {
Janos Follathb03233e2019-06-11 15:30:30 +01005114 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5115 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5116 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005117 }
5118 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5119 {
5120 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5121 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5122 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005123 }
5124 else
5125#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005126 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005127 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005128 return( PSA_ERROR_BAD_STATE );
5129 }
5130
Gilles Peskine224b0d62019-09-23 18:13:17 +02005131exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005132 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005133 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005134 return( status );
5135}
5136
Janos Follath51f4a0f2019-06-14 11:35:55 +01005137psa_status_t psa_key_derivation_input_bytes(
5138 psa_key_derivation_operation_t *operation,
5139 psa_key_derivation_step_t step,
5140 const uint8_t *data,
5141 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005142{
Gilles Peskineb8965192019-09-24 16:21:10 +02005143 return( psa_key_derivation_input_internal( operation, step,
5144 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005145 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005146}
5147
Janos Follath51f4a0f2019-06-14 11:35:55 +01005148psa_status_t psa_key_derivation_input_key(
5149 psa_key_derivation_operation_t *operation,
5150 psa_key_derivation_step_t step,
5151 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005152{
5153 psa_key_slot_t *slot;
5154 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005155
Gilles Peskine28f8f302019-07-24 13:30:31 +02005156 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005157 PSA_KEY_USAGE_DERIVE,
5158 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005159 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005160 {
5161 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005162 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005163 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005164
5165 /* Passing a key object as a SECRET input unlocks the permission
5166 * to output to a key object. */
5167 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5168 operation->can_output_key = 1;
5169
Janos Follathb80a94e2019-06-12 15:54:46 +01005170 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005171 step, slot->attr.type,
Janos Follathb80a94e2019-06-12 15:54:46 +01005172 slot->data.raw.data,
5173 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005174}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005175
5176
5177
5178/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005179/* Key agreement */
5180/****************************************************************/
5181
Gilles Peskinea05219c2018-11-16 16:02:56 +01005182#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005183static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5184 size_t peer_key_length,
5185 const mbedtls_ecp_keypair *our_key,
5186 uint8_t *shared_secret,
5187 size_t shared_secret_size,
5188 size_t *shared_secret_length )
5189{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005190 mbedtls_ecp_keypair *their_key = NULL;
5191 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005192 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005193 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005194
Jaeden Ameroccdce902019-01-10 11:42:27 +00005195 status = psa_import_ec_public_key(
5196 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5197 peer_key, peer_key_length,
5198 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005199 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005200 goto exit;
5201
Jaeden Amero97271b32019-01-10 19:38:51 +00005202 status = mbedtls_to_psa_error(
5203 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5204 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005205 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005206 status = mbedtls_to_psa_error(
5207 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5208 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005209 goto exit;
5210
Jaeden Amero97271b32019-01-10 19:38:51 +00005211 status = mbedtls_to_psa_error(
5212 mbedtls_ecdh_calc_secret( &ecdh,
5213 shared_secret_length,
5214 shared_secret, shared_secret_size,
5215 mbedtls_ctr_drbg_random,
5216 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005217
5218exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005219 mbedtls_ecdh_free( &ecdh );
Jaeden Ameroccdce902019-01-10 11:42:27 +00005220 mbedtls_ecp_keypair_free( their_key );
5221 mbedtls_free( their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005222 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005223}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005224#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005225
Gilles Peskine01d718c2018-09-18 12:01:02 +02005226#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5227
Gilles Peskine0216fe12019-04-11 21:23:21 +02005228static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5229 psa_key_slot_t *private_key,
5230 const uint8_t *peer_key,
5231 size_t peer_key_length,
5232 uint8_t *shared_secret,
5233 size_t shared_secret_size,
5234 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005235{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005236 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005237 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005238#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005239 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005240 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005241 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005242 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5243 private_key->data.ecp,
5244 shared_secret, shared_secret_size,
5245 shared_secret_length ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005246#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005247 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005248 (void) private_key;
5249 (void) peer_key;
5250 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005251 (void) shared_secret;
5252 (void) shared_secret_size;
5253 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005254 return( PSA_ERROR_NOT_SUPPORTED );
5255 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005256}
5257
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005258/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005259 * to potentially free embedded data structures and wipe confidential data.
5260 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005261static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005262 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005263 psa_key_slot_t *private_key,
5264 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005265 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005266{
5267 psa_status_t status;
5268 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5269 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005270 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005271
5272 /* Step 1: run the secret agreement algorithm to generate the shared
5273 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005274 status = psa_key_agreement_raw_internal( ka_alg,
5275 private_key,
5276 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005277 shared_secret,
5278 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005279 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005280 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005281 goto exit;
5282
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005283 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005284 * the shared secret. A shared secret is permitted wherever a key
5285 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005286 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005287 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005288 shared_secret,
5289 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005290
Gilles Peskine12313cd2018-06-20 00:20:32 +02005291exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005292 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005293 return( status );
5294}
5295
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005296psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005297 psa_key_derivation_step_t step,
5298 psa_key_handle_t private_key,
5299 const uint8_t *peer_key,
5300 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005301{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005302 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005303 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005304 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005305 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005306 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005307 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005308 if( status != PSA_SUCCESS )
5309 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005310 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005311 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005312 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005313 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005314 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005315 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005316}
5317
Gilles Peskinebe697d82019-05-16 18:00:41 +02005318psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5319 psa_key_handle_t private_key,
5320 const uint8_t *peer_key,
5321 size_t peer_key_length,
5322 uint8_t *output,
5323 size_t output_size,
5324 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005325{
5326 psa_key_slot_t *slot;
5327 psa_status_t status;
5328
5329 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5330 {
5331 status = PSA_ERROR_INVALID_ARGUMENT;
5332 goto exit;
5333 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005334 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005335 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005336 if( status != PSA_SUCCESS )
5337 goto exit;
5338
5339 status = psa_key_agreement_raw_internal( alg, slot,
5340 peer_key, peer_key_length,
5341 output, output_size,
5342 output_length );
5343
5344exit:
5345 if( status != PSA_SUCCESS )
5346 {
5347 /* If an error happens and is not handled properly, the output
5348 * may be used as a key to protect sensitive data. Arrange for such
5349 * a key to be random, which is likely to result in decryption or
5350 * verification errors. This is better than filling the buffer with
5351 * some constant data such as zeros, which would result in the data
5352 * being protected with a reproducible, easily knowable key.
5353 */
5354 psa_generate_random( output, output_size );
5355 *output_length = output_size;
5356 }
5357 return( status );
5358}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005359
5360
5361/****************************************************************/
5362/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005363/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005364
Gilles Peskine4c317f42018-07-12 01:24:09 +02005365psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005366 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005367{
Gilles Peskine4c317f42018-07-12 01:24:09 +02005368 int ret;
5369 GUARD_MODULE_INITIALIZED;
5370
Gilles Peskinef181eca2019-08-07 13:49:00 +02005371 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5372 {
5373 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5374 output,
5375 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5376 if( ret != 0 )
5377 return( mbedtls_to_psa_error( ret ) );
5378 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5379 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5380 }
5381
Gilles Peskinee59236f2018-01-27 23:32:46 +01005382 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5383 return( mbedtls_to_psa_error( ret ) );
5384}
5385
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005386#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5387#include "mbedtls/entropy_poll.h"
5388
Gilles Peskine7228da22019-07-15 11:06:15 +02005389psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005390 size_t seed_size )
5391{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005392 if( global_data.initialized )
5393 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005394
5395 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5396 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5397 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5398 return( PSA_ERROR_INVALID_ARGUMENT );
5399
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005400 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005401}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005402#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005403
Gilles Peskinee56e8782019-04-26 17:34:02 +02005404#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5405static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5406 size_t domain_parameters_size,
5407 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005408{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005409 size_t i;
5410 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005411
Gilles Peskinee56e8782019-04-26 17:34:02 +02005412 if( domain_parameters_size == 0 )
5413 {
5414 *exponent = 65537;
5415 return( PSA_SUCCESS );
5416 }
5417
5418 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5419 * support values that fit in a 32-bit integer, which is larger than
5420 * int on just about every platform anyway. */
5421 if( domain_parameters_size > sizeof( acc ) )
5422 return( PSA_ERROR_NOT_SUPPORTED );
5423 for( i = 0; i < domain_parameters_size; i++ )
5424 acc = ( acc << 8 ) | domain_parameters[i];
5425 if( acc > INT_MAX )
5426 return( PSA_ERROR_NOT_SUPPORTED );
5427 *exponent = acc;
5428 return( PSA_SUCCESS );
5429}
5430#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5431
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005432static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005433 psa_key_slot_t *slot, size_t bits,
5434 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005435{
Gilles Peskine8e338702019-07-30 20:06:31 +02005436 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005437
Gilles Peskinee56e8782019-04-26 17:34:02 +02005438 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005439 return( PSA_ERROR_INVALID_ARGUMENT );
5440
Gilles Peskinee59236f2018-01-27 23:32:46 +01005441 if( key_type_is_raw_bytes( type ) )
5442 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005443 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005444 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
5445 if( status != PSA_SUCCESS )
5446 return( status );
5447 status = psa_generate_random( slot->data.raw.data,
5448 slot->data.raw.bytes );
5449 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005450 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005451#if defined(MBEDTLS_DES_C)
5452 if( type == PSA_KEY_TYPE_DES )
5453 psa_des_set_key_parity( slot->data.raw.data,
5454 slot->data.raw.bytes );
5455#endif /* MBEDTLS_DES_C */
5456 }
5457 else
5458
5459#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005460 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005461 {
5462 mbedtls_rsa_context *rsa;
5463 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005464 int exponent;
5465 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005466 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5467 return( PSA_ERROR_NOT_SUPPORTED );
5468 /* Accept only byte-aligned keys, for the same reasons as
5469 * in psa_import_rsa_key(). */
5470 if( bits % 8 != 0 )
5471 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005472 status = psa_read_rsa_exponent( domain_parameters,
5473 domain_parameters_size,
5474 &exponent );
5475 if( status != PSA_SUCCESS )
5476 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005477 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5478 if( rsa == NULL )
5479 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5480 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5481 ret = mbedtls_rsa_gen_key( rsa,
5482 mbedtls_ctr_drbg_random,
5483 &global_data.ctr_drbg,
5484 (unsigned int) bits,
5485 exponent );
5486 if( ret != 0 )
5487 {
5488 mbedtls_rsa_free( rsa );
5489 mbedtls_free( rsa );
5490 return( mbedtls_to_psa_error( ret ) );
5491 }
5492 slot->data.rsa = rsa;
5493 }
5494 else
5495#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5496
5497#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005498 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005499 {
5500 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5501 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5502 const mbedtls_ecp_curve_info *curve_info =
5503 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5504 mbedtls_ecp_keypair *ecp;
5505 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005506 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005507 return( PSA_ERROR_NOT_SUPPORTED );
5508 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5509 return( PSA_ERROR_NOT_SUPPORTED );
5510 if( curve_info->bit_size != bits )
5511 return( PSA_ERROR_INVALID_ARGUMENT );
5512 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5513 if( ecp == NULL )
5514 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5515 mbedtls_ecp_keypair_init( ecp );
5516 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5517 mbedtls_ctr_drbg_random,
5518 &global_data.ctr_drbg );
5519 if( ret != 0 )
5520 {
5521 mbedtls_ecp_keypair_free( ecp );
5522 mbedtls_free( ecp );
5523 return( mbedtls_to_psa_error( ret ) );
5524 }
5525 slot->data.ecp = ecp;
5526 }
5527 else
5528#endif /* MBEDTLS_ECP_C */
5529
5530 return( PSA_ERROR_NOT_SUPPORTED );
5531
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005532 return( PSA_SUCCESS );
5533}
Darryl Green0c6575a2018-11-07 16:05:30 +00005534
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005535psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005536 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005537{
5538 psa_status_t status;
5539 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005540 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02005541
Gilles Peskine0f84d622019-09-12 19:03:13 +02005542 /* Reject any attempt to create a zero-length key so that we don't
5543 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5544 if( psa_get_key_bits( attributes ) == 0 )
5545 return( PSA_ERROR_INVALID_ARGUMENT );
5546
Gilles Peskinedf179142019-07-15 22:02:14 +02005547 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
5548 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005549 if( status != PSA_SUCCESS )
5550 goto exit;
5551
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005552#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5553 if( driver != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00005554 {
Gilles Peskine11792082019-08-06 18:36:36 +02005555 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
5556 size_t pubkey_length = 0; /* We don't support this feature yet */
5557 if( drv->key_management == NULL ||
5558 drv->key_management->p_generate == NULL )
5559 {
5560 status = PSA_ERROR_NOT_SUPPORTED;
5561 goto exit;
5562 }
5563 status = drv->key_management->p_generate(
5564 psa_get_se_driver_context( driver ),
5565 slot->data.se.slot_number, attributes,
5566 NULL, 0, &pubkey_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00005567 }
Gilles Peskine11792082019-08-06 18:36:36 +02005568 else
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005569#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005570 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005571 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005572 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005573 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005574 }
Gilles Peskine11792082019-08-06 18:36:36 +02005575
5576exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005577 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005578 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005579 if( status != PSA_SUCCESS )
5580 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005581 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005582 *handle = 0;
5583 }
Darryl Green0c6575a2018-11-07 16:05:30 +00005584 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005585}
5586
5587
Gilles Peskinee59236f2018-01-27 23:32:46 +01005588
5589/****************************************************************/
5590/* Module setup */
5591/****************************************************************/
5592
Gilles Peskine5e769522018-11-20 21:59:56 +01005593psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5594 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5595 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5596{
5597 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5598 return( PSA_ERROR_BAD_STATE );
5599 global_data.entropy_init = entropy_init;
5600 global_data.entropy_free = entropy_free;
5601 return( PSA_SUCCESS );
5602}
5603
Gilles Peskinee59236f2018-01-27 23:32:46 +01005604void mbedtls_psa_crypto_free( void )
5605{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005606 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005607 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5608 {
5609 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005610 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005611 }
5612 /* Wipe all remaining data, including configuration.
5613 * In particular, this sets all state indicator to the value
5614 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005615 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005616#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005617 /* Unregister all secure element drivers, so that we restart from
5618 * a pristine state. */
5619 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005620#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005621}
5622
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005623#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5624/** Recover a transaction that was interrupted by a power failure.
5625 *
5626 * This function is called during initialization, before psa_crypto_init()
5627 * returns. If this function returns a failure status, the initialization
5628 * fails.
5629 */
5630static psa_status_t psa_crypto_recover_transaction(
5631 const psa_crypto_transaction_t *transaction )
5632{
5633 switch( transaction->unknown.type )
5634 {
5635 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5636 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005637 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005638 * is implemented.
5639 * https://github.com/ARMmbed/mbed-crypto/issues/218
5640 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005641 default:
5642 /* We found an unsupported transaction in the storage.
5643 * We don't know what state the storage is in. Give up. */
5644 return( PSA_ERROR_STORAGE_FAILURE );
5645 }
5646}
5647#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5648
Gilles Peskinee59236f2018-01-27 23:32:46 +01005649psa_status_t psa_crypto_init( void )
5650{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005651 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005652 const unsigned char drbg_seed[] = "PSA";
5653
Gilles Peskinec6b69072018-11-20 21:42:52 +01005654 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005655 if( global_data.initialized != 0 )
5656 return( PSA_SUCCESS );
5657
Gilles Peskine5e769522018-11-20 21:59:56 +01005658 /* Set default configuration if
5659 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5660 if( global_data.entropy_init == NULL )
5661 global_data.entropy_init = mbedtls_entropy_init;
5662 if( global_data.entropy_free == NULL )
5663 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005664
Gilles Peskinec6b69072018-11-20 21:42:52 +01005665 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005666 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01005667#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5668 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5669 /* The PSA entropy injection feature depends on using NV seed as an entropy
5670 * source. Add NV seed as an entropy source for PSA entropy injection. */
5671 mbedtls_entropy_add_source( &global_data.entropy,
5672 mbedtls_nv_seed_poll, NULL,
5673 MBEDTLS_ENTROPY_BLOCK_SIZE,
5674 MBEDTLS_ENTROPY_SOURCE_STRONG );
5675#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01005676 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005677 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005678 status = mbedtls_to_psa_error(
5679 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5680 mbedtls_entropy_func,
5681 &global_data.entropy,
5682 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5683 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005684 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005685 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005686
Gilles Peskine66fb1262018-12-10 16:29:04 +01005687 status = psa_initialize_key_slots( );
5688 if( status != PSA_SUCCESS )
5689 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005690
Gilles Peskined9348f22019-10-01 15:22:29 +02005691#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5692 status = psa_init_all_se_drivers( );
5693 if( status != PSA_SUCCESS )
5694 goto exit;
5695#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5696
Gilles Peskine4b734222019-07-24 15:56:31 +02005697#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005698 status = psa_crypto_load_transaction( );
5699 if( status == PSA_SUCCESS )
5700 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005701 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5702 if( status != PSA_SUCCESS )
5703 goto exit;
5704 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005705 }
5706 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5707 {
5708 /* There's no transaction to complete. It's all good. */
5709 status = PSA_SUCCESS;
5710 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005711#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005712
Gilles Peskinec6b69072018-11-20 21:42:52 +01005713 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005714 global_data.initialized = 1;
5715
5716exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005717 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005718 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005719 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005720}
5721
5722#endif /* MBEDTLS_PSA_CRYPTO_C */