blob: f0fbcdcded590466b58d4edf5476d207aa1386f0 [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:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200454 if( bits == 0 )
455 {
456 raw->bytes = 0;
457 raw->data = NULL;
458 return( PSA_SUCCESS );
459 }
460 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200461#if defined(MBEDTLS_MD_C)
462 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200463#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200464 case PSA_KEY_TYPE_DERIVE:
465 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200466#if defined(MBEDTLS_AES_C)
467 case PSA_KEY_TYPE_AES:
468 if( bits != 128 && bits != 192 && bits != 256 )
469 return( PSA_ERROR_INVALID_ARGUMENT );
470 break;
471#endif
472#if defined(MBEDTLS_CAMELLIA_C)
473 case PSA_KEY_TYPE_CAMELLIA:
474 if( bits != 128 && bits != 192 && bits != 256 )
475 return( PSA_ERROR_INVALID_ARGUMENT );
476 break;
477#endif
478#if defined(MBEDTLS_DES_C)
479 case PSA_KEY_TYPE_DES:
480 if( bits != 64 && bits != 128 && bits != 192 )
481 return( PSA_ERROR_INVALID_ARGUMENT );
482 break;
483#endif
484#if defined(MBEDTLS_ARC4_C)
485 case PSA_KEY_TYPE_ARC4:
486 if( bits < 8 || bits > 2048 )
487 return( PSA_ERROR_INVALID_ARGUMENT );
488 break;
489#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200490#if defined(MBEDTLS_CHACHA20_C)
491 case PSA_KEY_TYPE_CHACHA20:
492 if( bits != 256 )
493 return( PSA_ERROR_INVALID_ARGUMENT );
494 break;
495#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200496 default:
497 return( PSA_ERROR_NOT_SUPPORTED );
498 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200499 if( bits % 8 != 0 )
500 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200501
502 /* Allocate memory for the key */
503 raw->bytes = PSA_BITS_TO_BYTES( bits );
504 raw->data = mbedtls_calloc( 1, raw->bytes );
505 if( raw->data == NULL )
506 {
507 raw->bytes = 0;
508 return( PSA_ERROR_INSUFFICIENT_MEMORY );
509 }
510 return( PSA_SUCCESS );
511}
512
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200513#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100514/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
515 * that are not a multiple of 8) well. For example, there is only
516 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
517 * way to return the exact bit size of a key.
518 * To keep things simple, reject non-byte-aligned key sizes. */
519static psa_status_t psa_check_rsa_key_byte_aligned(
520 const mbedtls_rsa_context *rsa )
521{
522 mbedtls_mpi n;
523 psa_status_t status;
524 mbedtls_mpi_init( &n );
525 status = mbedtls_to_psa_error(
526 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
527 if( status == PSA_SUCCESS )
528 {
529 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
530 status = PSA_ERROR_NOT_SUPPORTED;
531 }
532 mbedtls_mpi_free( &n );
533 return( status );
534}
535
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536static psa_status_t psa_import_rsa_key( psa_key_type_t type,
537 const uint8_t *data,
538 size_t data_length,
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200539 mbedtls_rsa_context **p_rsa )
540{
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000541 psa_status_t status;
542 mbedtls_pk_context pk;
543 mbedtls_rsa_context *rsa;
544 size_t bits;
545
546 mbedtls_pk_init( &pk );
547
548 /* Parse the data. */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200549 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000550 status = mbedtls_to_psa_error(
551 mbedtls_pk_parse_key( &pk, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200552 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000553 status = mbedtls_to_psa_error(
554 mbedtls_pk_parse_public_key( &pk, data, data_length ) );
555 if( status != PSA_SUCCESS )
556 goto exit;
557
558 /* We have something that the pkparse module recognizes. If it is a
559 * valid RSA key, store it. */
560 if( mbedtls_pk_get_type( &pk ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200561 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000562 status = PSA_ERROR_INVALID_ARGUMENT;
563 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200564 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000565
566 rsa = mbedtls_pk_rsa( pk );
567 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
568 * supports non-byte-aligned key sizes, but not well. For example,
569 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
570 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
571 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
572 {
573 status = PSA_ERROR_NOT_SUPPORTED;
574 goto exit;
575 }
576 status = psa_check_rsa_key_byte_aligned( rsa );
577
578exit:
579 /* Free the content of the pk object only on error. */
580 if( status != PSA_SUCCESS )
581 {
582 mbedtls_pk_free( &pk );
583 return( status );
584 }
585
586 /* On success, store the content of the object in the RSA context. */
587 *p_rsa = rsa;
588
589 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200590}
591#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
592
Jaeden Ameroccdce902019-01-10 11:42:27 +0000593#if defined(MBEDTLS_ECP_C)
594
595/* Import a public key given as the uncompressed representation defined by SEC1
596 * 2.3.3 as the content of an ECPoint. */
597static psa_status_t psa_import_ec_public_key( psa_ecc_curve_t curve,
598 const uint8_t *data,
599 size_t data_length,
600 mbedtls_ecp_keypair **p_ecp )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200601{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200602 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000603 mbedtls_ecp_keypair *ecp = NULL;
604 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
605
606 *p_ecp = NULL;
607 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
608 if( ecp == NULL )
609 return( PSA_ERROR_INSUFFICIENT_MEMORY );
610 mbedtls_ecp_keypair_init( ecp );
611
612 /* Load the group. */
613 status = mbedtls_to_psa_error(
614 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
615 if( status != PSA_SUCCESS )
616 goto exit;
617 /* Load the public value. */
618 status = mbedtls_to_psa_error(
619 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
620 data, data_length ) );
621 if( status != PSA_SUCCESS )
622 goto exit;
623
624 /* Check that the point is on the curve. */
625 status = mbedtls_to_psa_error(
626 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
627 if( status != PSA_SUCCESS )
628 goto exit;
629
630 *p_ecp = ecp;
631 return( PSA_SUCCESS );
632
633exit:
634 if( ecp != NULL )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200635 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000636 mbedtls_ecp_keypair_free( ecp );
637 mbedtls_free( ecp );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200638 }
Jaeden Ameroccdce902019-01-10 11:42:27 +0000639 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200640}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000641#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200642
Gilles Peskinef76aa772018-10-29 19:24:33 +0100643#if defined(MBEDTLS_ECP_C)
644/* Import a private key given as a byte string which is the private value
645 * in big-endian order. */
646static psa_status_t psa_import_ec_private_key( psa_ecc_curve_t curve,
647 const uint8_t *data,
648 size_t data_length,
649 mbedtls_ecp_keypair **p_ecp )
650{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100652 mbedtls_ecp_keypair *ecp = NULL;
653 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
654
Gilles Peskine2c86ebc2019-05-13 14:21:57 +0200655 if( PSA_BITS_TO_BYTES( PSA_ECC_CURVE_BITS( curve ) ) != data_length )
656 return( PSA_ERROR_INVALID_ARGUMENT );
657
Gilles Peskinef76aa772018-10-29 19:24:33 +0100658 *p_ecp = NULL;
659 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
660 if( ecp == NULL )
661 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Jaeden Amero83d29392019-01-10 20:17:42 +0000662 mbedtls_ecp_keypair_init( ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100663
664 /* Load the group. */
665 status = mbedtls_to_psa_error(
666 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
667 if( status != PSA_SUCCESS )
668 goto exit;
669 /* Load the secret value. */
670 status = mbedtls_to_psa_error(
671 mbedtls_mpi_read_binary( &ecp->d, data, data_length ) );
672 if( status != PSA_SUCCESS )
673 goto exit;
674 /* Validate the private key. */
675 status = mbedtls_to_psa_error(
676 mbedtls_ecp_check_privkey( &ecp->grp, &ecp->d ) );
677 if( status != PSA_SUCCESS )
678 goto exit;
679 /* Calculate the public key from the private key. */
680 status = mbedtls_to_psa_error(
681 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
682 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
683 if( status != PSA_SUCCESS )
684 goto exit;
685
686 *p_ecp = ecp;
687 return( PSA_SUCCESS );
688
689exit:
690 if( ecp != NULL )
691 {
692 mbedtls_ecp_keypair_free( ecp );
693 mbedtls_free( ecp );
694 }
695 return( status );
696}
697#endif /* defined(MBEDTLS_ECP_C) */
698
Gilles Peskineb46bef22019-07-30 21:32:04 +0200699
700/** Return the size of the key in the given slot, in bits.
701 *
702 * \param[in] slot A key slot.
703 *
704 * \return The key size in bits, read from the metadata in the slot.
705 */
706static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
707{
708 return( slot->attr.bits );
709}
710
711/** Calculate the size of the key in the given slot, in bits.
712 *
713 * \param[in] slot A key slot containing a transparent key.
714 *
715 * \return The key size in bits, calculated from the key data.
716 */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200717static psa_key_bits_t psa_calculate_key_bits( const psa_key_slot_t *slot )
Gilles Peskineb46bef22019-07-30 21:32:04 +0200718{
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200719 size_t bits = 0; /* return 0 on an empty slot */
720
Gilles Peskineb46bef22019-07-30 21:32:04 +0200721 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200722 bits = PSA_BYTES_TO_BITS( slot->data.raw.bytes );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200723#if defined(MBEDTLS_RSA_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200724 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
725 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200726#endif /* defined(MBEDTLS_RSA_C) */
727#if defined(MBEDTLS_ECP_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200728 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
729 bits = slot->data.ecp->grp.pbits;
Gilles Peskineb46bef22019-07-30 21:32:04 +0200730#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200731
732 /* We know that the size fits in psa_key_bits_t thanks to checks
733 * when the key was created. */
734 return( (psa_key_bits_t) bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200735}
736
Gilles Peskine8e338702019-07-30 20:06:31 +0200737/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100738 * previously. This function assumes that the slot does not contain
739 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100740psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
741 const uint8_t *data,
742 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100743{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200744 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100745
Gilles Peskine8e338702019-07-30 20:06:31 +0200746 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100747 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200748 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200749 /* Ensure that the bytes-to-bit conversion didn't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100750 if( data_length > SIZE_MAX / 8 )
751 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200752 /* Enforce a size limit, and in particular ensure that the bit
753 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200754 if( bit_size > PSA_MAX_KEY_BITS )
755 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine8e338702019-07-30 20:06:31 +0200756 status = prepare_raw_data_slot( slot->attr.type, bit_size,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200757 &slot->data.raw );
758 if( status != PSA_SUCCESS )
759 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200760 if( data_length != 0 )
761 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100762 }
763 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100764#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200765 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100766 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200767 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100768 data, data_length,
769 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100770 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200771 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100772 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000773 status = psa_import_ec_public_key(
Gilles Peskine8e338702019-07-30 20:06:31 +0200774 PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Jaeden Ameroccdce902019-01-10 11:42:27 +0000775 data, data_length,
776 &slot->data.ecp );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100777 }
778 else
Gilles Peskine969ac722018-01-28 18:16:59 +0100779#endif /* MBEDTLS_ECP_C */
Jaeden Ameroccdce902019-01-10 11:42:27 +0000780#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200781 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100782 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200783 status = psa_import_rsa_key( slot->attr.type,
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000784 data, data_length,
785 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100786 }
787 else
Jaeden Ameroccdce902019-01-10 11:42:27 +0000788#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100789 {
790 return( PSA_ERROR_NOT_SUPPORTED );
791 }
Darryl Green940d72c2018-07-13 13:18:51 +0100792
Gilles Peskineb46bef22019-07-30 21:32:04 +0200793 if( status == PSA_SUCCESS )
794 {
795 /* Write the actual key size to the slot.
796 * psa_start_key_creation() wrote the size declared by the
797 * caller, which may be 0 (meaning unspecified) or wrong. */
798 slot->attr.bits = psa_calculate_key_bits( slot );
799 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100800 return( status );
801}
802
Gilles Peskinef603c712019-01-19 13:40:11 +0100803/** Calculate the intersection of two algorithm usage policies.
804 *
805 * Return 0 (which allows no operation) on incompatibility.
806 */
807static psa_algorithm_t psa_key_policy_algorithm_intersection(
808 psa_algorithm_t alg1,
809 psa_algorithm_t alg2 )
810{
Gilles Peskine549ea862019-05-22 11:45:59 +0200811 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100812 if( alg1 == alg2 )
813 return( alg1 );
814 /* If the policies are from the same hash-and-sign family, check
815 * if one is a wildcard. If so the other has the specific algorithm. */
816 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
817 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
818 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
819 {
820 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
821 return( alg2 );
822 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
823 return( alg1 );
824 }
825 /* If the policies are incompatible, allow nothing. */
826 return( 0 );
827}
828
Gilles Peskined6f371b2019-05-10 19:33:38 +0200829static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
830 psa_algorithm_t requested_alg )
831{
Gilles Peskine549ea862019-05-22 11:45:59 +0200832 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200833 if( requested_alg == policy_alg )
834 return( 1 );
835 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200836 * and requested_alg is the same hash-and-sign family with any hash,
837 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200838 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
839 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
840 {
841 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
842 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
843 }
844 /* If it isn't permitted, it's forbidden. */
845 return( 0 );
846}
847
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100848/** Test whether a policy permits an algorithm.
849 *
850 * The caller must test usage flags separately.
851 */
852static int psa_key_policy_permits( const psa_key_policy_t *policy,
853 psa_algorithm_t alg )
854{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200855 return( psa_key_algorithm_permits( policy->alg, alg ) ||
856 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100857}
858
Gilles Peskinef603c712019-01-19 13:40:11 +0100859/** Restrict a key policy based on a constraint.
860 *
861 * \param[in,out] policy The policy to restrict.
862 * \param[in] constraint The policy constraint to apply.
863 *
864 * \retval #PSA_SUCCESS
865 * \c *policy contains the intersection of the original value of
866 * \c *policy and \c *constraint.
867 * \retval #PSA_ERROR_INVALID_ARGUMENT
868 * \c *policy and \c *constraint are incompatible.
869 * \c *policy is unchanged.
870 */
871static psa_status_t psa_restrict_key_policy(
872 psa_key_policy_t *policy,
873 const psa_key_policy_t *constraint )
874{
875 psa_algorithm_t intersection_alg =
876 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200877 psa_algorithm_t intersection_alg2 =
878 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100879 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
880 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200881 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
882 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100883 policy->usage &= constraint->usage;
884 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200885 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100886 return( PSA_SUCCESS );
887}
888
Darryl Green06fd18d2018-07-16 11:21:11 +0100889/** Retrieve a slot which must contain a key. The key must have allow all the
890 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
891 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100892static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100893 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100894 psa_key_usage_t usage,
895 psa_algorithm_t alg )
896{
897 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100898 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100899
900 *p_slot = NULL;
901
Gilles Peskinec5487a82018-12-03 18:08:14 +0100902 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100903 if( status != PSA_SUCCESS )
904 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100905
906 /* Enforce that usage policy for the key slot contains all the flags
907 * required by the usage parameter. There is one exception: public
908 * keys can always be exported, so we treat public key objects as
909 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200910 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100911 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +0200912 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +0100913 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914
915 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200916 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100917 return( PSA_ERROR_NOT_PERMITTED );
918
919 *p_slot = slot;
920 return( PSA_SUCCESS );
921}
Darryl Green940d72c2018-07-13 13:18:51 +0100922
Gilles Peskine28f8f302019-07-24 13:30:31 +0200923/** Retrieve a slot which must contain a transparent key.
924 *
925 * A transparent key is a key for which the key material is directly
926 * available, as opposed to a key in a secure element.
927 *
Gilles Peskine60450a42019-07-25 11:32:45 +0200928 * This is a temporary function to use instead of psa_get_key_from_slot()
929 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200930 */
931#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
932static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
933 psa_key_slot_t **p_slot,
934 psa_key_usage_t usage,
935 psa_algorithm_t alg )
936{
937 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
938 if( status != PSA_SUCCESS )
939 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +0200940 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200941 {
942 *p_slot = NULL;
943 return( PSA_ERROR_NOT_SUPPORTED );
944 }
945 return( PSA_SUCCESS );
946}
947#else /* MBEDTLS_PSA_CRYPTO_SE_C */
948/* With no secure element support, all keys are transparent. */
949#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
950 psa_get_key_from_slot( handle, p_slot, usage, alg )
951#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
952
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100953/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100954static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000955{
Gilles Peskine73167e12019-07-12 23:44:37 +0200956#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
957 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000958 {
959 /* No key material to clean. */
960 }
Gilles Peskine73167e12019-07-12 23:44:37 +0200961 else
962#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine8e338702019-07-30 20:06:31 +0200963 if( slot->attr.type == PSA_KEY_TYPE_NONE )
Darryl Green40225ba2018-11-15 14:48:15 +0000964 {
965 /* No key material to clean. */
966 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200967 else if( key_type_is_raw_bytes( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000968 {
969 mbedtls_free( slot->data.raw.data );
970 }
971 else
972#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200973 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000974 {
975 mbedtls_rsa_free( slot->data.rsa );
976 mbedtls_free( slot->data.rsa );
977 }
978 else
979#endif /* defined(MBEDTLS_RSA_C) */
980#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200981 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000982 {
983 mbedtls_ecp_keypair_free( slot->data.ecp );
984 mbedtls_free( slot->data.ecp );
985 }
986 else
987#endif /* defined(MBEDTLS_ECP_C) */
988 {
989 /* Shouldn't happen: the key type is not any type that we
990 * put in. */
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200991 return( PSA_ERROR_CORRUPTION_DETECTED );
Darryl Green40225ba2018-11-15 14:48:15 +0000992 }
993
994 return( PSA_SUCCESS );
995}
996
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100997/** Completely wipe a slot in memory, including its policy.
998 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100999psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001000{
1001 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001002 /* Multipart operations may still be using the key. This is safe
1003 * because all multipart operation objects are independent from
1004 * the key slot: if they need to access the key after the setup
1005 * phase, they have a copy of the key. Note that this means that
1006 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001007 /* At this point, key material and other type-specific content has
1008 * been wiped. Clear remaining metadata. We can call memset and not
1009 * zeroize because the metadata is not particularly sensitive. */
1010 memset( slot, 0, sizeof( *slot ) );
1011 return( status );
1012}
1013
Gilles Peskinec5487a82018-12-03 18:08:14 +01001014psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001015{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001016 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001017 psa_status_t status; /* status of the last operation */
1018 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001019#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1020 psa_se_drv_table_entry_t *driver;
1021#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001022
Gilles Peskinec5487a82018-12-03 18:08:14 +01001023 status = psa_get_key_slot( handle, &slot );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001024 if( status != PSA_SUCCESS )
1025 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001026
1027#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001028 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001029 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001030 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001031 /* For a key in a secure element, we need to do three things:
1032 * remove the key file in internal storage, destroy the
1033 * key inside the secure element, and update the driver's
1034 * persistent data. Start a transaction that will encompass these
1035 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001036 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001037 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001038 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001039 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001040 status = psa_crypto_save_transaction( );
1041 if( status != PSA_SUCCESS )
1042 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001043 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001044 /* We should still try to destroy the key in the secure
1045 * element and the key metadata in storage. This is especially
1046 * important if the error is that the storage is full.
1047 * But how to do it exactly without risking an inconsistent
1048 * state after a reset?
1049 * https://github.com/ARMmbed/mbed-crypto/issues/215
1050 */
1051 overall_status = status;
1052 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001053 }
1054
Gilles Peskine354f7672019-07-12 23:46:38 +02001055 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001056 if( overall_status == PSA_SUCCESS )
1057 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001058 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001059#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1060
Darryl Greend49a4992018-06-18 17:27:26 +01001061#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001062 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001063 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001064 status = psa_destroy_persistent_key( slot->attr.id );
1065 if( overall_status == PSA_SUCCESS )
1066 overall_status = status;
1067
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001068 /* TODO: other slots may have a copy of the same key. We should
1069 * invalidate them.
1070 * https://github.com/ARMmbed/mbed-crypto/issues/214
1071 */
Darryl Greend49a4992018-06-18 17:27:26 +01001072 }
1073#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001074
Gilles Peskinefc762652019-07-22 19:30:34 +02001075#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1076 if( driver != NULL )
1077 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001078 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079 if( overall_status == PSA_SUCCESS )
1080 overall_status = status;
1081 status = psa_crypto_stop_transaction( );
1082 if( overall_status == PSA_SUCCESS )
1083 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001084 }
1085#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1086
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001087#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1088exit:
1089#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001090 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001091 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1092 if( overall_status == PSA_SUCCESS )
1093 overall_status = status;
1094 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001095}
1096
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001097void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001098{
Gilles Peskineb699f072019-04-26 16:06:02 +02001099 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001100 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001101}
1102
Gilles Peskineb699f072019-04-26 16:06:02 +02001103psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1104 psa_key_type_t type,
1105 const uint8_t *data,
1106 size_t data_length )
1107{
1108 uint8_t *copy = NULL;
1109
1110 if( data_length != 0 )
1111 {
1112 copy = mbedtls_calloc( 1, data_length );
1113 if( copy == NULL )
1114 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1115 memcpy( copy, data, data_length );
1116 }
1117 /* After this point, this function is guaranteed to succeed, so it
1118 * can start modifying `*attributes`. */
1119
1120 if( attributes->domain_parameters != NULL )
1121 {
1122 mbedtls_free( attributes->domain_parameters );
1123 attributes->domain_parameters = NULL;
1124 attributes->domain_parameters_size = 0;
1125 }
1126
1127 attributes->domain_parameters = copy;
1128 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001129 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001130 return( PSA_SUCCESS );
1131}
1132
1133psa_status_t psa_get_key_domain_parameters(
1134 const psa_key_attributes_t *attributes,
1135 uint8_t *data, size_t data_size, size_t *data_length )
1136{
1137 if( attributes->domain_parameters_size > data_size )
1138 return( PSA_ERROR_BUFFER_TOO_SMALL );
1139 *data_length = attributes->domain_parameters_size;
1140 if( attributes->domain_parameters_size != 0 )
1141 memcpy( data, attributes->domain_parameters,
1142 attributes->domain_parameters_size );
1143 return( PSA_SUCCESS );
1144}
1145
1146#if defined(MBEDTLS_RSA_C)
1147static psa_status_t psa_get_rsa_public_exponent(
1148 const mbedtls_rsa_context *rsa,
1149 psa_key_attributes_t *attributes )
1150{
1151 mbedtls_mpi mpi;
1152 int ret;
1153 uint8_t *buffer = NULL;
1154 size_t buflen;
1155 mbedtls_mpi_init( &mpi );
1156
1157 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1158 if( ret != 0 )
1159 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001160 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1161 {
1162 /* It's the default value, which is reported as an empty string,
1163 * so there's nothing to do. */
1164 goto exit;
1165 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001166
1167 buflen = mbedtls_mpi_size( &mpi );
1168 buffer = mbedtls_calloc( 1, buflen );
1169 if( buffer == NULL )
1170 {
1171 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1172 goto exit;
1173 }
1174 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1175 if( ret != 0 )
1176 goto exit;
1177 attributes->domain_parameters = buffer;
1178 attributes->domain_parameters_size = buflen;
1179
1180exit:
1181 mbedtls_mpi_free( &mpi );
1182 if( ret != 0 )
1183 mbedtls_free( buffer );
1184 return( mbedtls_to_psa_error( ret ) );
1185}
1186#endif /* MBEDTLS_RSA_C */
1187
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001188/** Retrieve all the publicly-accessible attributes of a key.
1189 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001190psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1191 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001192{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001193 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001194 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001195
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001196 psa_reset_key_attributes( attributes );
1197
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001198 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001199 if( status != PSA_SUCCESS )
1200 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001201
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001202 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001203 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1204 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1205
1206#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1207 if( psa_key_slot_is_external( slot ) )
1208 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1209#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001210
Gilles Peskine8e338702019-07-30 20:06:31 +02001211 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001212 {
1213#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001214 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001215 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001216#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001217 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001218 * is not yet implemented.
1219 * https://github.com/ARMmbed/mbed-crypto/issues/216
1220 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001221 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001222 break;
1223#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001224 status = psa_get_rsa_public_exponent( slot->data.rsa, attributes );
1225 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001226#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001227 default:
1228 /* Nothing else to do. */
1229 break;
1230 }
1231
1232 if( status != PSA_SUCCESS )
1233 psa_reset_key_attributes( attributes );
1234 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001235}
1236
Gilles Peskinec8000c02019-08-02 20:15:51 +02001237#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1238psa_status_t psa_get_key_slot_number(
1239 const psa_key_attributes_t *attributes,
1240 psa_key_slot_number_t *slot_number )
1241{
1242 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1243 {
1244 *slot_number = attributes->slot_number;
1245 return( PSA_SUCCESS );
1246 }
1247 else
1248 return( PSA_ERROR_INVALID_ARGUMENT );
1249}
1250#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1251
Jaeden Ameroccdce902019-01-10 11:42:27 +00001252#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero25384a22019-01-10 10:23:21 +00001253static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1254 unsigned char *buf, size_t size )
1255{
1256 int ret;
1257 unsigned char *c;
1258 size_t len = 0;
1259
1260 c = buf + size;
1261
1262 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1263
1264 return( (int) len );
1265}
Jaeden Ameroccdce902019-01-10 11:42:27 +00001266#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero25384a22019-01-10 10:23:21 +00001267
Gilles Peskinef603c712019-01-19 13:40:11 +01001268static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1269 uint8_t *data,
1270 size_t data_size,
1271 size_t *data_length,
1272 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001273{
Gilles Peskine5d309672019-07-12 23:47:28 +02001274#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1275 const psa_drv_se_t *drv;
1276 psa_drv_se_context_t *drv_context;
1277#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1278
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001279 *data_length = 0;
1280
Gilles Peskine8e338702019-07-30 20:06:31 +02001281 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001282 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001283
Gilles Peskine5d309672019-07-12 23:47:28 +02001284#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001285 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001286 {
1287 psa_drv_se_export_key_t method;
1288 if( drv->key_management == NULL )
1289 return( PSA_ERROR_NOT_SUPPORTED );
1290 method = ( export_public_key ?
1291 drv->key_management->p_export_public :
1292 drv->key_management->p_export );
1293 if( method == NULL )
1294 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001295 return( method( drv_context,
1296 slot->data.se.slot_number,
1297 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001298 }
1299#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1300
Gilles Peskine8e338702019-07-30 20:06:31 +02001301 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001302 {
1303 if( slot->data.raw.bytes > data_size )
1304 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine52b90182018-10-29 19:26:27 +01001305 if( data_size != 0 )
1306 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001307 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
Gilles Peskine52b90182018-10-29 19:26:27 +01001308 memset( data + slot->data.raw.bytes, 0,
1309 data_size - slot->data.raw.bytes );
1310 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001311 *data_length = slot->data.raw.bytes;
1312 return( PSA_SUCCESS );
1313 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001314#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001315 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) && !export_public_key )
Gilles Peskine188c71e2018-10-29 19:26:02 +01001316 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001317 psa_status_t status;
1318
Gilles Peskineb46bef22019-07-30 21:32:04 +02001319 size_t bytes = PSA_BITS_TO_BYTES( slot->attr.bits );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001320 if( bytes > data_size )
1321 return( PSA_ERROR_BUFFER_TOO_SMALL );
1322 status = mbedtls_to_psa_error(
1323 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1324 if( status != PSA_SUCCESS )
1325 return( status );
1326 memset( data + bytes, 0, data_size - bytes );
1327 *data_length = bytes;
1328 return( PSA_SUCCESS );
1329 }
1330#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001331 else
Moran Peker17e36e12018-05-02 12:55:20 +03001332 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001333#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001334 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1335 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001336 {
Moran Pekera998bc62018-04-16 18:16:20 +03001337 mbedtls_pk_context pk;
1338 int ret;
Gilles Peskine8e338702019-07-30 20:06:31 +02001339 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001340 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001341#if defined(MBEDTLS_RSA_C)
1342 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001343 pk.pk_info = &mbedtls_rsa_info;
1344 pk.pk_ctx = slot->data.rsa;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001345#else
1346 return( PSA_ERROR_NOT_SUPPORTED );
1347#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001348 }
1349 else
1350 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001351#if defined(MBEDTLS_ECP_C)
1352 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001353 pk.pk_info = &mbedtls_eckey_info;
1354 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001355#else
1356 return( PSA_ERROR_NOT_SUPPORTED );
1357#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001358 }
Gilles Peskine8e338702019-07-30 20:06:31 +02001359 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero25384a22019-01-10 10:23:21 +00001360 {
Jaeden Ameroccdce902019-01-10 11:42:27 +00001361 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001362 }
Moran Peker17e36e12018-05-02 12:55:20 +03001363 else
Jaeden Amero25384a22019-01-10 10:23:21 +00001364 {
Moran Peker17e36e12018-05-02 12:55:20 +03001365 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001366 }
Moran Peker60364322018-04-29 11:34:58 +03001367 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001368 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001369 /* If data_size is 0 then data may be NULL and then the
1370 * call to memset would have undefined behavior. */
1371 if( data_size != 0 )
1372 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001373 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001374 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001375 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1376 * Move the data to the beginning and erase remaining data
1377 * at the original location. */
1378 if( 2 * (size_t) ret <= data_size )
1379 {
1380 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001381 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001382 }
1383 else if( (size_t) ret < data_size )
1384 {
1385 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001386 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001387 }
Moran Pekera998bc62018-04-16 18:16:20 +03001388 *data_length = ret;
1389 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001390 }
1391 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001392#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001393 {
1394 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001395 it is valid for a special-purpose implementation to omit
1396 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001397 return( PSA_ERROR_NOT_SUPPORTED );
1398 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001399 }
1400}
1401
Gilles Peskinec5487a82018-12-03 18:08:14 +01001402psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001403 uint8_t *data,
1404 size_t data_size,
1405 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001406{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001407 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001408 psa_status_t status;
1409
1410 /* Set the key to empty now, so that even when there are errors, we always
1411 * set data_length to a value between 0 and data_size. On error, setting
1412 * the key to empty is a good choice because an empty key representation is
1413 * unlikely to be accepted anywhere. */
1414 *data_length = 0;
1415
1416 /* Export requires the EXPORT flag. There is an exception for public keys,
1417 * which don't require any flag, but psa_get_key_from_slot takes
1418 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001419 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001420 if( status != PSA_SUCCESS )
1421 return( status );
1422 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001423 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001424}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001425
Gilles Peskinec5487a82018-12-03 18:08:14 +01001426psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001427 uint8_t *data,
1428 size_t data_size,
1429 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001430{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001431 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001432 psa_status_t status;
1433
1434 /* Set the key to empty now, so that even when there are errors, we always
1435 * set data_length to a value between 0 and data_size. On error, setting
1436 * the key to empty is a good choice because an empty key representation is
1437 * unlikely to be accepted anywhere. */
1438 *data_length = 0;
1439
1440 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001441 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001442 if( status != PSA_SUCCESS )
1443 return( status );
1444 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001445 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001446}
1447
Gilles Peskine91e8c332019-08-02 19:19:39 +02001448#if defined(static_assert)
1449static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1450 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001451static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001452 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001453static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001454 "One or more key attribute flag is listed as both internal-only and external-only" );
1455#endif
1456
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001457/** Validate that a key policy is internally well-formed.
1458 *
1459 * This function only rejects invalid policies. It does not validate the
1460 * consistency of the policy with respect to other attributes of the key
1461 * such as the key type.
1462 */
1463static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001464{
1465 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001466 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001467 PSA_KEY_USAGE_ENCRYPT |
1468 PSA_KEY_USAGE_DECRYPT |
1469 PSA_KEY_USAGE_SIGN |
1470 PSA_KEY_USAGE_VERIFY |
1471 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1472 return( PSA_ERROR_INVALID_ARGUMENT );
1473
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 return( PSA_SUCCESS );
1475}
1476
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001477/** Validate the internal consistency of key attributes.
1478 *
1479 * This function only rejects invalid attribute values. If does not
1480 * validate the consistency of the attributes with any key data that may
1481 * be involved in the creation of the key.
1482 *
1483 * Call this function early in the key creation process.
1484 *
1485 * \param[in] attributes Key attributes for the new key.
1486 * \param[out] p_drv On any return, the driver for the key, if any.
1487 * NULL for a transparent key.
1488 *
1489 */
1490static psa_status_t psa_validate_key_attributes(
1491 const psa_key_attributes_t *attributes,
1492 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001493{
1494 psa_status_t status;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001495
1496 if( attributes->core.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Green0c6575a2018-11-07 16:05:30 +00001497 {
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001498 status = psa_validate_persistent_key_parameters(
1499 attributes->core.lifetime, attributes->core.id,
1500 p_drv, 1 );
1501 if( status != PSA_SUCCESS )
1502 return( status );
Darryl Green0c6575a2018-11-07 16:05:30 +00001503 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001504
1505 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001506 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001507 return( status );
1508
1509 /* Refuse to create overly large keys.
1510 * Note that this doesn't trigger on import if the attributes don't
1511 * explicitly specify a size (so psa_get_key_bits returns 0), so
1512 * psa_import_key() needs its own checks. */
1513 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1514 return( PSA_ERROR_NOT_SUPPORTED );
1515
Gilles Peskine91e8c332019-08-02 19:19:39 +02001516 /* Reject invalid flags. These should not be reachable through the API. */
1517 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1518 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1519 return( PSA_ERROR_INVALID_ARGUMENT );
1520
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001521 return( PSA_SUCCESS );
1522}
1523
Gilles Peskine4747d192019-04-17 15:05:45 +02001524/** Prepare a key slot to receive key material.
1525 *
1526 * This function allocates a key slot and sets its metadata.
1527 *
1528 * If this function fails, call psa_fail_key_creation().
1529 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001530 * This function is intended to be used as follows:
1531 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1532 * it with the specified attributes, and assign it a handle.
1533 * -# Populate the slot with the key material.
1534 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1535 * In case of failure at any step, stop the sequence and call
1536 * psa_fail_key_creation().
1537 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001538 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001539 * \param[in] attributes Key attributes for the new key.
1540 * \param[out] handle On success, a handle for the allocated slot.
1541 * \param[out] p_slot On success, a pointer to the prepared slot.
1542 * \param[out] p_drv On any return, the driver for the key, if any.
1543 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001544 *
1545 * \retval #PSA_SUCCESS
1546 * The key slot is ready to receive key material.
1547 * \return If this function fails, the key slot is an invalid state.
1548 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001549 */
1550static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001551 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001552 const psa_key_attributes_t *attributes,
1553 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001554 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001555 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001556{
1557 psa_status_t status;
1558 psa_key_slot_t *slot;
1559
Gilles Peskinedf179142019-07-15 22:02:14 +02001560 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001561 *p_drv = NULL;
1562
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001563 status = psa_validate_key_attributes( attributes, p_drv );
1564 if( status != PSA_SUCCESS )
1565 return( status );
1566
Gilles Peskineedbed562019-08-07 18:19:59 +02001567 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001568 if( status != PSA_SUCCESS )
1569 return( status );
1570 slot = *p_slot;
1571
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001572 /* We're storing the declared bit-size of the key. It's up to each
1573 * creation mechanism to verify that this information is correct.
1574 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001575 * an input (generate, device) but not for those where the bit-size
1576 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001577
1578 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001579
Gilles Peskine91e8c332019-08-02 19:19:39 +02001580 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001581 * external-only flags, query `attributes`. Thanks to the check
1582 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001583 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001584 * may have set. */
1585 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001586
Gilles Peskinecbaff462019-07-12 23:46:04 +02001587#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001588 /* For a key in a secure element, we need to do three things
1589 * when creating a key (but not when registering an existing key):
Gilles Peskine60450a42019-07-25 11:32:45 +02001590 * create the key file in internal storage, create the
1591 * key inside the secure element, and update the driver's
1592 * persistent data. Start a transaction that will encompass these
1593 * three actions. */
1594 /* The first thing to do is to find a slot number for the new key.
1595 * We save the slot number in persistent storage as part of the
1596 * transaction data. It will be needed to recover if the power
1597 * fails during the key creation process, to clean up on the secure
1598 * element side after restarting. Obtaining a slot number from the
1599 * secure element driver updates its persistent state, but we do not yet
1600 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001601 * we can roll back to a state where the key doesn't exist. */
Gilles Peskined7729582019-08-05 15:55:54 +02001602 if( *p_drv != NULL && method != PSA_KEY_CREATION_REGISTER )
Darryl Green0c6575a2018-11-07 16:05:30 +00001603 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001604 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001605 &slot->data.se.slot_number );
1606 if( status != PSA_SUCCESS )
1607 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001608 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001609 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001610 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001611 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001612 status = psa_crypto_save_transaction( );
1613 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001614 {
1615 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001616 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001617 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001618 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001619#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1620
Darryl Green0c6575a2018-11-07 16:05:30 +00001621 return( status );
1622}
Gilles Peskine4747d192019-04-17 15:05:45 +02001623
1624/** Finalize the creation of a key once its key material has been set.
1625 *
1626 * This entails writing the key to persistent storage.
1627 *
1628 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001629 * See the documentation of psa_start_key_creation() for the intended use
1630 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001631 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001632 * \param[in,out] slot Pointer to the slot with key material.
1633 * \param[in] driver The secure element driver for the key,
1634 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001635 *
1636 * \retval #PSA_SUCCESS
1637 * The key was successfully created. The handle is now valid.
1638 * \return If this function fails, the key slot is an invalid state.
1639 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001640 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001641static psa_status_t psa_finish_key_creation(
1642 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001643 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001644{
1645 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001646 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001647 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001648
1649#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001650 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001651 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001652#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1653 if( driver != NULL )
1654 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001655 psa_se_key_data_storage_t data;
1656#if defined(static_assert)
1657 static_assert( sizeof( slot->data.se.slot_number ) ==
1658 sizeof( data.slot_number ),
1659 "Slot number size does not match psa_se_key_data_storage_t" );
1660 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1661 "Bit-size size does not match psa_se_key_data_storage_t" );
1662#endif
1663 memcpy( &data.slot_number, &slot->data.se.slot_number,
1664 sizeof( slot->data.se.slot_number ) );
1665 memcpy( &data.bits, &slot->attr.bits,
1666 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001667 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001668 (uint8_t*) &data,
1669 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001670 }
1671 else
1672#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1673 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001674 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001675 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001676 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001677 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1678 size_t length = 0;
Gilles Peskine1df83d42019-07-23 16:13:14 +02001679 if( buffer == NULL && buffer_size != 0 )
1680 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1681 status = psa_internal_export_key( slot,
1682 buffer, buffer_size, &length,
1683 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001684 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001685 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001686 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001687
Gilles Peskine1df83d42019-07-23 16:13:14 +02001688 if( buffer_size != 0 )
1689 mbedtls_platform_zeroize( buffer, buffer_size );
1690 mbedtls_free( buffer );
1691 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001692 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001693#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1694
Gilles Peskinecbaff462019-07-12 23:46:04 +02001695#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001696 /* Finish the transaction for a key creation. This does not
1697 * happen when registering an existing key. Detect this case
1698 * by checking whether a transaction is in progress (actual
1699 * creation of a key in a secure element requires a transaction,
1700 * but registration doesn't use one). */
1701 if( driver != NULL &&
1702 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001703 {
1704 status = psa_save_se_persistent_data( driver );
1705 if( status != PSA_SUCCESS )
1706 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001707 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001708 return( status );
1709 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001710 status = psa_crypto_stop_transaction( );
1711 if( status != PSA_SUCCESS )
1712 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001713 }
1714#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1715
Gilles Peskine4747d192019-04-17 15:05:45 +02001716 return( status );
1717}
1718
1719/** Abort the creation of a key.
1720 *
1721 * You may call this function after calling psa_start_key_creation(),
1722 * or after psa_finish_key_creation() fails. In other circumstances, this
1723 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001724 * See the documentation of psa_start_key_creation() for the intended use
1725 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001727 * \param[in,out] slot Pointer to the slot with key material.
1728 * \param[in] driver The secure element driver for the key,
1729 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001730 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001731static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001732 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001733{
Gilles Peskine011e4282019-06-26 18:34:38 +02001734 (void) driver;
1735
Gilles Peskine4747d192019-04-17 15:05:45 +02001736 if( slot == NULL )
1737 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001738
1739#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001740 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001741 * element, and the failure happened later (when saving metadata
1742 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001743 * element.
1744 * https://github.com/ARMmbed/mbed-crypto/issues/217
1745 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001746
Gilles Peskined7729582019-08-05 15:55:54 +02001747 /* Abort the ongoing transaction if any (there may not be one if
1748 * the creation process failed before starting one, or if the
1749 * key creation is a registration of a key in a secure element).
1750 * Earlier functions must already have done what it takes to undo any
1751 * partial creation. All that's left is to update the transaction data
1752 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001753 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001754#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1755
Gilles Peskine4747d192019-04-17 15:05:45 +02001756 psa_wipe_key_slot( slot );
1757}
1758
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001759/** Validate optional attributes during key creation.
1760 *
1761 * Some key attributes are optional during key creation. If they are
1762 * specified in the attributes structure, check that they are consistent
1763 * with the data in the slot.
1764 *
1765 * This function should be called near the end of key creation, after
1766 * the slot in memory is fully populated but before saving persistent data.
1767 */
1768static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001769 const psa_key_slot_t *slot,
1770 const psa_key_attributes_t *attributes )
1771{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001772 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001773 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001774 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001775 return( PSA_ERROR_INVALID_ARGUMENT );
1776 }
1777
1778 if( attributes->domain_parameters_size != 0 )
1779 {
1780#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001781 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001782 {
1783 mbedtls_mpi actual, required;
1784 int ret;
1785 mbedtls_mpi_init( &actual );
1786 mbedtls_mpi_init( &required );
1787 ret = mbedtls_rsa_export( slot->data.rsa,
1788 NULL, NULL, NULL, NULL, &actual );
1789 if( ret != 0 )
1790 goto rsa_exit;
1791 ret = mbedtls_mpi_read_binary( &required,
1792 attributes->domain_parameters,
1793 attributes->domain_parameters_size );
1794 if( ret != 0 )
1795 goto rsa_exit;
1796 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1797 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1798 rsa_exit:
1799 mbedtls_mpi_free( &actual );
1800 mbedtls_mpi_free( &required );
1801 if( ret != 0)
1802 return( mbedtls_to_psa_error( ret ) );
1803 }
1804 else
1805#endif
1806 {
1807 return( PSA_ERROR_INVALID_ARGUMENT );
1808 }
1809 }
1810
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001811 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001812 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001813 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001814 return( PSA_ERROR_INVALID_ARGUMENT );
1815 }
1816
1817 return( PSA_SUCCESS );
1818}
1819
Gilles Peskine4747d192019-04-17 15:05:45 +02001820psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001822 size_t data_length,
1823 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001824{
1825 psa_status_t status;
1826 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001827 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001828
Gilles Peskine0f84d622019-09-12 19:03:13 +02001829 /* Reject zero-length symmetric keys (including raw data key objects).
1830 * This also rejects any key which might be encoded as an empty string,
1831 * which is never valid. */
1832 if( data_length == 0 )
1833 return( PSA_ERROR_INVALID_ARGUMENT );
1834
Gilles Peskinedf179142019-07-15 22:02:14 +02001835 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
1836 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001837 if( status != PSA_SUCCESS )
1838 goto exit;
1839
Gilles Peskine5d309672019-07-12 23:47:28 +02001840#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1841 if( driver != NULL )
1842 {
1843 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001844 /* The driver should set the number of key bits, however in
1845 * case it doesn't, we initialize bits to an invalid value. */
1846 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001847 if( drv->key_management == NULL ||
1848 drv->key_management->p_import == NULL )
1849 {
1850 status = PSA_ERROR_NOT_SUPPORTED;
1851 goto exit;
1852 }
1853 status = drv->key_management->p_import(
1854 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02001855 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001856 &bits );
1857 if( status != PSA_SUCCESS )
1858 goto exit;
1859 if( bits > PSA_MAX_KEY_BITS )
1860 {
1861 status = PSA_ERROR_NOT_SUPPORTED;
1862 goto exit;
1863 }
1864 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001865 }
1866 else
1867#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1868 {
1869 status = psa_import_key_into_slot( slot, data, data_length );
1870 if( status != PSA_SUCCESS )
1871 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001872 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001873 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001874 if( status != PSA_SUCCESS )
1875 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001876
Gilles Peskine011e4282019-06-26 18:34:38 +02001877 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001878exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001879 if( status != PSA_SUCCESS )
1880 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001882 *handle = 0;
1883 }
1884 return( status );
1885}
1886
Gilles Peskined7729582019-08-05 15:55:54 +02001887#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1888psa_status_t mbedtls_psa_register_se_key(
1889 const psa_key_attributes_t *attributes )
1890{
1891 psa_status_t status;
1892 psa_key_slot_t *slot = NULL;
1893 psa_se_drv_table_entry_t *driver = NULL;
1894 const psa_drv_se_t *drv;
1895 psa_key_handle_t handle = 0;
1896
1897 /* Leaving attributes unspecified is not currently supported.
1898 * It could make sense to query the key type and size from the
1899 * secure element, but not all secure elements support this
1900 * and the driver HAL doesn't currently support it. */
1901 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1902 return( PSA_ERROR_NOT_SUPPORTED );
1903 if( psa_get_key_bits( attributes ) == 0 )
1904 return( PSA_ERROR_NOT_SUPPORTED );
1905
1906 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
1907 &handle, &slot, &driver );
1908 if( status != PSA_SUCCESS )
1909 goto exit;
1910
1911 if( driver == NULL )
1912 {
1913 status = PSA_ERROR_INVALID_ARGUMENT;
1914 goto exit;
1915 }
1916 drv = psa_get_se_driver_methods( driver );
1917
1918 if ( psa_get_key_slot_number( attributes,
1919 &slot->data.se.slot_number ) != PSA_SUCCESS )
1920 {
1921 /* The application didn't specify a slot number. This doesn't
1922 * make sense when registering a slot. */
1923 status = PSA_ERROR_INVALID_ARGUMENT;
1924 goto exit;
1925 }
1926
Gilles Peskinea5f87492019-08-05 16:46:18 +02001927 /* If the driver has a slot number validation method, call it.
1928 * If it doesn't, it means the secure element is unable to validate
1929 * anything and so we have to trust the application. */
1930 if( drv->key_management != NULL &&
1931 drv->key_management->p_validate_slot_number != NULL )
1932 {
1933 status = drv->key_management->p_validate_slot_number(
1934 psa_get_se_driver_context( driver ),
1935 attributes,
1936 PSA_KEY_CREATION_REGISTER,
1937 slot->data.se.slot_number );
1938 if( status != PSA_SUCCESS )
1939 goto exit;
1940 }
1941
Gilles Peskined7729582019-08-05 15:55:54 +02001942 status = psa_finish_key_creation( slot, driver );
1943
1944exit:
1945 if( status != PSA_SUCCESS )
1946 {
1947 psa_fail_key_creation( slot, driver );
1948 }
1949 /* Registration doesn't keep the key in RAM. */
1950 psa_close_key( handle );
1951 return( status );
1952}
1953#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1954
Gilles Peskinef603c712019-01-19 13:40:11 +01001955static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001956 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001957{
1958 psa_status_t status;
1959 uint8_t *buffer = NULL;
1960 size_t buffer_size = 0;
1961 size_t length;
1962
Gilles Peskine8e338702019-07-30 20:06:31 +02001963 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001964 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01001965 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001966 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001967 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01001968 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1969 if( status != PSA_SUCCESS )
1970 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001971 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001972 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01001973
1974exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001975 if( buffer_size != 0 )
1976 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001977 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01001978 return( status );
1979}
1980
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001981psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1982 const psa_key_attributes_t *specified_attributes,
1983 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01001984{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001985 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01001986 psa_key_slot_t *source_slot = NULL;
1987 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001988 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001989 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001990
Gilles Peskine28f8f302019-07-24 13:30:31 +02001991 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001992 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001993 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001994 goto exit;
1995
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001996 status = psa_validate_optional_attributes( source_slot,
1997 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001998 if( status != PSA_SUCCESS )
1999 goto exit;
2000
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002001 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002002 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002003 if( status != PSA_SUCCESS )
2004 goto exit;
2005
Gilles Peskinedf179142019-07-15 22:02:14 +02002006 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2007 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002008 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002009 if( status != PSA_SUCCESS )
2010 goto exit;
2011
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002012#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2013 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002014 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002015 /* Copying to a secure element is not implemented yet. */
2016 status = PSA_ERROR_NOT_SUPPORTED;
2017 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002018 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002019#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002020
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002021 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002022 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002024
Gilles Peskine011e4282019-06-26 18:34:38 +02002025 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002026exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002027 if( status != PSA_SUCCESS )
2028 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002029 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002030 *target_handle = 0;
2031 }
2032 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002033}
2034
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002035
2036
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002037/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002038/* Message digests */
2039/****************************************************************/
2040
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002041static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002042{
2043 switch( alg )
2044 {
2045#if defined(MBEDTLS_MD2_C)
2046 case PSA_ALG_MD2:
2047 return( &mbedtls_md2_info );
2048#endif
2049#if defined(MBEDTLS_MD4_C)
2050 case PSA_ALG_MD4:
2051 return( &mbedtls_md4_info );
2052#endif
2053#if defined(MBEDTLS_MD5_C)
2054 case PSA_ALG_MD5:
2055 return( &mbedtls_md5_info );
2056#endif
2057#if defined(MBEDTLS_RIPEMD160_C)
2058 case PSA_ALG_RIPEMD160:
2059 return( &mbedtls_ripemd160_info );
2060#endif
2061#if defined(MBEDTLS_SHA1_C)
2062 case PSA_ALG_SHA_1:
2063 return( &mbedtls_sha1_info );
2064#endif
2065#if defined(MBEDTLS_SHA256_C)
2066 case PSA_ALG_SHA_224:
2067 return( &mbedtls_sha224_info );
2068 case PSA_ALG_SHA_256:
2069 return( &mbedtls_sha256_info );
2070#endif
2071#if defined(MBEDTLS_SHA512_C)
2072 case PSA_ALG_SHA_384:
2073 return( &mbedtls_sha384_info );
2074 case PSA_ALG_SHA_512:
2075 return( &mbedtls_sha512_info );
2076#endif
2077 default:
2078 return( NULL );
2079 }
2080}
2081
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002082psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2083{
2084 switch( operation->alg )
2085 {
Gilles Peskine81736312018-06-26 15:04:31 +02002086 case 0:
2087 /* The object has (apparently) been initialized but it is not
2088 * in use. It's ok to call abort on such an object, and there's
2089 * nothing to do. */
2090 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002091#if defined(MBEDTLS_MD2_C)
2092 case PSA_ALG_MD2:
2093 mbedtls_md2_free( &operation->ctx.md2 );
2094 break;
2095#endif
2096#if defined(MBEDTLS_MD4_C)
2097 case PSA_ALG_MD4:
2098 mbedtls_md4_free( &operation->ctx.md4 );
2099 break;
2100#endif
2101#if defined(MBEDTLS_MD5_C)
2102 case PSA_ALG_MD5:
2103 mbedtls_md5_free( &operation->ctx.md5 );
2104 break;
2105#endif
2106#if defined(MBEDTLS_RIPEMD160_C)
2107 case PSA_ALG_RIPEMD160:
2108 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2109 break;
2110#endif
2111#if defined(MBEDTLS_SHA1_C)
2112 case PSA_ALG_SHA_1:
2113 mbedtls_sha1_free( &operation->ctx.sha1 );
2114 break;
2115#endif
2116#if defined(MBEDTLS_SHA256_C)
2117 case PSA_ALG_SHA_224:
2118 case PSA_ALG_SHA_256:
2119 mbedtls_sha256_free( &operation->ctx.sha256 );
2120 break;
2121#endif
2122#if defined(MBEDTLS_SHA512_C)
2123 case PSA_ALG_SHA_384:
2124 case PSA_ALG_SHA_512:
2125 mbedtls_sha512_free( &operation->ctx.sha512 );
2126 break;
2127#endif
2128 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002129 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002130 }
2131 operation->alg = 0;
2132 return( PSA_SUCCESS );
2133}
2134
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002135psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002136 psa_algorithm_t alg )
2137{
2138 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002139
2140 /* A context must be freshly initialized before it can be set up. */
2141 if( operation->alg != 0 )
2142 {
2143 return( PSA_ERROR_BAD_STATE );
2144 }
2145
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146 switch( alg )
2147 {
2148#if defined(MBEDTLS_MD2_C)
2149 case PSA_ALG_MD2:
2150 mbedtls_md2_init( &operation->ctx.md2 );
2151 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2152 break;
2153#endif
2154#if defined(MBEDTLS_MD4_C)
2155 case PSA_ALG_MD4:
2156 mbedtls_md4_init( &operation->ctx.md4 );
2157 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2158 break;
2159#endif
2160#if defined(MBEDTLS_MD5_C)
2161 case PSA_ALG_MD5:
2162 mbedtls_md5_init( &operation->ctx.md5 );
2163 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2164 break;
2165#endif
2166#if defined(MBEDTLS_RIPEMD160_C)
2167 case PSA_ALG_RIPEMD160:
2168 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2169 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2170 break;
2171#endif
2172#if defined(MBEDTLS_SHA1_C)
2173 case PSA_ALG_SHA_1:
2174 mbedtls_sha1_init( &operation->ctx.sha1 );
2175 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2176 break;
2177#endif
2178#if defined(MBEDTLS_SHA256_C)
2179 case PSA_ALG_SHA_224:
2180 mbedtls_sha256_init( &operation->ctx.sha256 );
2181 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2182 break;
2183 case PSA_ALG_SHA_256:
2184 mbedtls_sha256_init( &operation->ctx.sha256 );
2185 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2186 break;
2187#endif
2188#if defined(MBEDTLS_SHA512_C)
2189 case PSA_ALG_SHA_384:
2190 mbedtls_sha512_init( &operation->ctx.sha512 );
2191 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2192 break;
2193 case PSA_ALG_SHA_512:
2194 mbedtls_sha512_init( &operation->ctx.sha512 );
2195 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2196 break;
2197#endif
2198 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002199 return( PSA_ALG_IS_HASH( alg ) ?
2200 PSA_ERROR_NOT_SUPPORTED :
2201 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002202 }
2203 if( ret == 0 )
2204 operation->alg = alg;
2205 else
2206 psa_hash_abort( operation );
2207 return( mbedtls_to_psa_error( ret ) );
2208}
2209
2210psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2211 const uint8_t *input,
2212 size_t input_length )
2213{
2214 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002215
2216 /* Don't require hash implementations to behave correctly on a
2217 * zero-length input, which may have an invalid pointer. */
2218 if( input_length == 0 )
2219 return( PSA_SUCCESS );
2220
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002221 switch( operation->alg )
2222 {
2223#if defined(MBEDTLS_MD2_C)
2224 case PSA_ALG_MD2:
2225 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2226 input, input_length );
2227 break;
2228#endif
2229#if defined(MBEDTLS_MD4_C)
2230 case PSA_ALG_MD4:
2231 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2232 input, input_length );
2233 break;
2234#endif
2235#if defined(MBEDTLS_MD5_C)
2236 case PSA_ALG_MD5:
2237 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2238 input, input_length );
2239 break;
2240#endif
2241#if defined(MBEDTLS_RIPEMD160_C)
2242 case PSA_ALG_RIPEMD160:
2243 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2244 input, input_length );
2245 break;
2246#endif
2247#if defined(MBEDTLS_SHA1_C)
2248 case PSA_ALG_SHA_1:
2249 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2250 input, input_length );
2251 break;
2252#endif
2253#if defined(MBEDTLS_SHA256_C)
2254 case PSA_ALG_SHA_224:
2255 case PSA_ALG_SHA_256:
2256 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2257 input, input_length );
2258 break;
2259#endif
2260#if defined(MBEDTLS_SHA512_C)
2261 case PSA_ALG_SHA_384:
2262 case PSA_ALG_SHA_512:
2263 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2264 input, input_length );
2265 break;
2266#endif
2267 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002268 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002269 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002270
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002271 if( ret != 0 )
2272 psa_hash_abort( operation );
2273 return( mbedtls_to_psa_error( ret ) );
2274}
2275
2276psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2277 uint8_t *hash,
2278 size_t hash_size,
2279 size_t *hash_length )
2280{
itayzafrir40835d42018-08-02 13:14:17 +03002281 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002282 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002283 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002284
2285 /* Fill the output buffer with something that isn't a valid hash
2286 * (barring an attack on the hash and deliberately-crafted input),
2287 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002288 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002289 /* If hash_size is 0 then hash may be NULL and then the
2290 * call to memset would have undefined behavior. */
2291 if( hash_size != 0 )
2292 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002293
2294 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002295 {
2296 status = PSA_ERROR_BUFFER_TOO_SMALL;
2297 goto exit;
2298 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002299
2300 switch( operation->alg )
2301 {
2302#if defined(MBEDTLS_MD2_C)
2303 case PSA_ALG_MD2:
2304 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2305 break;
2306#endif
2307#if defined(MBEDTLS_MD4_C)
2308 case PSA_ALG_MD4:
2309 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2310 break;
2311#endif
2312#if defined(MBEDTLS_MD5_C)
2313 case PSA_ALG_MD5:
2314 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2315 break;
2316#endif
2317#if defined(MBEDTLS_RIPEMD160_C)
2318 case PSA_ALG_RIPEMD160:
2319 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2320 break;
2321#endif
2322#if defined(MBEDTLS_SHA1_C)
2323 case PSA_ALG_SHA_1:
2324 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2325 break;
2326#endif
2327#if defined(MBEDTLS_SHA256_C)
2328 case PSA_ALG_SHA_224:
2329 case PSA_ALG_SHA_256:
2330 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2331 break;
2332#endif
2333#if defined(MBEDTLS_SHA512_C)
2334 case PSA_ALG_SHA_384:
2335 case PSA_ALG_SHA_512:
2336 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2337 break;
2338#endif
2339 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002340 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002341 }
itayzafrir40835d42018-08-02 13:14:17 +03002342 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002343
itayzafrir40835d42018-08-02 13:14:17 +03002344exit:
2345 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002346 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002347 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002348 return( psa_hash_abort( operation ) );
2349 }
2350 else
2351 {
2352 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002353 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002354 }
2355}
2356
Gilles Peskine2d277862018-06-18 15:41:12 +02002357psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2358 const uint8_t *hash,
2359 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002360{
2361 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2362 size_t actual_hash_length;
2363 psa_status_t status = psa_hash_finish( operation,
2364 actual_hash, sizeof( actual_hash ),
2365 &actual_hash_length );
2366 if( status != PSA_SUCCESS )
2367 return( status );
2368 if( actual_hash_length != hash_length )
2369 return( PSA_ERROR_INVALID_SIGNATURE );
2370 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2371 return( PSA_ERROR_INVALID_SIGNATURE );
2372 return( PSA_SUCCESS );
2373}
2374
Gilles Peskineeb35d782019-01-22 17:56:16 +01002375psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2376 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002377{
2378 if( target_operation->alg != 0 )
2379 return( PSA_ERROR_BAD_STATE );
2380
2381 switch( source_operation->alg )
2382 {
2383 case 0:
2384 return( PSA_ERROR_BAD_STATE );
2385#if defined(MBEDTLS_MD2_C)
2386 case PSA_ALG_MD2:
2387 mbedtls_md2_clone( &target_operation->ctx.md2,
2388 &source_operation->ctx.md2 );
2389 break;
2390#endif
2391#if defined(MBEDTLS_MD4_C)
2392 case PSA_ALG_MD4:
2393 mbedtls_md4_clone( &target_operation->ctx.md4,
2394 &source_operation->ctx.md4 );
2395 break;
2396#endif
2397#if defined(MBEDTLS_MD5_C)
2398 case PSA_ALG_MD5:
2399 mbedtls_md5_clone( &target_operation->ctx.md5,
2400 &source_operation->ctx.md5 );
2401 break;
2402#endif
2403#if defined(MBEDTLS_RIPEMD160_C)
2404 case PSA_ALG_RIPEMD160:
2405 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2406 &source_operation->ctx.ripemd160 );
2407 break;
2408#endif
2409#if defined(MBEDTLS_SHA1_C)
2410 case PSA_ALG_SHA_1:
2411 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2412 &source_operation->ctx.sha1 );
2413 break;
2414#endif
2415#if defined(MBEDTLS_SHA256_C)
2416 case PSA_ALG_SHA_224:
2417 case PSA_ALG_SHA_256:
2418 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2419 &source_operation->ctx.sha256 );
2420 break;
2421#endif
2422#if defined(MBEDTLS_SHA512_C)
2423 case PSA_ALG_SHA_384:
2424 case PSA_ALG_SHA_512:
2425 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2426 &source_operation->ctx.sha512 );
2427 break;
2428#endif
2429 default:
2430 return( PSA_ERROR_NOT_SUPPORTED );
2431 }
2432
2433 target_operation->alg = source_operation->alg;
2434 return( PSA_SUCCESS );
2435}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002436
2437
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002438/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002439/* MAC */
2440/****************************************************************/
2441
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002442static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002443 psa_algorithm_t alg,
2444 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002445 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002446 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002447{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002448 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002449 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002450
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002451 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002452 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002453
Gilles Peskine8c9def32018-02-08 10:02:12 +01002454 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2455 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002456 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002457 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002458 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002459 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002460 mode = MBEDTLS_MODE_STREAM;
2461 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002462 case PSA_ALG_CTR:
2463 mode = MBEDTLS_MODE_CTR;
2464 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002465 case PSA_ALG_CFB:
2466 mode = MBEDTLS_MODE_CFB;
2467 break;
2468 case PSA_ALG_OFB:
2469 mode = MBEDTLS_MODE_OFB;
2470 break;
2471 case PSA_ALG_CBC_NO_PADDING:
2472 mode = MBEDTLS_MODE_CBC;
2473 break;
2474 case PSA_ALG_CBC_PKCS7:
2475 mode = MBEDTLS_MODE_CBC;
2476 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002477 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478 mode = MBEDTLS_MODE_CCM;
2479 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002480 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002481 mode = MBEDTLS_MODE_GCM;
2482 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002483 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2484 mode = MBEDTLS_MODE_CHACHAPOLY;
2485 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002486 default:
2487 return( NULL );
2488 }
2489 }
2490 else if( alg == PSA_ALG_CMAC )
2491 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002492 else
2493 return( NULL );
2494
2495 switch( key_type )
2496 {
2497 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002498 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002499 break;
2500 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002501 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2502 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002503 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002504 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002505 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002506 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002507 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2508 * but two-key Triple-DES is functionally three-key Triple-DES
2509 * with K1=K3, so that's how we present it to mbedtls. */
2510 if( key_bits == 128 )
2511 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002512 break;
2513 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002514 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515 break;
2516 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002517 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002518 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002519 case PSA_KEY_TYPE_CHACHA20:
2520 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2521 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522 default:
2523 return( NULL );
2524 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002525 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002526 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002527
Jaeden Amero23bbb752018-06-26 14:16:54 +01002528 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2529 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002530}
2531
Gilles Peskinea05219c2018-11-16 16:02:56 +01002532#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002533static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002534{
Gilles Peskine2d277862018-06-18 15:41:12 +02002535 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002536 {
2537 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002538 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002539 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002540 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002541 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002542 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002543 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002544 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002545 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002546 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002547 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002548 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002549 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002550 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002551 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002552 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002553 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002554 return( 128 );
2555 default:
2556 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002557 }
2558}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002559#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002560
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002561/* Initialize the MAC operation structure. Once this function has been
2562 * called, psa_mac_abort can run and will do the right thing. */
2563static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2564 psa_algorithm_t alg )
2565{
2566 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2567
2568 operation->alg = alg;
2569 operation->key_set = 0;
2570 operation->iv_set = 0;
2571 operation->iv_required = 0;
2572 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002573 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002574
2575#if defined(MBEDTLS_CMAC_C)
2576 if( alg == PSA_ALG_CMAC )
2577 {
2578 operation->iv_required = 0;
2579 mbedtls_cipher_init( &operation->ctx.cmac );
2580 status = PSA_SUCCESS;
2581 }
2582 else
2583#endif /* MBEDTLS_CMAC_C */
2584#if defined(MBEDTLS_MD_C)
2585 if( PSA_ALG_IS_HMAC( operation->alg ) )
2586 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002587 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2588 operation->ctx.hmac.hash_ctx.alg = 0;
2589 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002590 }
2591 else
2592#endif /* MBEDTLS_MD_C */
2593 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002594 if( ! PSA_ALG_IS_MAC( alg ) )
2595 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002596 }
2597
2598 if( status != PSA_SUCCESS )
2599 memset( operation, 0, sizeof( *operation ) );
2600 return( status );
2601}
2602
Gilles Peskine01126fa2018-07-12 17:04:55 +02002603#if defined(MBEDTLS_MD_C)
2604static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2605{
Gilles Peskine3f108122018-12-07 18:14:53 +01002606 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002607 return( psa_hash_abort( &hmac->hash_ctx ) );
2608}
2609#endif /* MBEDTLS_MD_C */
2610
Gilles Peskine8c9def32018-02-08 10:02:12 +01002611psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2612{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002613 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002614 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002615 /* The object has (apparently) been initialized but it is not
2616 * in use. It's ok to call abort on such an object, and there's
2617 * nothing to do. */
2618 return( PSA_SUCCESS );
2619 }
2620 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002621#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002622 if( operation->alg == PSA_ALG_CMAC )
2623 {
2624 mbedtls_cipher_free( &operation->ctx.cmac );
2625 }
2626 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002627#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002629 if( PSA_ALG_IS_HMAC( operation->alg ) )
2630 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002631 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002632 }
2633 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002634#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002635 {
2636 /* Sanity check (shouldn't happen: operation->alg should
2637 * always have been initialized to a valid value). */
2638 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002639 }
Moran Peker41deec42018-04-04 15:43:05 +03002640
Gilles Peskine8c9def32018-02-08 10:02:12 +01002641 operation->alg = 0;
2642 operation->key_set = 0;
2643 operation->iv_set = 0;
2644 operation->iv_required = 0;
2645 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002646 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002647
Gilles Peskine8c9def32018-02-08 10:02:12 +01002648 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002649
2650bad_state:
2651 /* If abort is called on an uninitialized object, we can't trust
2652 * anything. Wipe the object in case it contains confidential data.
2653 * This may result in a memory leak if a pointer gets overwritten,
2654 * but it's too late to do anything about this. */
2655 memset( operation, 0, sizeof( *operation ) );
2656 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002657}
2658
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002659#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002660static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002661 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002662 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002663 const mbedtls_cipher_info_t *cipher_info )
2664{
2665 int ret;
2666
2667 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002668
2669 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2670 if( ret != 0 )
2671 return( ret );
2672
2673 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2674 slot->data.raw.data,
2675 key_bits );
2676 return( ret );
2677}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002678#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002679
Gilles Peskine248051a2018-06-20 16:09:38 +02002680#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002681static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2682 const uint8_t *key,
2683 size_t key_length,
2684 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002685{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002686 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002687 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002688 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002689 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002690 psa_status_t status;
2691
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002692 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2693 * overflow below. This should never trigger if the hash algorithm
2694 * is implemented correctly. */
2695 /* The size checks against the ipad and opad buffers cannot be written
2696 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2697 * because that triggers -Wlogical-op on GCC 7.3. */
2698 if( block_size > sizeof( ipad ) )
2699 return( PSA_ERROR_NOT_SUPPORTED );
2700 if( block_size > sizeof( hmac->opad ) )
2701 return( PSA_ERROR_NOT_SUPPORTED );
2702 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002703 return( PSA_ERROR_NOT_SUPPORTED );
2704
Gilles Peskined223b522018-06-11 18:12:58 +02002705 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002706 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002707 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002708 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002709 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002710 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002711 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002712 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002713 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002714 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002715 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002716 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002717 }
Gilles Peskine96889972018-07-12 17:07:03 +02002718 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2719 * but it is permitted. It is common when HMAC is used in HKDF, for
2720 * example. Don't call `memcpy` in the 0-length because `key` could be
2721 * an invalid pointer which would make the behavior undefined. */
2722 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002723 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002724
Gilles Peskined223b522018-06-11 18:12:58 +02002725 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2726 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002727 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002728 ipad[i] ^= 0x36;
2729 memset( ipad + key_length, 0x36, block_size - key_length );
2730
2731 /* Copy the key material from ipad to opad, flipping the requisite bits,
2732 * and filling the rest of opad with the requisite constant. */
2733 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002734 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2735 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002736
Gilles Peskine01126fa2018-07-12 17:04:55 +02002737 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002738 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002739 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002740
Gilles Peskine01126fa2018-07-12 17:04:55 +02002741 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002742
2743cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002744 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002745
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002746 return( status );
2747}
Gilles Peskine248051a2018-06-20 16:09:38 +02002748#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002749
Gilles Peskine89167cb2018-07-08 20:12:23 +02002750static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002751 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002752 psa_algorithm_t alg,
2753 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002754{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002755 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002756 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002757 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002758 psa_key_usage_t usage =
2759 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002760 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002761 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002762
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002763 /* A context must be freshly initialized before it can be set up. */
2764 if( operation->alg != 0 )
2765 {
2766 return( PSA_ERROR_BAD_STATE );
2767 }
2768
Gilles Peskined911eb72018-08-14 15:18:45 +02002769 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002770 if( status != PSA_SUCCESS )
2771 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002772 if( is_sign )
2773 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002774
Gilles Peskine28f8f302019-07-24 13:30:31 +02002775 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002776 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002777 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002778 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002779
Gilles Peskine8c9def32018-02-08 10:02:12 +01002780#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002781 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002782 {
2783 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002784 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002785 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002786 int ret;
2787 if( cipher_info == NULL )
2788 {
2789 status = PSA_ERROR_NOT_SUPPORTED;
2790 goto exit;
2791 }
2792 operation->mac_size = cipher_info->block_size;
2793 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2794 status = mbedtls_to_psa_error( ret );
2795 }
2796 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002797#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002799 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002800 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002801 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002802 if( hash_alg == 0 )
2803 {
2804 status = PSA_ERROR_NOT_SUPPORTED;
2805 goto exit;
2806 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002807
2808 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2809 /* Sanity check. This shouldn't fail on a valid configuration. */
2810 if( operation->mac_size == 0 ||
2811 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2812 {
2813 status = PSA_ERROR_NOT_SUPPORTED;
2814 goto exit;
2815 }
2816
Gilles Peskine8e338702019-07-30 20:06:31 +02002817 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002818 {
2819 status = PSA_ERROR_INVALID_ARGUMENT;
2820 goto exit;
2821 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002822
Gilles Peskine01126fa2018-07-12 17:04:55 +02002823 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2824 slot->data.raw.data,
2825 slot->data.raw.bytes,
2826 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002827 }
2828 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002829#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002830 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002831 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002832 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002833 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002834
Gilles Peskined911eb72018-08-14 15:18:45 +02002835 if( truncated == 0 )
2836 {
2837 /* The "normal" case: untruncated algorithm. Nothing to do. */
2838 }
2839 else if( truncated < 4 )
2840 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002841 /* A very short MAC is too short for security since it can be
2842 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2843 * so we make this our minimum, even though 32 bits is still
2844 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002845 status = PSA_ERROR_NOT_SUPPORTED;
2846 }
2847 else if( truncated > operation->mac_size )
2848 {
2849 /* It's impossible to "truncate" to a larger length. */
2850 status = PSA_ERROR_INVALID_ARGUMENT;
2851 }
2852 else
2853 operation->mac_size = truncated;
2854
Gilles Peskinefbfac682018-07-08 20:51:54 +02002855exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002856 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002857 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002858 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002859 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002860 else
2861 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002862 operation->key_set = 1;
2863 }
2864 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002865}
2866
Gilles Peskine89167cb2018-07-08 20:12:23 +02002867psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002868 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002869 psa_algorithm_t alg )
2870{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002871 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002872}
2873
2874psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002875 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002876 psa_algorithm_t alg )
2877{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002878 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002879}
2880
Gilles Peskine8c9def32018-02-08 10:02:12 +01002881psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2882 const uint8_t *input,
2883 size_t input_length )
2884{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002885 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002886 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002887 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002888 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002889 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002890 operation->has_input = 1;
2891
Gilles Peskine8c9def32018-02-08 10:02:12 +01002892#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002893 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002894 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002895 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2896 input, input_length );
2897 status = mbedtls_to_psa_error( ret );
2898 }
2899 else
2900#endif /* MBEDTLS_CMAC_C */
2901#if defined(MBEDTLS_MD_C)
2902 if( PSA_ALG_IS_HMAC( operation->alg ) )
2903 {
2904 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2905 input_length );
2906 }
2907 else
2908#endif /* MBEDTLS_MD_C */
2909 {
2910 /* This shouldn't happen if `operation` was initialized by
2911 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002912 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002913 }
2914
Gilles Peskinefbfac682018-07-08 20:51:54 +02002915 if( status != PSA_SUCCESS )
2916 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002917 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002918}
2919
Gilles Peskine01126fa2018-07-12 17:04:55 +02002920#if defined(MBEDTLS_MD_C)
2921static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2922 uint8_t *mac,
2923 size_t mac_size )
2924{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002925 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002926 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2927 size_t hash_size = 0;
2928 size_t block_size = psa_get_hash_block_size( hash_alg );
2929 psa_status_t status;
2930
Gilles Peskine01126fa2018-07-12 17:04:55 +02002931 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2932 if( status != PSA_SUCCESS )
2933 return( status );
2934 /* From here on, tmp needs to be wiped. */
2935
2936 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2937 if( status != PSA_SUCCESS )
2938 goto exit;
2939
2940 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2941 if( status != PSA_SUCCESS )
2942 goto exit;
2943
2944 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2945 if( status != PSA_SUCCESS )
2946 goto exit;
2947
Gilles Peskined911eb72018-08-14 15:18:45 +02002948 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2949 if( status != PSA_SUCCESS )
2950 goto exit;
2951
2952 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002953
2954exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002955 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002956 return( status );
2957}
2958#endif /* MBEDTLS_MD_C */
2959
mohammad16036df908f2018-04-02 08:34:15 -07002960static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002961 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002962 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002963{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002964 if( ! operation->key_set )
2965 return( PSA_ERROR_BAD_STATE );
2966 if( operation->iv_required && ! operation->iv_set )
2967 return( PSA_ERROR_BAD_STATE );
2968
Gilles Peskine8c9def32018-02-08 10:02:12 +01002969 if( mac_size < operation->mac_size )
2970 return( PSA_ERROR_BUFFER_TOO_SMALL );
2971
Gilles Peskine8c9def32018-02-08 10:02:12 +01002972#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002973 if( operation->alg == PSA_ALG_CMAC )
2974 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002975 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2976 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2977 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002978 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002979 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002980 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002981 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002982 else
2983#endif /* MBEDTLS_CMAC_C */
2984#if defined(MBEDTLS_MD_C)
2985 if( PSA_ALG_IS_HMAC( operation->alg ) )
2986 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002987 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002988 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002989 }
2990 else
2991#endif /* MBEDTLS_MD_C */
2992 {
2993 /* This shouldn't happen if `operation` was initialized by
2994 * a setup function. */
2995 return( PSA_ERROR_BAD_STATE );
2996 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002997}
2998
Gilles Peskineacd4be32018-07-08 19:56:25 +02002999psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3000 uint8_t *mac,
3001 size_t mac_size,
3002 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003003{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003004 psa_status_t status;
3005
Jaeden Amero252ef282019-02-15 14:05:35 +00003006 if( operation->alg == 0 )
3007 {
3008 return( PSA_ERROR_BAD_STATE );
3009 }
3010
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003011 /* Fill the output buffer with something that isn't a valid mac
3012 * (barring an attack on the mac and deliberately-crafted input),
3013 * in case the caller doesn't check the return status properly. */
3014 *mac_length = mac_size;
3015 /* If mac_size is 0 then mac may be NULL and then the
3016 * call to memset would have undefined behavior. */
3017 if( mac_size != 0 )
3018 memset( mac, '!', mac_size );
3019
Gilles Peskine89167cb2018-07-08 20:12:23 +02003020 if( ! operation->is_sign )
3021 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003022 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003023 }
mohammad16036df908f2018-04-02 08:34:15 -07003024
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003025 status = psa_mac_finish_internal( operation, mac, mac_size );
3026
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003027 if( status == PSA_SUCCESS )
3028 {
3029 status = psa_mac_abort( operation );
3030 if( status == PSA_SUCCESS )
3031 *mac_length = operation->mac_size;
3032 else
3033 memset( mac, '!', mac_size );
3034 }
3035 else
3036 psa_mac_abort( operation );
3037 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003038}
3039
Gilles Peskineacd4be32018-07-08 19:56:25 +02003040psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3041 const uint8_t *mac,
3042 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003043{
Gilles Peskine828ed142018-06-18 23:25:51 +02003044 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003045 psa_status_t status;
3046
Jaeden Amero252ef282019-02-15 14:05:35 +00003047 if( operation->alg == 0 )
3048 {
3049 return( PSA_ERROR_BAD_STATE );
3050 }
3051
Gilles Peskine89167cb2018-07-08 20:12:23 +02003052 if( operation->is_sign )
3053 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003054 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003055 }
3056 if( operation->mac_size != mac_length )
3057 {
3058 status = PSA_ERROR_INVALID_SIGNATURE;
3059 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003060 }
mohammad16036df908f2018-04-02 08:34:15 -07003061
3062 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003063 actual_mac, sizeof( actual_mac ) );
3064
3065 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3066 status = PSA_ERROR_INVALID_SIGNATURE;
3067
3068cleanup:
3069 if( status == PSA_SUCCESS )
3070 status = psa_mac_abort( operation );
3071 else
3072 psa_mac_abort( operation );
3073
Gilles Peskine3f108122018-12-07 18:14:53 +01003074 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003075
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003076 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003077}
3078
3079
Gilles Peskine20035e32018-02-03 22:44:14 +01003080
Gilles Peskine20035e32018-02-03 22:44:14 +01003081/****************************************************************/
3082/* Asymmetric cryptography */
3083/****************************************************************/
3084
Gilles Peskine2b450e32018-06-27 15:42:46 +02003085#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003086/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003087 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003088static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3089 size_t hash_length,
3090 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003091{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003092 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003093 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003094 *md_alg = mbedtls_md_get_type( md_info );
3095
3096 /* The Mbed TLS RSA module uses an unsigned int for hash length
3097 * parameters. Validate that it fits so that we don't risk an
3098 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003099#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003100 if( hash_length > UINT_MAX )
3101 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003102#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003103
3104#if defined(MBEDTLS_PKCS1_V15)
3105 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3106 * must be correct. */
3107 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3108 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003109 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003110 if( md_info == NULL )
3111 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003112 if( mbedtls_md_get_size( md_info ) != hash_length )
3113 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003114 }
3115#endif /* MBEDTLS_PKCS1_V15 */
3116
3117#if defined(MBEDTLS_PKCS1_V21)
3118 /* PSS requires a hash internally. */
3119 if( PSA_ALG_IS_RSA_PSS( alg ) )
3120 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003121 if( md_info == NULL )
3122 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003123 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003124#endif /* MBEDTLS_PKCS1_V21 */
3125
Gilles Peskine61b91d42018-06-08 16:09:36 +02003126 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003127}
3128
Gilles Peskine2b450e32018-06-27 15:42:46 +02003129static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3130 psa_algorithm_t alg,
3131 const uint8_t *hash,
3132 size_t hash_length,
3133 uint8_t *signature,
3134 size_t signature_size,
3135 size_t *signature_length )
3136{
3137 psa_status_t status;
3138 int ret;
3139 mbedtls_md_type_t md_alg;
3140
3141 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3142 if( status != PSA_SUCCESS )
3143 return( status );
3144
Gilles Peskine630a18a2018-06-29 17:49:35 +02003145 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003146 return( PSA_ERROR_BUFFER_TOO_SMALL );
3147
3148#if defined(MBEDTLS_PKCS1_V15)
3149 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3150 {
3151 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3152 MBEDTLS_MD_NONE );
3153 ret = mbedtls_rsa_pkcs1_sign( rsa,
3154 mbedtls_ctr_drbg_random,
3155 &global_data.ctr_drbg,
3156 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003157 md_alg,
3158 (unsigned int) hash_length,
3159 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003160 signature );
3161 }
3162 else
3163#endif /* MBEDTLS_PKCS1_V15 */
3164#if defined(MBEDTLS_PKCS1_V21)
3165 if( PSA_ALG_IS_RSA_PSS( alg ) )
3166 {
3167 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3168 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3169 mbedtls_ctr_drbg_random,
3170 &global_data.ctr_drbg,
3171 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003172 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003173 (unsigned int) hash_length,
3174 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003175 signature );
3176 }
3177 else
3178#endif /* MBEDTLS_PKCS1_V21 */
3179 {
3180 return( PSA_ERROR_INVALID_ARGUMENT );
3181 }
3182
3183 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003184 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003185 return( mbedtls_to_psa_error( ret ) );
3186}
3187
3188static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3189 psa_algorithm_t alg,
3190 const uint8_t *hash,
3191 size_t hash_length,
3192 const uint8_t *signature,
3193 size_t signature_length )
3194{
3195 psa_status_t status;
3196 int ret;
3197 mbedtls_md_type_t md_alg;
3198
3199 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3200 if( status != PSA_SUCCESS )
3201 return( status );
3202
Gilles Peskine630a18a2018-06-29 17:49:35 +02003203 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003204 return( PSA_ERROR_BUFFER_TOO_SMALL );
3205
3206#if defined(MBEDTLS_PKCS1_V15)
3207 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3208 {
3209 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3210 MBEDTLS_MD_NONE );
3211 ret = mbedtls_rsa_pkcs1_verify( rsa,
3212 mbedtls_ctr_drbg_random,
3213 &global_data.ctr_drbg,
3214 MBEDTLS_RSA_PUBLIC,
3215 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003216 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003217 hash,
3218 signature );
3219 }
3220 else
3221#endif /* MBEDTLS_PKCS1_V15 */
3222#if defined(MBEDTLS_PKCS1_V21)
3223 if( PSA_ALG_IS_RSA_PSS( alg ) )
3224 {
3225 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3226 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3227 mbedtls_ctr_drbg_random,
3228 &global_data.ctr_drbg,
3229 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003230 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003231 (unsigned int) hash_length,
3232 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003233 signature );
3234 }
3235 else
3236#endif /* MBEDTLS_PKCS1_V21 */
3237 {
3238 return( PSA_ERROR_INVALID_ARGUMENT );
3239 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003240
3241 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3242 * the rest of the signature is invalid". This has little use in
3243 * practice and PSA doesn't report this distinction. */
3244 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3245 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003246 return( mbedtls_to_psa_error( ret ) );
3247}
3248#endif /* MBEDTLS_RSA_C */
3249
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003250#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003251/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3252 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3253 * (even though these functions don't modify it). */
3254static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3255 psa_algorithm_t alg,
3256 const uint8_t *hash,
3257 size_t hash_length,
3258 uint8_t *signature,
3259 size_t signature_size,
3260 size_t *signature_length )
3261{
3262 int ret;
3263 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003264 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003265 mbedtls_mpi_init( &r );
3266 mbedtls_mpi_init( &s );
3267
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003268 if( signature_size < 2 * curve_bytes )
3269 {
3270 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3271 goto cleanup;
3272 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003273
Gilles Peskinea05219c2018-11-16 16:02:56 +01003274#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003275 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3276 {
3277 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3278 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3279 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003280 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3281 &ecp->d, hash,
3282 hash_length, md_alg,
3283 mbedtls_ctr_drbg_random,
3284 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003285 }
3286 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003287#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003288 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003289 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003290 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3291 hash, hash_length,
3292 mbedtls_ctr_drbg_random,
3293 &global_data.ctr_drbg ) );
3294 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003295
3296 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3297 signature,
3298 curve_bytes ) );
3299 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3300 signature + curve_bytes,
3301 curve_bytes ) );
3302
3303cleanup:
3304 mbedtls_mpi_free( &r );
3305 mbedtls_mpi_free( &s );
3306 if( ret == 0 )
3307 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003308 return( mbedtls_to_psa_error( ret ) );
3309}
3310
3311static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3312 const uint8_t *hash,
3313 size_t hash_length,
3314 const uint8_t *signature,
3315 size_t signature_length )
3316{
3317 int ret;
3318 mbedtls_mpi r, s;
3319 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3320 mbedtls_mpi_init( &r );
3321 mbedtls_mpi_init( &s );
3322
3323 if( signature_length != 2 * curve_bytes )
3324 return( PSA_ERROR_INVALID_SIGNATURE );
3325
3326 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3327 signature,
3328 curve_bytes ) );
3329 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3330 signature + curve_bytes,
3331 curve_bytes ) );
3332
3333 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3334 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003335
3336cleanup:
3337 mbedtls_mpi_free( &r );
3338 mbedtls_mpi_free( &s );
3339 return( mbedtls_to_psa_error( ret ) );
3340}
3341#endif /* MBEDTLS_ECDSA_C */
3342
Gilles Peskinec5487a82018-12-03 18:08:14 +01003343psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003344 psa_algorithm_t alg,
3345 const uint8_t *hash,
3346 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003347 uint8_t *signature,
3348 size_t signature_size,
3349 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003350{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003351 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003352 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003353#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3354 const psa_drv_se_t *drv;
3355 psa_drv_se_context_t *drv_context;
3356#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003357
3358 *signature_length = signature_size;
3359
Gilles Peskineedc64242019-08-07 21:05:07 +02003360 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003361 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003362 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003363 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003364 {
3365 status = PSA_ERROR_INVALID_ARGUMENT;
3366 goto exit;
3367 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003368
Gilles Peskineedc64242019-08-07 21:05:07 +02003369#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3370 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3371 {
3372 if( drv->asymmetric == NULL ||
3373 drv->asymmetric->p_sign == NULL )
3374 {
3375 status = PSA_ERROR_NOT_SUPPORTED;
3376 goto exit;
3377 }
3378 status = drv->asymmetric->p_sign( drv_context,
3379 slot->data.se.slot_number,
3380 alg,
3381 hash, hash_length,
3382 signature, signature_size,
3383 signature_length );
3384 }
3385 else
3386#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine20035e32018-02-03 22:44:14 +01003387#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003388 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003389 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003390 status = psa_rsa_sign( slot->data.rsa,
3391 alg,
3392 hash, hash_length,
3393 signature, signature_size,
3394 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003395 }
3396 else
3397#endif /* defined(MBEDTLS_RSA_C) */
3398#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003399 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003400 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003401#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003402 if(
3403#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3404 PSA_ALG_IS_ECDSA( alg )
3405#else
3406 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3407#endif
3408 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003409 status = psa_ecdsa_sign( slot->data.ecp,
3410 alg,
3411 hash, hash_length,
3412 signature, signature_size,
3413 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003414 else
3415#endif /* defined(MBEDTLS_ECDSA_C) */
3416 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003417 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003418 }
itayzafrir5c753392018-05-08 11:18:38 +03003419 }
3420 else
3421#endif /* defined(MBEDTLS_ECP_C) */
3422 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003423 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003424 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003425
3426exit:
3427 /* Fill the unused part of the output buffer (the whole buffer on error,
3428 * the trailing part on success) with something that isn't a valid mac
3429 * (barring an attack on the mac and deliberately-crafted input),
3430 * in case the caller doesn't check the return status properly. */
3431 if( status == PSA_SUCCESS )
3432 memset( signature + *signature_length, '!',
3433 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003434 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003435 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003436 /* If signature_size is 0 then we have nothing to do. We must not call
3437 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003438 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003439}
3440
Gilles Peskinec5487a82018-12-03 18:08:14 +01003441psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03003442 psa_algorithm_t alg,
3443 const uint8_t *hash,
3444 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02003445 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02003446 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003447{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003448 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003449 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003450#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3451 const psa_drv_se_t *drv;
3452 psa_drv_se_context_t *drv_context;
3453#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003454
Gilles Peskineedc64242019-08-07 21:05:07 +02003455 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003456 if( status != PSA_SUCCESS )
3457 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003458
Gilles Peskineedc64242019-08-07 21:05:07 +02003459#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3460 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3461 {
3462 if( drv->asymmetric == NULL ||
3463 drv->asymmetric->p_verify == NULL )
3464 return( PSA_ERROR_NOT_SUPPORTED );
3465 return( drv->asymmetric->p_verify( drv_context,
3466 slot->data.se.slot_number,
3467 alg,
3468 hash, hash_length,
3469 signature, signature_length ) );
3470 }
3471 else
3472#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine61b91d42018-06-08 16:09:36 +02003473#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003474 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003475 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003476 return( psa_rsa_verify( slot->data.rsa,
3477 alg,
3478 hash, hash_length,
3479 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003480 }
3481 else
3482#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003483#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003484 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003485 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003486#if defined(MBEDTLS_ECDSA_C)
3487 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003488 return( psa_ecdsa_verify( slot->data.ecp,
3489 hash, hash_length,
3490 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003491 else
3492#endif /* defined(MBEDTLS_ECDSA_C) */
3493 {
3494 return( PSA_ERROR_INVALID_ARGUMENT );
3495 }
itayzafrir5c753392018-05-08 11:18:38 +03003496 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003497 else
3498#endif /* defined(MBEDTLS_ECP_C) */
3499 {
3500 return( PSA_ERROR_NOT_SUPPORTED );
3501 }
3502}
3503
Gilles Peskine072ac562018-06-30 00:21:29 +02003504#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3505static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3506 mbedtls_rsa_context *rsa )
3507{
3508 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3509 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3510 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3511 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3512}
3513#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3514
Gilles Peskinec5487a82018-12-03 18:08:14 +01003515psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003516 psa_algorithm_t alg,
3517 const uint8_t *input,
3518 size_t input_length,
3519 const uint8_t *salt,
3520 size_t salt_length,
3521 uint8_t *output,
3522 size_t output_size,
3523 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003524{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003525 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003526 psa_status_t status;
3527
Darryl Green5cc689a2018-07-24 15:34:10 +01003528 (void) input;
3529 (void) input_length;
3530 (void) salt;
3531 (void) output;
3532 (void) output_size;
3533
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003534 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003535
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003536 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3537 return( PSA_ERROR_INVALID_ARGUMENT );
3538
Gilles Peskine28f8f302019-07-24 13:30:31 +02003539 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003540 if( status != PSA_SUCCESS )
3541 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003542 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3543 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003544 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003545
3546#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003547 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003548 {
3549 mbedtls_rsa_context *rsa = slot->data.rsa;
3550 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003551 if( output_size < mbedtls_rsa_get_len( rsa ) )
Vikas Katariya21599b62019-08-02 12:26:29 +01003552 return( PSA_ERROR_BUFFER_TOO_SMALL );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003553#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003554 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003555 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003556 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3557 mbedtls_ctr_drbg_random,
3558 &global_data.ctr_drbg,
3559 MBEDTLS_RSA_PUBLIC,
3560 input_length,
3561 input,
3562 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003563 }
3564 else
3565#endif /* MBEDTLS_PKCS1_V15 */
3566#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003567 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003568 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003569 psa_rsa_oaep_set_padding_mode( alg, rsa );
3570 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3571 mbedtls_ctr_drbg_random,
3572 &global_data.ctr_drbg,
3573 MBEDTLS_RSA_PUBLIC,
3574 salt, salt_length,
3575 input_length,
3576 input,
3577 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003578 }
3579 else
3580#endif /* MBEDTLS_PKCS1_V21 */
3581 {
3582 return( PSA_ERROR_INVALID_ARGUMENT );
3583 }
3584 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003585 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003586 return( mbedtls_to_psa_error( ret ) );
3587 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003588 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003589#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003590 {
3591 return( PSA_ERROR_NOT_SUPPORTED );
3592 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003593}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003594
Gilles Peskinec5487a82018-12-03 18:08:14 +01003595psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003596 psa_algorithm_t alg,
3597 const uint8_t *input,
3598 size_t input_length,
3599 const uint8_t *salt,
3600 size_t salt_length,
3601 uint8_t *output,
3602 size_t output_size,
3603 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003604{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003605 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003606 psa_status_t status;
3607
Darryl Green5cc689a2018-07-24 15:34:10 +01003608 (void) input;
3609 (void) input_length;
3610 (void) salt;
3611 (void) output;
3612 (void) output_size;
3613
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003614 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003615
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003616 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3617 return( PSA_ERROR_INVALID_ARGUMENT );
3618
Gilles Peskine28f8f302019-07-24 13:30:31 +02003619 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003620 if( status != PSA_SUCCESS )
3621 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003622 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003623 return( PSA_ERROR_INVALID_ARGUMENT );
3624
3625#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003626 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003627 {
3628 mbedtls_rsa_context *rsa = slot->data.rsa;
3629 int ret;
3630
Gilles Peskine630a18a2018-06-29 17:49:35 +02003631 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003632 return( PSA_ERROR_INVALID_ARGUMENT );
3633
3634#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003635 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003636 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003637 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3638 mbedtls_ctr_drbg_random,
3639 &global_data.ctr_drbg,
3640 MBEDTLS_RSA_PRIVATE,
3641 output_length,
3642 input,
3643 output,
3644 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003645 }
3646 else
3647#endif /* MBEDTLS_PKCS1_V15 */
3648#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003649 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003650 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003651 psa_rsa_oaep_set_padding_mode( alg, rsa );
3652 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3653 mbedtls_ctr_drbg_random,
3654 &global_data.ctr_drbg,
3655 MBEDTLS_RSA_PRIVATE,
3656 salt, salt_length,
3657 output_length,
3658 input,
3659 output,
3660 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003661 }
3662 else
3663#endif /* MBEDTLS_PKCS1_V21 */
3664 {
3665 return( PSA_ERROR_INVALID_ARGUMENT );
3666 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003667
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003668 return( mbedtls_to_psa_error( ret ) );
3669 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003670 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003671#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003672 {
3673 return( PSA_ERROR_NOT_SUPPORTED );
3674 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003675}
Gilles Peskine20035e32018-02-03 22:44:14 +01003676
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003677
3678
mohammad1603503973b2018-03-12 15:59:30 +02003679/****************************************************************/
3680/* Symmetric cryptography */
3681/****************************************************************/
3682
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003683/* Initialize the cipher operation structure. Once this function has been
3684 * called, psa_cipher_abort can run and will do the right thing. */
3685static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3686 psa_algorithm_t alg )
3687{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003688 if( ! PSA_ALG_IS_CIPHER( alg ) )
3689 {
3690 memset( operation, 0, sizeof( *operation ) );
3691 return( PSA_ERROR_INVALID_ARGUMENT );
3692 }
3693
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003694 operation->alg = alg;
3695 operation->key_set = 0;
3696 operation->iv_set = 0;
3697 operation->iv_required = 1;
3698 operation->iv_size = 0;
3699 operation->block_size = 0;
3700 mbedtls_cipher_init( &operation->ctx.cipher );
3701 return( PSA_SUCCESS );
3702}
3703
Gilles Peskinee553c652018-06-04 16:22:46 +02003704static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003705 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003706 psa_algorithm_t alg,
3707 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003708{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003709 int ret = 0;
3710 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003711 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003712 size_t key_bits;
3713 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003714 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3715 PSA_KEY_USAGE_ENCRYPT :
3716 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003717
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003718 /* A context must be freshly initialized before it can be set up. */
3719 if( operation->alg != 0 )
3720 {
3721 return( PSA_ERROR_BAD_STATE );
3722 }
3723
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003724 status = psa_cipher_init( operation, alg );
3725 if( status != PSA_SUCCESS )
3726 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003727
Gilles Peskine28f8f302019-07-24 13:30:31 +02003728 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003729 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003730 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003731 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003732
Gilles Peskine8e338702019-07-30 20:06:31 +02003733 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003734 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003735 {
3736 status = PSA_ERROR_NOT_SUPPORTED;
3737 goto exit;
3738 }
mohammad1603503973b2018-03-12 15:59:30 +02003739
mohammad1603503973b2018-03-12 15:59:30 +02003740 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003741 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003742 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003743
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003744#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003745 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003746 {
3747 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003748 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003749 memcpy( keys, slot->data.raw.data, 16 );
3750 memcpy( keys + 16, slot->data.raw.data, 8 );
3751 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3752 keys,
3753 192, cipher_operation );
3754 }
3755 else
3756#endif
3757 {
3758 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3759 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003760 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003761 }
Moran Peker41deec42018-04-04 15:43:05 +03003762 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003763 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003764
mohammad16038481e742018-03-18 13:57:31 +02003765#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003766 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003767 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003768 case PSA_ALG_CBC_NO_PADDING:
3769 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3770 MBEDTLS_PADDING_NONE );
3771 break;
3772 case PSA_ALG_CBC_PKCS7:
3773 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3774 MBEDTLS_PADDING_PKCS7 );
3775 break;
3776 default:
3777 /* The algorithm doesn't involve padding. */
3778 ret = 0;
3779 break;
3780 }
3781 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003782 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003783#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3784
mohammad1603503973b2018-03-12 15:59:30 +02003785 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003786 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003787 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003788 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003789 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003790 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003791 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003792#if defined(MBEDTLS_CHACHA20_C)
3793 else
3794 if( alg == PSA_ALG_CHACHA20 )
3795 operation->iv_size = 12;
3796#endif
mohammad1603503973b2018-03-12 15:59:30 +02003797
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003798exit:
3799 if( status == 0 )
3800 status = mbedtls_to_psa_error( ret );
3801 if( status != 0 )
3802 psa_cipher_abort( operation );
3803 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003804}
3805
Gilles Peskinefe119512018-07-08 21:39:34 +02003806psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003807 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003808 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003809{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003810 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003811}
3812
Gilles Peskinefe119512018-07-08 21:39:34 +02003813psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003814 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003815 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003816{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003817 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003818}
3819
Gilles Peskinefe119512018-07-08 21:39:34 +02003820psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003821 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003822 size_t iv_size,
3823 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003824{
itayzafrir534bd7c2018-08-02 13:56:32 +03003825 psa_status_t status;
3826 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003827 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003828 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003829 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003830 }
Moran Peker41deec42018-04-04 15:43:05 +03003831 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003832 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003833 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003834 goto exit;
3835 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003836 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3837 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003838 if( ret != 0 )
3839 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003840 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003841 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003842 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003843
mohammad16038481e742018-03-18 13:57:31 +02003844 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003845 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003846
Moran Peker395db872018-05-31 14:07:14 +03003847exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003848 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003849 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003850 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003851}
3852
Gilles Peskinefe119512018-07-08 21:39:34 +02003853psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003854 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003855 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003856{
itayzafrir534bd7c2018-08-02 13:56:32 +03003857 psa_status_t status;
3858 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003859 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003860 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003861 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003862 }
Moran Pekera28258c2018-05-29 16:25:04 +03003863 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003864 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003865 status = PSA_ERROR_INVALID_ARGUMENT;
3866 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003867 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003868 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3869 status = mbedtls_to_psa_error( ret );
3870exit:
3871 if( status == PSA_SUCCESS )
3872 operation->iv_set = 1;
3873 else
mohammad1603503973b2018-03-12 15:59:30 +02003874 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003875 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003876}
3877
Gilles Peskinee553c652018-06-04 16:22:46 +02003878psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3879 const uint8_t *input,
3880 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003881 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003882 size_t output_size,
3883 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003884{
itayzafrir534bd7c2018-08-02 13:56:32 +03003885 psa_status_t status;
3886 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003887 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003888
3889 if( operation->alg == 0 )
3890 {
3891 return( PSA_ERROR_BAD_STATE );
3892 }
3893
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003894 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003895 {
3896 /* Take the unprocessed partial block left over from previous
3897 * update calls, if any, plus the input to this call. Remove
3898 * the last partial block, if any. You get the data that will be
3899 * output in this call. */
3900 expected_output_size =
3901 ( operation->ctx.cipher.unprocessed_len + input_length )
3902 / operation->block_size * operation->block_size;
3903 }
3904 else
3905 {
3906 expected_output_size = input_length;
3907 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003908
Gilles Peskine89d789c2018-06-04 17:17:16 +02003909 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003910 {
3911 status = PSA_ERROR_BUFFER_TOO_SMALL;
3912 goto exit;
3913 }
mohammad160382759612018-03-12 18:16:40 +02003914
mohammad1603503973b2018-03-12 15:59:30 +02003915 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003916 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003917 status = mbedtls_to_psa_error( ret );
3918exit:
3919 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003920 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003921 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003922}
3923
Gilles Peskinee553c652018-06-04 16:22:46 +02003924psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3925 uint8_t *output,
3926 size_t output_size,
3927 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003928{
David Saadab4ecc272019-02-14 13:48:10 +02003929 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003930 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003931 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003932
mohammad1603503973b2018-03-12 15:59:30 +02003933 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003934 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003935 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003936 }
3937 if( operation->iv_required && ! operation->iv_set )
3938 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003939 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003940 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003941
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003942 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003943 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3944 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003945 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003946 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003947 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003948 }
3949
Janos Follath315b51c2018-07-09 16:04:51 +01003950 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3951 temp_output_buffer,
3952 output_length );
3953 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003954 {
Janos Follath315b51c2018-07-09 16:04:51 +01003955 status = mbedtls_to_psa_error( cipher_ret );
3956 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003957 }
Janos Follath315b51c2018-07-09 16:04:51 +01003958
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003959 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003960 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003961 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003962 memcpy( output, temp_output_buffer, *output_length );
3963 else
3964 {
Janos Follath315b51c2018-07-09 16:04:51 +01003965 status = PSA_ERROR_BUFFER_TOO_SMALL;
3966 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003967 }
mohammad1603503973b2018-03-12 15:59:30 +02003968
Gilles Peskine3f108122018-12-07 18:14:53 +01003969 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003970 status = psa_cipher_abort( operation );
3971
3972 return( status );
3973
3974error:
3975
3976 *output_length = 0;
3977
Gilles Peskine3f108122018-12-07 18:14:53 +01003978 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003979 (void) psa_cipher_abort( operation );
3980
3981 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003982}
3983
Gilles Peskinee553c652018-06-04 16:22:46 +02003984psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3985{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003986 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003987 {
3988 /* The object has (apparently) been initialized but it is not
3989 * in use. It's ok to call abort on such an object, and there's
3990 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003991 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003992 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003993
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003994 /* Sanity check (shouldn't happen: operation->alg should
3995 * always have been initialized to a valid value). */
3996 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3997 return( PSA_ERROR_BAD_STATE );
3998
mohammad1603503973b2018-03-12 15:59:30 +02003999 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004000
Moran Peker41deec42018-04-04 15:43:05 +03004001 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004002 operation->key_set = 0;
4003 operation->iv_set = 0;
4004 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004005 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004006 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004007
Moran Peker395db872018-05-31 14:07:14 +03004008 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004009}
4010
Gilles Peskinea0655c32018-04-30 17:06:50 +02004011
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004012
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004013
mohammad16035955c982018-04-26 00:53:03 +03004014/****************************************************************/
4015/* AEAD */
4016/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004017
Gilles Peskineedf9a652018-08-17 18:11:56 +02004018typedef struct
4019{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004020 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004021 const mbedtls_cipher_info_t *cipher_info;
4022 union
4023 {
4024#if defined(MBEDTLS_CCM_C)
4025 mbedtls_ccm_context ccm;
4026#endif /* MBEDTLS_CCM_C */
4027#if defined(MBEDTLS_GCM_C)
4028 mbedtls_gcm_context gcm;
4029#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004030#if defined(MBEDTLS_CHACHAPOLY_C)
4031 mbedtls_chachapoly_context chachapoly;
4032#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004033 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004034 psa_algorithm_t core_alg;
4035 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004036 uint8_t tag_length;
4037} aead_operation_t;
4038
Gilles Peskine30a9e412019-01-14 18:36:12 +01004039static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004040{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004041 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004042 {
4043#if defined(MBEDTLS_CCM_C)
4044 case PSA_ALG_CCM:
4045 mbedtls_ccm_free( &operation->ctx.ccm );
4046 break;
4047#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004048#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004049 case PSA_ALG_GCM:
4050 mbedtls_gcm_free( &operation->ctx.gcm );
4051 break;
4052#endif /* MBEDTLS_GCM_C */
4053 }
4054}
4055
4056static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004057 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004058 psa_key_usage_t usage,
4059 psa_algorithm_t alg )
4060{
4061 psa_status_t status;
4062 size_t key_bits;
4063 mbedtls_cipher_id_t cipher_id;
4064
Gilles Peskine28f8f302019-07-24 13:30:31 +02004065 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004066 if( status != PSA_SUCCESS )
4067 return( status );
4068
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004069 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004070
4071 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004072 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004073 &cipher_id );
4074 if( operation->cipher_info == NULL )
4075 return( PSA_ERROR_NOT_SUPPORTED );
4076
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004077 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004078 {
4079#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004080 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4081 operation->core_alg = PSA_ALG_CCM;
4082 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004083 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4084 * The call to mbedtls_ccm_encrypt_and_tag or
4085 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004086 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004087 return( PSA_ERROR_INVALID_ARGUMENT );
4088 mbedtls_ccm_init( &operation->ctx.ccm );
4089 status = mbedtls_to_psa_error(
4090 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
4091 operation->slot->data.raw.data,
4092 (unsigned int) key_bits ) );
4093 if( status != 0 )
4094 goto cleanup;
4095 break;
4096#endif /* MBEDTLS_CCM_C */
4097
4098#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004099 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4100 operation->core_alg = PSA_ALG_GCM;
4101 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004102 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4103 * The call to mbedtls_gcm_crypt_and_tag or
4104 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004105 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004106 return( PSA_ERROR_INVALID_ARGUMENT );
4107 mbedtls_gcm_init( &operation->ctx.gcm );
4108 status = mbedtls_to_psa_error(
4109 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
4110 operation->slot->data.raw.data,
4111 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004112 if( status != 0 )
4113 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004114 break;
4115#endif /* MBEDTLS_GCM_C */
4116
Gilles Peskine26869f22019-05-06 15:25:00 +02004117#if defined(MBEDTLS_CHACHAPOLY_C)
4118 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4119 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4120 operation->full_tag_length = 16;
4121 /* We only support the default tag length. */
4122 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4123 return( PSA_ERROR_NOT_SUPPORTED );
4124 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4125 status = mbedtls_to_psa_error(
4126 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
4127 operation->slot->data.raw.data ) );
4128 if( status != 0 )
4129 goto cleanup;
4130 break;
4131#endif /* MBEDTLS_CHACHAPOLY_C */
4132
Gilles Peskineedf9a652018-08-17 18:11:56 +02004133 default:
4134 return( PSA_ERROR_NOT_SUPPORTED );
4135 }
4136
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004137 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4138 {
4139 status = PSA_ERROR_INVALID_ARGUMENT;
4140 goto cleanup;
4141 }
4142 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004143
Gilles Peskineedf9a652018-08-17 18:11:56 +02004144 return( PSA_SUCCESS );
4145
4146cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004147 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004148 return( status );
4149}
4150
Gilles Peskinec5487a82018-12-03 18:08:14 +01004151psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004152 psa_algorithm_t alg,
4153 const uint8_t *nonce,
4154 size_t nonce_length,
4155 const uint8_t *additional_data,
4156 size_t additional_data_length,
4157 const uint8_t *plaintext,
4158 size_t plaintext_length,
4159 uint8_t *ciphertext,
4160 size_t ciphertext_size,
4161 size_t *ciphertext_length )
4162{
mohammad16035955c982018-04-26 00:53:03 +03004163 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004164 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004165 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004166
mohammad1603f08a5502018-06-03 15:05:47 +03004167 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004168
Gilles Peskinec5487a82018-12-03 18:08:14 +01004169 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004170 if( status != PSA_SUCCESS )
4171 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004172
Gilles Peskineedf9a652018-08-17 18:11:56 +02004173 /* For all currently supported modes, the tag is at the end of the
4174 * ciphertext. */
4175 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4176 {
4177 status = PSA_ERROR_BUFFER_TOO_SMALL;
4178 goto exit;
4179 }
4180 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004181
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004182#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004183 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004184 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004185 status = mbedtls_to_psa_error(
4186 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4187 MBEDTLS_GCM_ENCRYPT,
4188 plaintext_length,
4189 nonce, nonce_length,
4190 additional_data, additional_data_length,
4191 plaintext, ciphertext,
4192 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004193 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004194 else
4195#endif /* MBEDTLS_GCM_C */
4196#if defined(MBEDTLS_CCM_C)
4197 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004198 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004199 status = mbedtls_to_psa_error(
4200 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4201 plaintext_length,
4202 nonce, nonce_length,
4203 additional_data,
4204 additional_data_length,
4205 plaintext, ciphertext,
4206 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004207 }
mohammad16035c8845f2018-05-09 05:40:09 -07004208 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004209#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004210#if defined(MBEDTLS_CHACHAPOLY_C)
4211 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4212 {
4213 if( nonce_length != 12 || operation.tag_length != 16 )
4214 {
4215 status = PSA_ERROR_NOT_SUPPORTED;
4216 goto exit;
4217 }
4218 status = mbedtls_to_psa_error(
4219 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4220 plaintext_length,
4221 nonce,
4222 additional_data,
4223 additional_data_length,
4224 plaintext,
4225 ciphertext,
4226 tag ) );
4227 }
4228 else
4229#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004230 {
mohammad1603554faad2018-06-03 15:07:38 +03004231 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004232 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004233
Gilles Peskineedf9a652018-08-17 18:11:56 +02004234 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4235 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004236
Gilles Peskineedf9a652018-08-17 18:11:56 +02004237exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004238 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004239 if( status == PSA_SUCCESS )
4240 *ciphertext_length = plaintext_length + operation.tag_length;
4241 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004242}
4243
Gilles Peskineee652a32018-06-01 19:23:52 +02004244/* Locate the tag in a ciphertext buffer containing the encrypted data
4245 * followed by the tag. Return the length of the part preceding the tag in
4246 * *plaintext_length. This is the size of the plaintext in modes where
4247 * the encrypted data has the same size as the plaintext, such as
4248 * CCM and GCM. */
4249static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4250 const uint8_t *ciphertext,
4251 size_t ciphertext_length,
4252 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004253 const uint8_t **p_tag )
4254{
4255 size_t payload_length;
4256 if( tag_length > ciphertext_length )
4257 return( PSA_ERROR_INVALID_ARGUMENT );
4258 payload_length = ciphertext_length - tag_length;
4259 if( payload_length > plaintext_size )
4260 return( PSA_ERROR_BUFFER_TOO_SMALL );
4261 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004262 return( PSA_SUCCESS );
4263}
4264
Gilles Peskinec5487a82018-12-03 18:08:14 +01004265psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004266 psa_algorithm_t alg,
4267 const uint8_t *nonce,
4268 size_t nonce_length,
4269 const uint8_t *additional_data,
4270 size_t additional_data_length,
4271 const uint8_t *ciphertext,
4272 size_t ciphertext_length,
4273 uint8_t *plaintext,
4274 size_t plaintext_size,
4275 size_t *plaintext_length )
4276{
mohammad16035955c982018-04-26 00:53:03 +03004277 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004278 aead_operation_t operation;
4279 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004280
Gilles Peskineee652a32018-06-01 19:23:52 +02004281 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004282
Gilles Peskinec5487a82018-12-03 18:08:14 +01004283 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004284 if( status != PSA_SUCCESS )
4285 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004286
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004287 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4288 ciphertext, ciphertext_length,
4289 plaintext_size, &tag );
4290 if( status != PSA_SUCCESS )
4291 goto exit;
4292
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004293#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004294 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004295 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004296 status = mbedtls_to_psa_error(
4297 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4298 ciphertext_length - operation.tag_length,
4299 nonce, nonce_length,
4300 additional_data,
4301 additional_data_length,
4302 tag, operation.tag_length,
4303 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004304 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004305 else
4306#endif /* MBEDTLS_GCM_C */
4307#if defined(MBEDTLS_CCM_C)
4308 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004309 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004310 status = mbedtls_to_psa_error(
4311 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4312 ciphertext_length - operation.tag_length,
4313 nonce, nonce_length,
4314 additional_data,
4315 additional_data_length,
4316 ciphertext, plaintext,
4317 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004318 }
mohammad160339574652018-06-01 04:39:53 -07004319 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004320#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004321#if defined(MBEDTLS_CHACHAPOLY_C)
4322 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4323 {
4324 if( nonce_length != 12 || operation.tag_length != 16 )
4325 {
4326 status = PSA_ERROR_NOT_SUPPORTED;
4327 goto exit;
4328 }
4329 status = mbedtls_to_psa_error(
4330 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4331 ciphertext_length - operation.tag_length,
4332 nonce,
4333 additional_data,
4334 additional_data_length,
4335 tag,
4336 ciphertext,
4337 plaintext ) );
4338 }
4339 else
4340#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004341 {
mohammad1603554faad2018-06-03 15:07:38 +03004342 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004343 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004344
Gilles Peskineedf9a652018-08-17 18:11:56 +02004345 if( status != PSA_SUCCESS && plaintext_size != 0 )
4346 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004347
Gilles Peskineedf9a652018-08-17 18:11:56 +02004348exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004349 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004350 if( status == PSA_SUCCESS )
4351 *plaintext_length = ciphertext_length - operation.tag_length;
4352 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004353}
4354
Gilles Peskinea0655c32018-04-30 17:06:50 +02004355
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004356
Gilles Peskine20035e32018-02-03 22:44:14 +01004357/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004358/* Generators */
4359/****************************************************************/
4360
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004361#define HKDF_STATE_INIT 0 /* no input yet */
4362#define HKDF_STATE_STARTED 1 /* got salt */
4363#define HKDF_STATE_KEYED 2 /* got key */
4364#define HKDF_STATE_OUTPUT 3 /* output started */
4365
Gilles Peskinecbe66502019-05-16 16:59:18 +02004366static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004367 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004368{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004369 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4370 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004371 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004372 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004373}
4374
4375
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004376psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004377{
4378 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004379 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004380 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004381 {
4382 /* The object has (apparently) been initialized but it is not
4383 * in use. It's ok to call abort on such an object, and there's
4384 * nothing to do. */
4385 }
4386 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004387#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004388 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004389 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004390 mbedtls_free( operation->ctx.hkdf.info );
4391 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004392 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004393 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004394 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004395 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004396 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004397 if( operation->ctx.tls12_prf.seed != NULL )
4398 {
4399 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4400 operation->ctx.tls12_prf.seed_length );
4401 mbedtls_free( operation->ctx.tls12_prf.seed );
4402 }
4403
4404 if( operation->ctx.tls12_prf.label != NULL )
4405 {
4406 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4407 operation->ctx.tls12_prf.label_length );
4408 mbedtls_free( operation->ctx.tls12_prf.label );
4409 }
4410
4411 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4412
4413 /* We leave the fields Ai and output_block to be erased safely by the
4414 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004415 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004416 else
4417#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004418 {
4419 status = PSA_ERROR_BAD_STATE;
4420 }
Janos Follath083036a2019-06-11 10:22:26 +01004421 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004422 return( status );
4423}
4424
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004425psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004426 size_t *capacity)
4427{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004428 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004429 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004430 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004431 return PSA_ERROR_BAD_STATE;
4432 }
4433
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004434 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004435 return( PSA_SUCCESS );
4436}
4437
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004438psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004439 size_t capacity )
4440{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004441 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004442 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004443 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004444 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004445 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004446 return( PSA_SUCCESS );
4447}
4448
Gilles Peskinebef7f142018-07-12 17:22:21 +02004449#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004450/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004451 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004452static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004453 psa_algorithm_t hash_alg,
4454 uint8_t *output,
4455 size_t output_length )
4456{
4457 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4458 psa_status_t status;
4459
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004460 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4461 return( PSA_ERROR_BAD_STATE );
4462 hkdf->state = HKDF_STATE_OUTPUT;
4463
Gilles Peskinebef7f142018-07-12 17:22:21 +02004464 while( output_length != 0 )
4465 {
4466 /* Copy what remains of the current block */
4467 uint8_t n = hash_length - hkdf->offset_in_block;
4468 if( n > output_length )
4469 n = (uint8_t) output_length;
4470 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4471 output += n;
4472 output_length -= n;
4473 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004474 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004475 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004476 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004477 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004478 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004479 * object was corrupted or if this function is called directly
4480 * inside the library. */
4481 if( hkdf->block_number == 0xff )
4482 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004483
4484 /* We need a new block */
4485 ++hkdf->block_number;
4486 hkdf->offset_in_block = 0;
4487 status = psa_hmac_setup_internal( &hkdf->hmac,
4488 hkdf->prk, hash_length,
4489 hash_alg );
4490 if( status != PSA_SUCCESS )
4491 return( status );
4492 if( hkdf->block_number != 1 )
4493 {
4494 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4495 hkdf->output_block,
4496 hash_length );
4497 if( status != PSA_SUCCESS )
4498 return( status );
4499 }
4500 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4501 hkdf->info,
4502 hkdf->info_length );
4503 if( status != PSA_SUCCESS )
4504 return( status );
4505 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4506 &hkdf->block_number, 1 );
4507 if( status != PSA_SUCCESS )
4508 return( status );
4509 status = psa_hmac_finish_internal( &hkdf->hmac,
4510 hkdf->output_block,
4511 sizeof( hkdf->output_block ) );
4512 if( status != PSA_SUCCESS )
4513 return( status );
4514 }
4515
4516 return( PSA_SUCCESS );
4517}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004518
Janos Follath7742fee2019-06-17 12:58:10 +01004519static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4520 psa_tls12_prf_key_derivation_t *tls12_prf,
4521 psa_algorithm_t alg )
4522{
4523 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4524 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004525 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4526 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004527
Janos Follath7742fee2019-06-17 12:58:10 +01004528 /* We can't be wanting more output after block 0xff, otherwise
4529 * the capacity check in psa_key_derivation_output_bytes() would have
4530 * prevented this call. It could happen only if the operation
4531 * object was corrupted or if this function is called directly
4532 * inside the library. */
4533 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004534 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004535
4536 /* We need a new block */
4537 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004538 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004539
4540 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4541 *
4542 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4543 *
4544 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4545 * HMAC_hash(secret, A(2) + seed) +
4546 * HMAC_hash(secret, A(3) + seed) + ...
4547 *
4548 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004549 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004550 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004551 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004552 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004553 * is currently extracted as `output_block` and where i is
4554 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004555 */
4556
Janos Follathea29bfb2019-06-19 12:21:20 +01004557 /* Save the hash context before using it, to preserve the hash state with
4558 * only the inner padding in it. We need this, because inner padding depends
4559 * on the key (secret in the RFC's terminology). */
4560 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4561 if( status != PSA_SUCCESS )
4562 goto cleanup;
4563
4564 /* Calculate A(i) where i = tls12_prf->block_number. */
4565 if( tls12_prf->block_number == 1 )
4566 {
4567 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4568 * the variable seed and in this instance means it in the context of the
4569 * P_hash function, where seed = label + seed.) */
4570 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4571 tls12_prf->label, tls12_prf->label_length );
4572 if( status != PSA_SUCCESS )
4573 goto cleanup;
4574 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4575 tls12_prf->seed, tls12_prf->seed_length );
4576 if( status != PSA_SUCCESS )
4577 goto cleanup;
4578 }
4579 else
4580 {
4581 /* A(i) = HMAC_hash(secret, A(i-1)) */
4582 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4583 tls12_prf->Ai, hash_length );
4584 if( status != PSA_SUCCESS )
4585 goto cleanup;
4586 }
4587
4588 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4589 tls12_prf->Ai, hash_length );
4590 if( status != PSA_SUCCESS )
4591 goto cleanup;
4592 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4593 if( status != PSA_SUCCESS )
4594 goto cleanup;
4595
4596 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4597 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4598 tls12_prf->Ai, hash_length );
4599 if( status != PSA_SUCCESS )
4600 goto cleanup;
4601 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4602 tls12_prf->label, tls12_prf->label_length );
4603 if( status != PSA_SUCCESS )
4604 goto cleanup;
4605 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4606 tls12_prf->seed, tls12_prf->seed_length );
4607 if( status != PSA_SUCCESS )
4608 goto cleanup;
4609 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4610 tls12_prf->output_block, hash_length );
4611 if( status != PSA_SUCCESS )
4612 goto cleanup;
4613 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4614 if( status != PSA_SUCCESS )
4615 goto cleanup;
4616
Janos Follath7742fee2019-06-17 12:58:10 +01004617
4618cleanup:
4619
Janos Follathea29bfb2019-06-19 12:21:20 +01004620 cleanup_status = psa_hash_abort( &backup );
4621 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4622 status = cleanup_status;
4623
4624 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004625}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004626
Janos Follath844eb0e2019-06-19 12:10:49 +01004627static psa_status_t psa_key_derivation_tls12_prf_read(
4628 psa_tls12_prf_key_derivation_t *tls12_prf,
4629 psa_algorithm_t alg,
4630 uint8_t *output,
4631 size_t output_length )
4632{
4633 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4634 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4635 psa_status_t status;
4636 uint8_t offset, length;
4637
4638 while( output_length != 0 )
4639 {
4640 /* Check if we have fully processed the current block. */
4641 if( tls12_prf->left_in_block == 0 )
4642 {
4643 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4644 alg );
4645 if( status != PSA_SUCCESS )
4646 return( status );
4647
4648 continue;
4649 }
4650
4651 if( tls12_prf->left_in_block > output_length )
4652 length = (uint8_t) output_length;
4653 else
4654 length = tls12_prf->left_in_block;
4655
4656 offset = hash_length - tls12_prf->left_in_block;
4657 memcpy( output, tls12_prf->output_block + offset, length );
4658 output += length;
4659 output_length -= length;
4660 tls12_prf->left_in_block -= length;
4661 }
4662
4663 return( PSA_SUCCESS );
4664}
Gilles Peskinebef7f142018-07-12 17:22:21 +02004665#endif /* MBEDTLS_MD_C */
4666
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004667psa_status_t psa_key_derivation_output_bytes(
4668 psa_key_derivation_operation_t *operation,
4669 uint8_t *output,
4670 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004671{
4672 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004673 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004674
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004675 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004676 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004677 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004678 return PSA_ERROR_BAD_STATE;
4679 }
4680
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004681 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004682 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004683 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004684 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004685 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004686 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004687 goto exit;
4688 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004689 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004690 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004691 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004692 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004693 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4694 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004695 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004696 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004697 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004698 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004699 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004700
Gilles Peskinebef7f142018-07-12 17:22:21 +02004701#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004702 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004703 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004704 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004705 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004706 output, output_length );
4707 }
Janos Follathadbec812019-06-14 11:05:39 +01004708 else
Janos Follathadbec812019-06-14 11:05:39 +01004709 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004710 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004711 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004712 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004713 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004714 output_length );
4715 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004716 else
4717#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004718 {
4719 return( PSA_ERROR_BAD_STATE );
4720 }
4721
4722exit:
4723 if( status != PSA_SUCCESS )
4724 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004725 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004726 * This allows us to differentiate between exhausted operations and
4727 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4728 * operations. */
4729 psa_algorithm_t alg = operation->alg;
4730 psa_key_derivation_abort( operation );
4731 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004732 memset( output, '!', output_length );
4733 }
4734 return( status );
4735}
4736
Gilles Peskine08542d82018-07-19 17:05:42 +02004737#if defined(MBEDTLS_DES_C)
4738static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4739{
4740 if( data_size >= 8 )
4741 mbedtls_des_key_set_parity( data );
4742 if( data_size >= 16 )
4743 mbedtls_des_key_set_parity( data + 8 );
4744 if( data_size >= 24 )
4745 mbedtls_des_key_set_parity( data + 16 );
4746}
4747#endif /* MBEDTLS_DES_C */
4748
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004749static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004750 psa_key_slot_t *slot,
4751 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004752 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004753{
4754 uint8_t *data = NULL;
4755 size_t bytes = PSA_BITS_TO_BYTES( bits );
4756 psa_status_t status;
4757
Gilles Peskine8e338702019-07-30 20:06:31 +02004758 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004759 return( PSA_ERROR_INVALID_ARGUMENT );
4760 if( bits % 8 != 0 )
4761 return( PSA_ERROR_INVALID_ARGUMENT );
4762 data = mbedtls_calloc( 1, bytes );
4763 if( data == NULL )
4764 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4765
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004766 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004767 if( status != PSA_SUCCESS )
4768 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02004769#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004770 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004771 psa_des_set_key_parity( data, bytes );
4772#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004773 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004774
4775exit:
4776 mbedtls_free( data );
4777 return( status );
4778}
4779
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004780psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004781 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004782 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004783{
4784 psa_status_t status;
4785 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004786 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004787
4788 /* Reject any attempt to create a zero-length key so that we don't
4789 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4790 if( psa_get_key_bits( attributes ) == 0 )
4791 return( PSA_ERROR_INVALID_ARGUMENT );
4792
Gilles Peskinedf179142019-07-15 22:02:14 +02004793 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
4794 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004795#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4796 if( driver != NULL )
4797 {
4798 /* Deriving a key in a secure element is not implemented yet. */
4799 status = PSA_ERROR_NOT_SUPPORTED;
4800 }
4801#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004802 if( status == PSA_SUCCESS )
4803 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004804 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004805 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004806 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004807 }
4808 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004809 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004810 if( status != PSA_SUCCESS )
4811 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004812 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004813 *handle = 0;
4814 }
4815 return( status );
4816}
4817
Gilles Peskineeab56e42018-07-12 17:12:33 +02004818
4819
4820/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004821/* Key derivation */
4822/****************************************************************/
4823
Gilles Peskine969c5d62019-01-16 15:53:06 +01004824static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004825 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004826 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004827{
Janos Follath5fe19732019-06-20 15:09:30 +01004828 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4829 * initialisers for this union leave some bytes unspecified.) */
4830 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4831
Gilles Peskine969c5d62019-01-16 15:53:06 +01004832 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004833#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004834 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
4835 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4836 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004837 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004838 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004839 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4840 if( hash_size == 0 )
4841 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004842 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4843 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004844 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004845 {
4846 return( PSA_ERROR_NOT_SUPPORTED );
4847 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004848 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004849 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004850 }
4851#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004852 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004853 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004854}
4855
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004856psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004857 psa_algorithm_t alg )
4858{
4859 psa_status_t status;
4860
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004861 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004862 return( PSA_ERROR_BAD_STATE );
4863
Gilles Peskine6843c292019-01-18 16:44:49 +01004864 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4865 return( PSA_ERROR_INVALID_ARGUMENT );
4866 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004867 {
4868 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004869 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004870 }
4871 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4872 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004873 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004874 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004875 else
4876 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004877
4878 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004879 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004880 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004881}
4882
4883#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004884static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004885 psa_algorithm_t hash_alg,
4886 psa_key_derivation_step_t step,
4887 const uint8_t *data,
4888 size_t data_length )
4889{
4890 psa_status_t status;
4891 switch( step )
4892 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004893 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004894 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004895 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004896 status = psa_hmac_setup_internal( &hkdf->hmac,
4897 data, data_length,
4898 hash_alg );
4899 if( status != PSA_SUCCESS )
4900 return( status );
4901 hkdf->state = HKDF_STATE_STARTED;
4902 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004903 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004904 /* If no salt was provided, use an empty salt. */
4905 if( hkdf->state == HKDF_STATE_INIT )
4906 {
4907 status = psa_hmac_setup_internal( &hkdf->hmac,
4908 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004909 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004910 if( status != PSA_SUCCESS )
4911 return( status );
4912 hkdf->state = HKDF_STATE_STARTED;
4913 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004914 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004915 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004916 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4917 data, data_length );
4918 if( status != PSA_SUCCESS )
4919 return( status );
4920 status = psa_hmac_finish_internal( &hkdf->hmac,
4921 hkdf->prk,
4922 sizeof( hkdf->prk ) );
4923 if( status != PSA_SUCCESS )
4924 return( status );
4925 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4926 hkdf->block_number = 0;
4927 hkdf->state = HKDF_STATE_KEYED;
4928 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004929 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004930 if( hkdf->state == HKDF_STATE_OUTPUT )
4931 return( PSA_ERROR_BAD_STATE );
4932 if( hkdf->info_set )
4933 return( PSA_ERROR_BAD_STATE );
4934 hkdf->info_length = data_length;
4935 if( data_length != 0 )
4936 {
4937 hkdf->info = mbedtls_calloc( 1, data_length );
4938 if( hkdf->info == NULL )
4939 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4940 memcpy( hkdf->info, data, data_length );
4941 }
4942 hkdf->info_set = 1;
4943 return( PSA_SUCCESS );
4944 default:
4945 return( PSA_ERROR_INVALID_ARGUMENT );
4946 }
4947}
Janos Follathb03233e2019-06-11 15:30:30 +01004948
Janos Follathf08e2652019-06-13 09:05:41 +01004949static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4950 const uint8_t *data,
4951 size_t data_length )
4952{
4953 if( prf->state != TLS12_PRF_STATE_INIT )
4954 return( PSA_ERROR_BAD_STATE );
4955
Janos Follathd6dce9f2019-07-04 09:11:38 +01004956 if( data_length != 0 )
4957 {
4958 prf->seed = mbedtls_calloc( 1, data_length );
4959 if( prf->seed == NULL )
4960 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004961
Janos Follathd6dce9f2019-07-04 09:11:38 +01004962 memcpy( prf->seed, data, data_length );
4963 prf->seed_length = data_length;
4964 }
Janos Follathf08e2652019-06-13 09:05:41 +01004965
4966 prf->state = TLS12_PRF_STATE_SEED_SET;
4967
4968 return( PSA_SUCCESS );
4969}
4970
Janos Follath81550542019-06-13 14:26:34 +01004971static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4972 psa_algorithm_t hash_alg,
4973 const uint8_t *data,
4974 size_t data_length )
4975{
4976 psa_status_t status;
4977 if( prf->state != TLS12_PRF_STATE_SEED_SET )
4978 return( PSA_ERROR_BAD_STATE );
4979
4980 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4981 if( status != PSA_SUCCESS )
4982 return( status );
4983
4984 prf->state = TLS12_PRF_STATE_KEY_SET;
4985
4986 return( PSA_SUCCESS );
4987}
4988
Janos Follath6660f0e2019-06-17 08:44:03 +01004989static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4990 psa_tls12_prf_key_derivation_t *prf,
4991 psa_algorithm_t hash_alg,
4992 const uint8_t *data,
4993 size_t data_length )
4994{
4995 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004996 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
4997 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01004998
4999 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5000 return( PSA_ERROR_INVALID_ARGUMENT );
5001
5002 /* Quoting RFC 4279, Section 2:
5003 *
5004 * The premaster secret is formed as follows: if the PSK is N octets
5005 * long, concatenate a uint16 with the value N, N zero octets, a second
5006 * uint16 with the value N, and the PSK itself.
5007 */
5008
Janos Follath40e13932019-06-26 13:22:29 +01005009 *cur++ = ( data_length >> 8 ) & 0xff;
5010 *cur++ = ( data_length >> 0 ) & 0xff;
5011 memset( cur, 0, data_length );
5012 cur += data_length;
5013 *cur++ = pms[0];
5014 *cur++ = pms[1];
5015 memcpy( cur, data, data_length );
5016 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005017
Janos Follath40e13932019-06-26 13:22:29 +01005018 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005019
5020 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5021 return( status );
5022}
5023
Janos Follath63028dd2019-06-13 09:15:47 +01005024static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5025 const uint8_t *data,
5026 size_t data_length )
5027{
5028 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5029 return( PSA_ERROR_BAD_STATE );
5030
Janos Follathd6dce9f2019-07-04 09:11:38 +01005031 if( data_length != 0 )
5032 {
5033 prf->label = mbedtls_calloc( 1, data_length );
5034 if( prf->label == NULL )
5035 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005036
Janos Follathd6dce9f2019-07-04 09:11:38 +01005037 memcpy( prf->label, data, data_length );
5038 prf->label_length = data_length;
5039 }
Janos Follath63028dd2019-06-13 09:15:47 +01005040
5041 prf->state = TLS12_PRF_STATE_LABEL_SET;
5042
5043 return( PSA_SUCCESS );
5044}
5045
Janos Follathb03233e2019-06-11 15:30:30 +01005046static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5047 psa_algorithm_t hash_alg,
5048 psa_key_derivation_step_t step,
5049 const uint8_t *data,
5050 size_t data_length )
5051{
Janos Follathb03233e2019-06-11 15:30:30 +01005052 switch( step )
5053 {
Janos Follathf08e2652019-06-13 09:05:41 +01005054 case PSA_KEY_DERIVATION_INPUT_SEED:
5055 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005056 case PSA_KEY_DERIVATION_INPUT_SECRET:
5057 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005058 case PSA_KEY_DERIVATION_INPUT_LABEL:
5059 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005060 default:
5061 return( PSA_ERROR_INVALID_ARGUMENT );
5062 }
5063}
Janos Follath6660f0e2019-06-17 08:44:03 +01005064
5065static psa_status_t psa_tls12_prf_psk_to_ms_input(
5066 psa_tls12_prf_key_derivation_t *prf,
5067 psa_algorithm_t hash_alg,
5068 psa_key_derivation_step_t step,
5069 const uint8_t *data,
5070 size_t data_length )
5071{
5072 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005073 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005074 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5075 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005076 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005077
5078 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5079}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005080#endif /* MBEDTLS_MD_C */
5081
Janos Follathb80a94e2019-06-12 15:54:46 +01005082static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005083 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005084 psa_key_derivation_step_t step,
5085 const uint8_t *data,
5086 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005087{
5088 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005089 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005090
5091#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005092 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005093 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005094 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005095 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005096 step, data, data_length );
5097 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005098 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005099 {
Janos Follathb03233e2019-06-11 15:30:30 +01005100 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5101 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5102 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005103 }
5104 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5105 {
5106 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5107 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5108 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005109 }
5110 else
5111#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005112 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005113 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005114 return( PSA_ERROR_BAD_STATE );
5115 }
5116
5117 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005118 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005119 return( status );
5120}
5121
Janos Follath51f4a0f2019-06-14 11:35:55 +01005122psa_status_t psa_key_derivation_input_bytes(
5123 psa_key_derivation_operation_t *operation,
5124 psa_key_derivation_step_t step,
5125 const uint8_t *data,
5126 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005127{
Janos Follathc5621512019-06-14 11:27:57 +01005128 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5129 return( PSA_ERROR_INVALID_ARGUMENT );
5130
5131 return( psa_key_derivation_input_internal( operation, step,
5132 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005133}
5134
Janos Follath51f4a0f2019-06-14 11:35:55 +01005135psa_status_t psa_key_derivation_input_key(
5136 psa_key_derivation_operation_t *operation,
5137 psa_key_derivation_step_t step,
5138 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005139{
5140 psa_key_slot_t *slot;
5141 psa_status_t status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02005142 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005143 PSA_KEY_USAGE_DERIVE,
5144 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005145 if( status != PSA_SUCCESS )
5146 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02005147 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005148 return( PSA_ERROR_INVALID_ARGUMENT );
5149 /* Don't allow a key to be used as an input that is usually public.
5150 * This is debatable. It's ok from a cryptographic perspective to
5151 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005152 * the material should be dedicated to a particular input step,
5153 * otherwise this may allow the key to be used in an unintended way
5154 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005155 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005156 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005157 return( psa_key_derivation_input_internal( operation,
5158 step,
5159 slot->data.raw.data,
5160 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005161}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005162
5163
5164
5165/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005166/* Key agreement */
5167/****************************************************************/
5168
Gilles Peskinea05219c2018-11-16 16:02:56 +01005169#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005170static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5171 size_t peer_key_length,
5172 const mbedtls_ecp_keypair *our_key,
5173 uint8_t *shared_secret,
5174 size_t shared_secret_size,
5175 size_t *shared_secret_length )
5176{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005177 mbedtls_ecp_keypair *their_key = NULL;
5178 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005179 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005180 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005181
Jaeden Ameroccdce902019-01-10 11:42:27 +00005182 status = psa_import_ec_public_key(
5183 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5184 peer_key, peer_key_length,
5185 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005186 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005187 goto exit;
5188
Jaeden Amero97271b32019-01-10 19:38:51 +00005189 status = mbedtls_to_psa_error(
5190 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5191 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005192 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005193 status = mbedtls_to_psa_error(
5194 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5195 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005196 goto exit;
5197
Jaeden Amero97271b32019-01-10 19:38:51 +00005198 status = mbedtls_to_psa_error(
5199 mbedtls_ecdh_calc_secret( &ecdh,
5200 shared_secret_length,
5201 shared_secret, shared_secret_size,
5202 mbedtls_ctr_drbg_random,
5203 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005204
5205exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005206 mbedtls_ecdh_free( &ecdh );
Jaeden Ameroccdce902019-01-10 11:42:27 +00005207 mbedtls_ecp_keypair_free( their_key );
5208 mbedtls_free( their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005209 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005210}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005211#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005212
Gilles Peskine01d718c2018-09-18 12:01:02 +02005213#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5214
Gilles Peskine0216fe12019-04-11 21:23:21 +02005215static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5216 psa_key_slot_t *private_key,
5217 const uint8_t *peer_key,
5218 size_t peer_key_length,
5219 uint8_t *shared_secret,
5220 size_t shared_secret_size,
5221 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005222{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005223 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005224 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005225#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005226 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005227 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005228 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005229 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5230 private_key->data.ecp,
5231 shared_secret, shared_secret_size,
5232 shared_secret_length ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005233#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005234 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005235 (void) private_key;
5236 (void) peer_key;
5237 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005238 (void) shared_secret;
5239 (void) shared_secret_size;
5240 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005241 return( PSA_ERROR_NOT_SUPPORTED );
5242 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005243}
5244
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005245/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005246 * to potentially free embedded data structures and wipe confidential data.
5247 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005248static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005249 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005250 psa_key_slot_t *private_key,
5251 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005252 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005253{
5254 psa_status_t status;
5255 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5256 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005257 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005258
5259 /* Step 1: run the secret agreement algorithm to generate the shared
5260 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005261 status = psa_key_agreement_raw_internal( ka_alg,
5262 private_key,
5263 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005264 shared_secret,
5265 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005266 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005267 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005268 goto exit;
5269
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005270 /* Step 2: set up the key derivation to generate key material from
5271 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005272 status = psa_key_derivation_input_internal( operation, step,
5273 shared_secret,
5274 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005275
Gilles Peskine12313cd2018-06-20 00:20:32 +02005276exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005277 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005278 return( status );
5279}
5280
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005281psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005282 psa_key_derivation_step_t step,
5283 psa_key_handle_t private_key,
5284 const uint8_t *peer_key,
5285 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005286{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005287 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005288 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005289 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005290 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005291 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005292 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005293 if( status != PSA_SUCCESS )
5294 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005295 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005296 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005297 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005298 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005299 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005300 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005301}
5302
Gilles Peskinebe697d82019-05-16 18:00:41 +02005303psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5304 psa_key_handle_t private_key,
5305 const uint8_t *peer_key,
5306 size_t peer_key_length,
5307 uint8_t *output,
5308 size_t output_size,
5309 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005310{
5311 psa_key_slot_t *slot;
5312 psa_status_t status;
5313
5314 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5315 {
5316 status = PSA_ERROR_INVALID_ARGUMENT;
5317 goto exit;
5318 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005319 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005320 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005321 if( status != PSA_SUCCESS )
5322 goto exit;
5323
5324 status = psa_key_agreement_raw_internal( alg, slot,
5325 peer_key, peer_key_length,
5326 output, output_size,
5327 output_length );
5328
5329exit:
5330 if( status != PSA_SUCCESS )
5331 {
5332 /* If an error happens and is not handled properly, the output
5333 * may be used as a key to protect sensitive data. Arrange for such
5334 * a key to be random, which is likely to result in decryption or
5335 * verification errors. This is better than filling the buffer with
5336 * some constant data such as zeros, which would result in the data
5337 * being protected with a reproducible, easily knowable key.
5338 */
5339 psa_generate_random( output, output_size );
5340 *output_length = output_size;
5341 }
5342 return( status );
5343}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005344
5345
5346/****************************************************************/
5347/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005348/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005349
Gilles Peskine4c317f42018-07-12 01:24:09 +02005350psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005351 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005352{
Gilles Peskine4c317f42018-07-12 01:24:09 +02005353 int ret;
5354 GUARD_MODULE_INITIALIZED;
5355
Gilles Peskinef181eca2019-08-07 13:49:00 +02005356 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5357 {
5358 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5359 output,
5360 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5361 if( ret != 0 )
5362 return( mbedtls_to_psa_error( ret ) );
5363 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5364 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5365 }
5366
Gilles Peskinee59236f2018-01-27 23:32:46 +01005367 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5368 return( mbedtls_to_psa_error( ret ) );
5369}
5370
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005371#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5372#include "mbedtls/entropy_poll.h"
5373
Gilles Peskine7228da22019-07-15 11:06:15 +02005374psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005375 size_t seed_size )
5376{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005377 if( global_data.initialized )
5378 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005379
5380 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5381 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5382 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5383 return( PSA_ERROR_INVALID_ARGUMENT );
5384
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005385 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005386}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005387#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005388
Gilles Peskinee56e8782019-04-26 17:34:02 +02005389#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5390static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5391 size_t domain_parameters_size,
5392 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005393{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005394 size_t i;
5395 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005396
Gilles Peskinee56e8782019-04-26 17:34:02 +02005397 if( domain_parameters_size == 0 )
5398 {
5399 *exponent = 65537;
5400 return( PSA_SUCCESS );
5401 }
5402
5403 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5404 * support values that fit in a 32-bit integer, which is larger than
5405 * int on just about every platform anyway. */
5406 if( domain_parameters_size > sizeof( acc ) )
5407 return( PSA_ERROR_NOT_SUPPORTED );
5408 for( i = 0; i < domain_parameters_size; i++ )
5409 acc = ( acc << 8 ) | domain_parameters[i];
5410 if( acc > INT_MAX )
5411 return( PSA_ERROR_NOT_SUPPORTED );
5412 *exponent = acc;
5413 return( PSA_SUCCESS );
5414}
5415#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5416
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005417static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005418 psa_key_slot_t *slot, size_t bits,
5419 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005420{
Gilles Peskine8e338702019-07-30 20:06:31 +02005421 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005422
Gilles Peskinee56e8782019-04-26 17:34:02 +02005423 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005424 return( PSA_ERROR_INVALID_ARGUMENT );
5425
Gilles Peskinee59236f2018-01-27 23:32:46 +01005426 if( key_type_is_raw_bytes( type ) )
5427 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005428 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005429 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
5430 if( status != PSA_SUCCESS )
5431 return( status );
5432 status = psa_generate_random( slot->data.raw.data,
5433 slot->data.raw.bytes );
5434 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005435 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005436#if defined(MBEDTLS_DES_C)
5437 if( type == PSA_KEY_TYPE_DES )
5438 psa_des_set_key_parity( slot->data.raw.data,
5439 slot->data.raw.bytes );
5440#endif /* MBEDTLS_DES_C */
5441 }
5442 else
5443
5444#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005445 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005446 {
5447 mbedtls_rsa_context *rsa;
5448 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005449 int exponent;
5450 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005451 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5452 return( PSA_ERROR_NOT_SUPPORTED );
5453 /* Accept only byte-aligned keys, for the same reasons as
5454 * in psa_import_rsa_key(). */
5455 if( bits % 8 != 0 )
5456 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005457 status = psa_read_rsa_exponent( domain_parameters,
5458 domain_parameters_size,
5459 &exponent );
5460 if( status != PSA_SUCCESS )
5461 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005462 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5463 if( rsa == NULL )
5464 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5465 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5466 ret = mbedtls_rsa_gen_key( rsa,
5467 mbedtls_ctr_drbg_random,
5468 &global_data.ctr_drbg,
5469 (unsigned int) bits,
5470 exponent );
5471 if( ret != 0 )
5472 {
5473 mbedtls_rsa_free( rsa );
5474 mbedtls_free( rsa );
5475 return( mbedtls_to_psa_error( ret ) );
5476 }
5477 slot->data.rsa = rsa;
5478 }
5479 else
5480#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5481
5482#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005483 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005484 {
5485 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5486 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5487 const mbedtls_ecp_curve_info *curve_info =
5488 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5489 mbedtls_ecp_keypair *ecp;
5490 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005491 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005492 return( PSA_ERROR_NOT_SUPPORTED );
5493 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5494 return( PSA_ERROR_NOT_SUPPORTED );
5495 if( curve_info->bit_size != bits )
5496 return( PSA_ERROR_INVALID_ARGUMENT );
5497 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5498 if( ecp == NULL )
5499 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5500 mbedtls_ecp_keypair_init( ecp );
5501 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5502 mbedtls_ctr_drbg_random,
5503 &global_data.ctr_drbg );
5504 if( ret != 0 )
5505 {
5506 mbedtls_ecp_keypair_free( ecp );
5507 mbedtls_free( ecp );
5508 return( mbedtls_to_psa_error( ret ) );
5509 }
5510 slot->data.ecp = ecp;
5511 }
5512 else
5513#endif /* MBEDTLS_ECP_C */
5514
5515 return( PSA_ERROR_NOT_SUPPORTED );
5516
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005517 return( PSA_SUCCESS );
5518}
Darryl Green0c6575a2018-11-07 16:05:30 +00005519
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005520psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005521 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005522{
5523 psa_status_t status;
5524 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005525 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02005526
Gilles Peskine0f84d622019-09-12 19:03:13 +02005527 /* Reject any attempt to create a zero-length key so that we don't
5528 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5529 if( psa_get_key_bits( attributes ) == 0 )
5530 return( PSA_ERROR_INVALID_ARGUMENT );
5531
Gilles Peskinedf179142019-07-15 22:02:14 +02005532 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
5533 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005534 if( status != PSA_SUCCESS )
5535 goto exit;
5536
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005537#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5538 if( driver != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00005539 {
Gilles Peskine11792082019-08-06 18:36:36 +02005540 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
5541 size_t pubkey_length = 0; /* We don't support this feature yet */
5542 if( drv->key_management == NULL ||
5543 drv->key_management->p_generate == NULL )
5544 {
5545 status = PSA_ERROR_NOT_SUPPORTED;
5546 goto exit;
5547 }
5548 status = drv->key_management->p_generate(
5549 psa_get_se_driver_context( driver ),
5550 slot->data.se.slot_number, attributes,
5551 NULL, 0, &pubkey_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00005552 }
Gilles Peskine11792082019-08-06 18:36:36 +02005553 else
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005554#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005555 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005556 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005557 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005558 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005559 }
Gilles Peskine11792082019-08-06 18:36:36 +02005560
5561exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005562 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005563 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005564 if( status != PSA_SUCCESS )
5565 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005566 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005567 *handle = 0;
5568 }
Darryl Green0c6575a2018-11-07 16:05:30 +00005569 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005570}
5571
5572
Gilles Peskinee59236f2018-01-27 23:32:46 +01005573
5574/****************************************************************/
5575/* Module setup */
5576/****************************************************************/
5577
Gilles Peskine5e769522018-11-20 21:59:56 +01005578psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5579 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5580 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5581{
5582 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5583 return( PSA_ERROR_BAD_STATE );
5584 global_data.entropy_init = entropy_init;
5585 global_data.entropy_free = entropy_free;
5586 return( PSA_SUCCESS );
5587}
5588
Gilles Peskinee59236f2018-01-27 23:32:46 +01005589void mbedtls_psa_crypto_free( void )
5590{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005591 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005592 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5593 {
5594 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005595 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005596 }
5597 /* Wipe all remaining data, including configuration.
5598 * In particular, this sets all state indicator to the value
5599 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005600 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005601#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005602 /* Unregister all secure element drivers, so that we restart from
5603 * a pristine state. */
5604 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005605#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005606}
5607
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005608#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5609/** Recover a transaction that was interrupted by a power failure.
5610 *
5611 * This function is called during initialization, before psa_crypto_init()
5612 * returns. If this function returns a failure status, the initialization
5613 * fails.
5614 */
5615static psa_status_t psa_crypto_recover_transaction(
5616 const psa_crypto_transaction_t *transaction )
5617{
5618 switch( transaction->unknown.type )
5619 {
5620 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5621 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005622 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005623 * is implemented.
5624 * https://github.com/ARMmbed/mbed-crypto/issues/218
5625 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005626 default:
5627 /* We found an unsupported transaction in the storage.
5628 * We don't know what state the storage is in. Give up. */
5629 return( PSA_ERROR_STORAGE_FAILURE );
5630 }
5631}
5632#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5633
Gilles Peskinee59236f2018-01-27 23:32:46 +01005634psa_status_t psa_crypto_init( void )
5635{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005636 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005637 const unsigned char drbg_seed[] = "PSA";
5638
Gilles Peskinec6b69072018-11-20 21:42:52 +01005639 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005640 if( global_data.initialized != 0 )
5641 return( PSA_SUCCESS );
5642
Gilles Peskine5e769522018-11-20 21:59:56 +01005643 /* Set default configuration if
5644 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5645 if( global_data.entropy_init == NULL )
5646 global_data.entropy_init = mbedtls_entropy_init;
5647 if( global_data.entropy_free == NULL )
5648 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005649
Gilles Peskinec6b69072018-11-20 21:42:52 +01005650 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005651 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01005652#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5653 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5654 /* The PSA entropy injection feature depends on using NV seed as an entropy
5655 * source. Add NV seed as an entropy source for PSA entropy injection. */
5656 mbedtls_entropy_add_source( &global_data.entropy,
5657 mbedtls_nv_seed_poll, NULL,
5658 MBEDTLS_ENTROPY_BLOCK_SIZE,
5659 MBEDTLS_ENTROPY_SOURCE_STRONG );
5660#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01005661 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005662 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005663 status = mbedtls_to_psa_error(
5664 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5665 mbedtls_entropy_func,
5666 &global_data.entropy,
5667 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5668 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005669 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005670 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005671
Gilles Peskine66fb1262018-12-10 16:29:04 +01005672 status = psa_initialize_key_slots( );
5673 if( status != PSA_SUCCESS )
5674 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005675
Gilles Peskine4b734222019-07-24 15:56:31 +02005676#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005677 status = psa_crypto_load_transaction( );
5678 if( status == PSA_SUCCESS )
5679 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005680 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5681 if( status != PSA_SUCCESS )
5682 goto exit;
5683 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005684 }
5685 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5686 {
5687 /* There's no transaction to complete. It's all good. */
5688 status = PSA_SUCCESS;
5689 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005690#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005691
Gilles Peskinec6b69072018-11-20 21:42:52 +01005692 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005693 global_data.initialized = 1;
5694
5695exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005696 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005697 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005698 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005699}
5700
5701#endif /* MBEDTLS_PSA_CRYPTO_C */