blob: 93af0d398cbb18625f5a508e2fa27df9b1a92b13 [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 Peskinedf179142019-07-15 22:02:14 +02001829 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
1830 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001831 if( status != PSA_SUCCESS )
1832 goto exit;
1833
Gilles Peskine5d309672019-07-12 23:47:28 +02001834#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1835 if( driver != NULL )
1836 {
1837 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001838 /* The driver should set the number of key bits, however in
1839 * case it doesn't, we initialize bits to an invalid value. */
1840 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001841 if( drv->key_management == NULL ||
1842 drv->key_management->p_import == NULL )
1843 {
1844 status = PSA_ERROR_NOT_SUPPORTED;
1845 goto exit;
1846 }
1847 status = drv->key_management->p_import(
1848 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02001849 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001850 &bits );
1851 if( status != PSA_SUCCESS )
1852 goto exit;
1853 if( bits > PSA_MAX_KEY_BITS )
1854 {
1855 status = PSA_ERROR_NOT_SUPPORTED;
1856 goto exit;
1857 }
1858 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001859 }
1860 else
1861#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1862 {
1863 status = psa_import_key_into_slot( slot, data, data_length );
1864 if( status != PSA_SUCCESS )
1865 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001866 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001867 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001868 if( status != PSA_SUCCESS )
1869 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001870
Gilles Peskine011e4282019-06-26 18:34:38 +02001871 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001872exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001873 if( status != PSA_SUCCESS )
1874 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001875 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001876 *handle = 0;
1877 }
1878 return( status );
1879}
1880
Gilles Peskined7729582019-08-05 15:55:54 +02001881#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1882psa_status_t mbedtls_psa_register_se_key(
1883 const psa_key_attributes_t *attributes )
1884{
1885 psa_status_t status;
1886 psa_key_slot_t *slot = NULL;
1887 psa_se_drv_table_entry_t *driver = NULL;
1888 const psa_drv_se_t *drv;
1889 psa_key_handle_t handle = 0;
1890
1891 /* Leaving attributes unspecified is not currently supported.
1892 * It could make sense to query the key type and size from the
1893 * secure element, but not all secure elements support this
1894 * and the driver HAL doesn't currently support it. */
1895 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1896 return( PSA_ERROR_NOT_SUPPORTED );
1897 if( psa_get_key_bits( attributes ) == 0 )
1898 return( PSA_ERROR_NOT_SUPPORTED );
1899
1900 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
1901 &handle, &slot, &driver );
1902 if( status != PSA_SUCCESS )
1903 goto exit;
1904
1905 if( driver == NULL )
1906 {
1907 status = PSA_ERROR_INVALID_ARGUMENT;
1908 goto exit;
1909 }
1910 drv = psa_get_se_driver_methods( driver );
1911
1912 if ( psa_get_key_slot_number( attributes,
1913 &slot->data.se.slot_number ) != PSA_SUCCESS )
1914 {
1915 /* The application didn't specify a slot number. This doesn't
1916 * make sense when registering a slot. */
1917 status = PSA_ERROR_INVALID_ARGUMENT;
1918 goto exit;
1919 }
1920
Gilles Peskinea5f87492019-08-05 16:46:18 +02001921 /* If the driver has a slot number validation method, call it.
1922 * If it doesn't, it means the secure element is unable to validate
1923 * anything and so we have to trust the application. */
1924 if( drv->key_management != NULL &&
1925 drv->key_management->p_validate_slot_number != NULL )
1926 {
1927 status = drv->key_management->p_validate_slot_number(
1928 psa_get_se_driver_context( driver ),
1929 attributes,
1930 PSA_KEY_CREATION_REGISTER,
1931 slot->data.se.slot_number );
1932 if( status != PSA_SUCCESS )
1933 goto exit;
1934 }
1935
Gilles Peskined7729582019-08-05 15:55:54 +02001936 status = psa_finish_key_creation( slot, driver );
1937
1938exit:
1939 if( status != PSA_SUCCESS )
1940 {
1941 psa_fail_key_creation( slot, driver );
1942 }
1943 /* Registration doesn't keep the key in RAM. */
1944 psa_close_key( handle );
1945 return( status );
1946}
1947#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1948
Gilles Peskinef603c712019-01-19 13:40:11 +01001949static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001950 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001951{
1952 psa_status_t status;
1953 uint8_t *buffer = NULL;
1954 size_t buffer_size = 0;
1955 size_t length;
1956
Gilles Peskine8e338702019-07-30 20:06:31 +02001957 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001958 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01001959 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001960 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001961 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01001962 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1963 if( status != PSA_SUCCESS )
1964 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001965 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001966 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01001967
1968exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001969 if( buffer_size != 0 )
1970 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001971 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01001972 return( status );
1973}
1974
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001975psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1976 const psa_key_attributes_t *specified_attributes,
1977 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01001978{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001979 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01001980 psa_key_slot_t *source_slot = NULL;
1981 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001982 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001983 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001984
Gilles Peskine28f8f302019-07-24 13:30:31 +02001985 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001986 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001987 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001988 goto exit;
1989
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001990 status = psa_validate_optional_attributes( source_slot,
1991 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001992 if( status != PSA_SUCCESS )
1993 goto exit;
1994
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001995 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001996 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001997 if( status != PSA_SUCCESS )
1998 goto exit;
1999
Gilles Peskinedf179142019-07-15 22:02:14 +02002000 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2001 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002002 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002003 if( status != PSA_SUCCESS )
2004 goto exit;
2005
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002006#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2007 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002008 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002009 /* Copying to a secure element is not implemented yet. */
2010 status = PSA_ERROR_NOT_SUPPORTED;
2011 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002012 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002013#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002014
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002015 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002016 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002018
Gilles Peskine011e4282019-06-26 18:34:38 +02002019 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002020exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002021 if( status != PSA_SUCCESS )
2022 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002023 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002024 *target_handle = 0;
2025 }
2026 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002027}
2028
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002029
2030
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002031/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002032/* Message digests */
2033/****************************************************************/
2034
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002035static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002036{
2037 switch( alg )
2038 {
2039#if defined(MBEDTLS_MD2_C)
2040 case PSA_ALG_MD2:
2041 return( &mbedtls_md2_info );
2042#endif
2043#if defined(MBEDTLS_MD4_C)
2044 case PSA_ALG_MD4:
2045 return( &mbedtls_md4_info );
2046#endif
2047#if defined(MBEDTLS_MD5_C)
2048 case PSA_ALG_MD5:
2049 return( &mbedtls_md5_info );
2050#endif
2051#if defined(MBEDTLS_RIPEMD160_C)
2052 case PSA_ALG_RIPEMD160:
2053 return( &mbedtls_ripemd160_info );
2054#endif
2055#if defined(MBEDTLS_SHA1_C)
2056 case PSA_ALG_SHA_1:
2057 return( &mbedtls_sha1_info );
2058#endif
2059#if defined(MBEDTLS_SHA256_C)
2060 case PSA_ALG_SHA_224:
2061 return( &mbedtls_sha224_info );
2062 case PSA_ALG_SHA_256:
2063 return( &mbedtls_sha256_info );
2064#endif
2065#if defined(MBEDTLS_SHA512_C)
2066 case PSA_ALG_SHA_384:
2067 return( &mbedtls_sha384_info );
2068 case PSA_ALG_SHA_512:
2069 return( &mbedtls_sha512_info );
2070#endif
2071 default:
2072 return( NULL );
2073 }
2074}
2075
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002076psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2077{
2078 switch( operation->alg )
2079 {
Gilles Peskine81736312018-06-26 15:04:31 +02002080 case 0:
2081 /* The object has (apparently) been initialized but it is not
2082 * in use. It's ok to call abort on such an object, and there's
2083 * nothing to do. */
2084 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002085#if defined(MBEDTLS_MD2_C)
2086 case PSA_ALG_MD2:
2087 mbedtls_md2_free( &operation->ctx.md2 );
2088 break;
2089#endif
2090#if defined(MBEDTLS_MD4_C)
2091 case PSA_ALG_MD4:
2092 mbedtls_md4_free( &operation->ctx.md4 );
2093 break;
2094#endif
2095#if defined(MBEDTLS_MD5_C)
2096 case PSA_ALG_MD5:
2097 mbedtls_md5_free( &operation->ctx.md5 );
2098 break;
2099#endif
2100#if defined(MBEDTLS_RIPEMD160_C)
2101 case PSA_ALG_RIPEMD160:
2102 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2103 break;
2104#endif
2105#if defined(MBEDTLS_SHA1_C)
2106 case PSA_ALG_SHA_1:
2107 mbedtls_sha1_free( &operation->ctx.sha1 );
2108 break;
2109#endif
2110#if defined(MBEDTLS_SHA256_C)
2111 case PSA_ALG_SHA_224:
2112 case PSA_ALG_SHA_256:
2113 mbedtls_sha256_free( &operation->ctx.sha256 );
2114 break;
2115#endif
2116#if defined(MBEDTLS_SHA512_C)
2117 case PSA_ALG_SHA_384:
2118 case PSA_ALG_SHA_512:
2119 mbedtls_sha512_free( &operation->ctx.sha512 );
2120 break;
2121#endif
2122 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002123 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002124 }
2125 operation->alg = 0;
2126 return( PSA_SUCCESS );
2127}
2128
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002129psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002130 psa_algorithm_t alg )
2131{
2132 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002133
2134 /* A context must be freshly initialized before it can be set up. */
2135 if( operation->alg != 0 )
2136 {
2137 return( PSA_ERROR_BAD_STATE );
2138 }
2139
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002140 switch( alg )
2141 {
2142#if defined(MBEDTLS_MD2_C)
2143 case PSA_ALG_MD2:
2144 mbedtls_md2_init( &operation->ctx.md2 );
2145 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2146 break;
2147#endif
2148#if defined(MBEDTLS_MD4_C)
2149 case PSA_ALG_MD4:
2150 mbedtls_md4_init( &operation->ctx.md4 );
2151 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2152 break;
2153#endif
2154#if defined(MBEDTLS_MD5_C)
2155 case PSA_ALG_MD5:
2156 mbedtls_md5_init( &operation->ctx.md5 );
2157 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2158 break;
2159#endif
2160#if defined(MBEDTLS_RIPEMD160_C)
2161 case PSA_ALG_RIPEMD160:
2162 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2163 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2164 break;
2165#endif
2166#if defined(MBEDTLS_SHA1_C)
2167 case PSA_ALG_SHA_1:
2168 mbedtls_sha1_init( &operation->ctx.sha1 );
2169 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2170 break;
2171#endif
2172#if defined(MBEDTLS_SHA256_C)
2173 case PSA_ALG_SHA_224:
2174 mbedtls_sha256_init( &operation->ctx.sha256 );
2175 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2176 break;
2177 case PSA_ALG_SHA_256:
2178 mbedtls_sha256_init( &operation->ctx.sha256 );
2179 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2180 break;
2181#endif
2182#if defined(MBEDTLS_SHA512_C)
2183 case PSA_ALG_SHA_384:
2184 mbedtls_sha512_init( &operation->ctx.sha512 );
2185 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2186 break;
2187 case PSA_ALG_SHA_512:
2188 mbedtls_sha512_init( &operation->ctx.sha512 );
2189 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2190 break;
2191#endif
2192 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002193 return( PSA_ALG_IS_HASH( alg ) ?
2194 PSA_ERROR_NOT_SUPPORTED :
2195 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002196 }
2197 if( ret == 0 )
2198 operation->alg = alg;
2199 else
2200 psa_hash_abort( operation );
2201 return( mbedtls_to_psa_error( ret ) );
2202}
2203
2204psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2205 const uint8_t *input,
2206 size_t input_length )
2207{
2208 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002209
2210 /* Don't require hash implementations to behave correctly on a
2211 * zero-length input, which may have an invalid pointer. */
2212 if( input_length == 0 )
2213 return( PSA_SUCCESS );
2214
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002215 switch( operation->alg )
2216 {
2217#if defined(MBEDTLS_MD2_C)
2218 case PSA_ALG_MD2:
2219 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2220 input, input_length );
2221 break;
2222#endif
2223#if defined(MBEDTLS_MD4_C)
2224 case PSA_ALG_MD4:
2225 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2226 input, input_length );
2227 break;
2228#endif
2229#if defined(MBEDTLS_MD5_C)
2230 case PSA_ALG_MD5:
2231 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2232 input, input_length );
2233 break;
2234#endif
2235#if defined(MBEDTLS_RIPEMD160_C)
2236 case PSA_ALG_RIPEMD160:
2237 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2238 input, input_length );
2239 break;
2240#endif
2241#if defined(MBEDTLS_SHA1_C)
2242 case PSA_ALG_SHA_1:
2243 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2244 input, input_length );
2245 break;
2246#endif
2247#if defined(MBEDTLS_SHA256_C)
2248 case PSA_ALG_SHA_224:
2249 case PSA_ALG_SHA_256:
2250 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2251 input, input_length );
2252 break;
2253#endif
2254#if defined(MBEDTLS_SHA512_C)
2255 case PSA_ALG_SHA_384:
2256 case PSA_ALG_SHA_512:
2257 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2258 input, input_length );
2259 break;
2260#endif
2261 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002262 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002263 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002264
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265 if( ret != 0 )
2266 psa_hash_abort( operation );
2267 return( mbedtls_to_psa_error( ret ) );
2268}
2269
2270psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2271 uint8_t *hash,
2272 size_t hash_size,
2273 size_t *hash_length )
2274{
itayzafrir40835d42018-08-02 13:14:17 +03002275 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002276 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002277 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278
2279 /* Fill the output buffer with something that isn't a valid hash
2280 * (barring an attack on the hash and deliberately-crafted input),
2281 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002282 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002283 /* If hash_size is 0 then hash may be NULL and then the
2284 * call to memset would have undefined behavior. */
2285 if( hash_size != 0 )
2286 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002287
2288 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002289 {
2290 status = PSA_ERROR_BUFFER_TOO_SMALL;
2291 goto exit;
2292 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002293
2294 switch( operation->alg )
2295 {
2296#if defined(MBEDTLS_MD2_C)
2297 case PSA_ALG_MD2:
2298 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2299 break;
2300#endif
2301#if defined(MBEDTLS_MD4_C)
2302 case PSA_ALG_MD4:
2303 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2304 break;
2305#endif
2306#if defined(MBEDTLS_MD5_C)
2307 case PSA_ALG_MD5:
2308 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2309 break;
2310#endif
2311#if defined(MBEDTLS_RIPEMD160_C)
2312 case PSA_ALG_RIPEMD160:
2313 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2314 break;
2315#endif
2316#if defined(MBEDTLS_SHA1_C)
2317 case PSA_ALG_SHA_1:
2318 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2319 break;
2320#endif
2321#if defined(MBEDTLS_SHA256_C)
2322 case PSA_ALG_SHA_224:
2323 case PSA_ALG_SHA_256:
2324 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2325 break;
2326#endif
2327#if defined(MBEDTLS_SHA512_C)
2328 case PSA_ALG_SHA_384:
2329 case PSA_ALG_SHA_512:
2330 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2331 break;
2332#endif
2333 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002334 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002335 }
itayzafrir40835d42018-08-02 13:14:17 +03002336 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337
itayzafrir40835d42018-08-02 13:14:17 +03002338exit:
2339 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002340 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002341 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002342 return( psa_hash_abort( operation ) );
2343 }
2344 else
2345 {
2346 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002347 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002348 }
2349}
2350
Gilles Peskine2d277862018-06-18 15:41:12 +02002351psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2352 const uint8_t *hash,
2353 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002354{
2355 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2356 size_t actual_hash_length;
2357 psa_status_t status = psa_hash_finish( operation,
2358 actual_hash, sizeof( actual_hash ),
2359 &actual_hash_length );
2360 if( status != PSA_SUCCESS )
2361 return( status );
2362 if( actual_hash_length != hash_length )
2363 return( PSA_ERROR_INVALID_SIGNATURE );
2364 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2365 return( PSA_ERROR_INVALID_SIGNATURE );
2366 return( PSA_SUCCESS );
2367}
2368
Gilles Peskineeb35d782019-01-22 17:56:16 +01002369psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2370 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002371{
2372 if( target_operation->alg != 0 )
2373 return( PSA_ERROR_BAD_STATE );
2374
2375 switch( source_operation->alg )
2376 {
2377 case 0:
2378 return( PSA_ERROR_BAD_STATE );
2379#if defined(MBEDTLS_MD2_C)
2380 case PSA_ALG_MD2:
2381 mbedtls_md2_clone( &target_operation->ctx.md2,
2382 &source_operation->ctx.md2 );
2383 break;
2384#endif
2385#if defined(MBEDTLS_MD4_C)
2386 case PSA_ALG_MD4:
2387 mbedtls_md4_clone( &target_operation->ctx.md4,
2388 &source_operation->ctx.md4 );
2389 break;
2390#endif
2391#if defined(MBEDTLS_MD5_C)
2392 case PSA_ALG_MD5:
2393 mbedtls_md5_clone( &target_operation->ctx.md5,
2394 &source_operation->ctx.md5 );
2395 break;
2396#endif
2397#if defined(MBEDTLS_RIPEMD160_C)
2398 case PSA_ALG_RIPEMD160:
2399 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2400 &source_operation->ctx.ripemd160 );
2401 break;
2402#endif
2403#if defined(MBEDTLS_SHA1_C)
2404 case PSA_ALG_SHA_1:
2405 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2406 &source_operation->ctx.sha1 );
2407 break;
2408#endif
2409#if defined(MBEDTLS_SHA256_C)
2410 case PSA_ALG_SHA_224:
2411 case PSA_ALG_SHA_256:
2412 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2413 &source_operation->ctx.sha256 );
2414 break;
2415#endif
2416#if defined(MBEDTLS_SHA512_C)
2417 case PSA_ALG_SHA_384:
2418 case PSA_ALG_SHA_512:
2419 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2420 &source_operation->ctx.sha512 );
2421 break;
2422#endif
2423 default:
2424 return( PSA_ERROR_NOT_SUPPORTED );
2425 }
2426
2427 target_operation->alg = source_operation->alg;
2428 return( PSA_SUCCESS );
2429}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002430
2431
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002432/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002433/* MAC */
2434/****************************************************************/
2435
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002436static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002437 psa_algorithm_t alg,
2438 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002439 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002440 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002442 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002443 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002444
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002445 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002446 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002447
Gilles Peskine8c9def32018-02-08 10:02:12 +01002448 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2449 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002450 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002451 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002452 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002453 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002454 mode = MBEDTLS_MODE_STREAM;
2455 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002456 case PSA_ALG_CTR:
2457 mode = MBEDTLS_MODE_CTR;
2458 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002459 case PSA_ALG_CFB:
2460 mode = MBEDTLS_MODE_CFB;
2461 break;
2462 case PSA_ALG_OFB:
2463 mode = MBEDTLS_MODE_OFB;
2464 break;
2465 case PSA_ALG_CBC_NO_PADDING:
2466 mode = MBEDTLS_MODE_CBC;
2467 break;
2468 case PSA_ALG_CBC_PKCS7:
2469 mode = MBEDTLS_MODE_CBC;
2470 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002471 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002472 mode = MBEDTLS_MODE_CCM;
2473 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002474 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002475 mode = MBEDTLS_MODE_GCM;
2476 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002477 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2478 mode = MBEDTLS_MODE_CHACHAPOLY;
2479 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002480 default:
2481 return( NULL );
2482 }
2483 }
2484 else if( alg == PSA_ALG_CMAC )
2485 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002486 else
2487 return( NULL );
2488
2489 switch( key_type )
2490 {
2491 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002492 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002493 break;
2494 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002495 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2496 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002497 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002498 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002499 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002500 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002501 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2502 * but two-key Triple-DES is functionally three-key Triple-DES
2503 * with K1=K3, so that's how we present it to mbedtls. */
2504 if( key_bits == 128 )
2505 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002506 break;
2507 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002508 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002509 break;
2510 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002511 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002512 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002513 case PSA_KEY_TYPE_CHACHA20:
2514 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2515 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002516 default:
2517 return( NULL );
2518 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002519 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002520 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002521
Jaeden Amero23bbb752018-06-26 14:16:54 +01002522 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2523 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002524}
2525
Gilles Peskinea05219c2018-11-16 16:02:56 +01002526#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002527static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002528{
Gilles Peskine2d277862018-06-18 15:41:12 +02002529 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002530 {
2531 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002532 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002533 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002534 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002535 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002536 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002537 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002538 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002539 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002540 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002541 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002542 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002543 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002544 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002545 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002546 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002547 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002548 return( 128 );
2549 default:
2550 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002551 }
2552}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002553#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002554
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002555/* Initialize the MAC operation structure. Once this function has been
2556 * called, psa_mac_abort can run and will do the right thing. */
2557static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2558 psa_algorithm_t alg )
2559{
2560 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2561
2562 operation->alg = alg;
2563 operation->key_set = 0;
2564 operation->iv_set = 0;
2565 operation->iv_required = 0;
2566 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002567 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002568
2569#if defined(MBEDTLS_CMAC_C)
2570 if( alg == PSA_ALG_CMAC )
2571 {
2572 operation->iv_required = 0;
2573 mbedtls_cipher_init( &operation->ctx.cmac );
2574 status = PSA_SUCCESS;
2575 }
2576 else
2577#endif /* MBEDTLS_CMAC_C */
2578#if defined(MBEDTLS_MD_C)
2579 if( PSA_ALG_IS_HMAC( operation->alg ) )
2580 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002581 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2582 operation->ctx.hmac.hash_ctx.alg = 0;
2583 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002584 }
2585 else
2586#endif /* MBEDTLS_MD_C */
2587 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002588 if( ! PSA_ALG_IS_MAC( alg ) )
2589 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002590 }
2591
2592 if( status != PSA_SUCCESS )
2593 memset( operation, 0, sizeof( *operation ) );
2594 return( status );
2595}
2596
Gilles Peskine01126fa2018-07-12 17:04:55 +02002597#if defined(MBEDTLS_MD_C)
2598static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2599{
Gilles Peskine3f108122018-12-07 18:14:53 +01002600 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002601 return( psa_hash_abort( &hmac->hash_ctx ) );
2602}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002603
Janos Follath999f6482019-06-11 12:04:10 +01002604#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002605static void psa_hmac_init_internal( psa_hmac_internal_data *hmac )
2606{
2607 /* Instances of psa_hash_operation_s can be initialized by zeroization. */
2608 memset( hmac, 0, sizeof( *hmac ) );
2609}
Janos Follath999f6482019-06-11 12:04:10 +01002610#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002611#endif /* MBEDTLS_MD_C */
2612
Gilles Peskine8c9def32018-02-08 10:02:12 +01002613psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2614{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002615 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002616 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002617 /* The object has (apparently) been initialized but it is not
2618 * in use. It's ok to call abort on such an object, and there's
2619 * nothing to do. */
2620 return( PSA_SUCCESS );
2621 }
2622 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002623#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002624 if( operation->alg == PSA_ALG_CMAC )
2625 {
2626 mbedtls_cipher_free( &operation->ctx.cmac );
2627 }
2628 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002629#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002630#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002631 if( PSA_ALG_IS_HMAC( operation->alg ) )
2632 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002633 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002634 }
2635 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002636#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002637 {
2638 /* Sanity check (shouldn't happen: operation->alg should
2639 * always have been initialized to a valid value). */
2640 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002641 }
Moran Peker41deec42018-04-04 15:43:05 +03002642
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643 operation->alg = 0;
2644 operation->key_set = 0;
2645 operation->iv_set = 0;
2646 operation->iv_required = 0;
2647 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002648 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002649
Gilles Peskine8c9def32018-02-08 10:02:12 +01002650 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002651
2652bad_state:
2653 /* If abort is called on an uninitialized object, we can't trust
2654 * anything. Wipe the object in case it contains confidential data.
2655 * This may result in a memory leak if a pointer gets overwritten,
2656 * but it's too late to do anything about this. */
2657 memset( operation, 0, sizeof( *operation ) );
2658 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002659}
2660
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002661#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002662static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002663 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002664 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002665 const mbedtls_cipher_info_t *cipher_info )
2666{
2667 int ret;
2668
2669 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002670
2671 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2672 if( ret != 0 )
2673 return( ret );
2674
2675 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2676 slot->data.raw.data,
2677 key_bits );
2678 return( ret );
2679}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002680#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002681
Gilles Peskine248051a2018-06-20 16:09:38 +02002682#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002683static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2684 const uint8_t *key,
2685 size_t key_length,
2686 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002687{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002688 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002689 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002690 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002691 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002692 psa_status_t status;
2693
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002694 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2695 * overflow below. This should never trigger if the hash algorithm
2696 * is implemented correctly. */
2697 /* The size checks against the ipad and opad buffers cannot be written
2698 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2699 * because that triggers -Wlogical-op on GCC 7.3. */
2700 if( block_size > sizeof( ipad ) )
2701 return( PSA_ERROR_NOT_SUPPORTED );
2702 if( block_size > sizeof( hmac->opad ) )
2703 return( PSA_ERROR_NOT_SUPPORTED );
2704 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002705 return( PSA_ERROR_NOT_SUPPORTED );
2706
Gilles Peskined223b522018-06-11 18:12:58 +02002707 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002708 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002709 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002710 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002711 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002712 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002713 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002714 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002715 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002716 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002717 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002718 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002719 }
Gilles Peskine96889972018-07-12 17:07:03 +02002720 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2721 * but it is permitted. It is common when HMAC is used in HKDF, for
2722 * example. Don't call `memcpy` in the 0-length because `key` could be
2723 * an invalid pointer which would make the behavior undefined. */
2724 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002725 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002726
Gilles Peskined223b522018-06-11 18:12:58 +02002727 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2728 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002729 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002730 ipad[i] ^= 0x36;
2731 memset( ipad + key_length, 0x36, block_size - key_length );
2732
2733 /* Copy the key material from ipad to opad, flipping the requisite bits,
2734 * and filling the rest of opad with the requisite constant. */
2735 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002736 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2737 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002738
Gilles Peskine01126fa2018-07-12 17:04:55 +02002739 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002740 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002741 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002742
Gilles Peskine01126fa2018-07-12 17:04:55 +02002743 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002744
2745cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002746 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002747
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002748 return( status );
2749}
Gilles Peskine248051a2018-06-20 16:09:38 +02002750#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002751
Gilles Peskine89167cb2018-07-08 20:12:23 +02002752static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002753 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002754 psa_algorithm_t alg,
2755 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002756{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002757 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002758 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002759 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002760 psa_key_usage_t usage =
2761 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002762 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002763 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002764
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002765 /* A context must be freshly initialized before it can be set up. */
2766 if( operation->alg != 0 )
2767 {
2768 return( PSA_ERROR_BAD_STATE );
2769 }
2770
Gilles Peskined911eb72018-08-14 15:18:45 +02002771 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002772 if( status != PSA_SUCCESS )
2773 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002774 if( is_sign )
2775 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002776
Gilles Peskine28f8f302019-07-24 13:30:31 +02002777 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002778 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002779 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002780 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002781
Gilles Peskine8c9def32018-02-08 10:02:12 +01002782#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002783 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002784 {
2785 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002786 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002787 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002788 int ret;
2789 if( cipher_info == NULL )
2790 {
2791 status = PSA_ERROR_NOT_SUPPORTED;
2792 goto exit;
2793 }
2794 operation->mac_size = cipher_info->block_size;
2795 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2796 status = mbedtls_to_psa_error( ret );
2797 }
2798 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002799#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002800#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002801 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002802 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002803 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002804 if( hash_alg == 0 )
2805 {
2806 status = PSA_ERROR_NOT_SUPPORTED;
2807 goto exit;
2808 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002809
2810 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2811 /* Sanity check. This shouldn't fail on a valid configuration. */
2812 if( operation->mac_size == 0 ||
2813 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2814 {
2815 status = PSA_ERROR_NOT_SUPPORTED;
2816 goto exit;
2817 }
2818
Gilles Peskine8e338702019-07-30 20:06:31 +02002819 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002820 {
2821 status = PSA_ERROR_INVALID_ARGUMENT;
2822 goto exit;
2823 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002824
Gilles Peskine01126fa2018-07-12 17:04:55 +02002825 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2826 slot->data.raw.data,
2827 slot->data.raw.bytes,
2828 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002829 }
2830 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002831#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002832 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002833 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002834 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002835 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002836
Gilles Peskined911eb72018-08-14 15:18:45 +02002837 if( truncated == 0 )
2838 {
2839 /* The "normal" case: untruncated algorithm. Nothing to do. */
2840 }
2841 else if( truncated < 4 )
2842 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002843 /* A very short MAC is too short for security since it can be
2844 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2845 * so we make this our minimum, even though 32 bits is still
2846 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002847 status = PSA_ERROR_NOT_SUPPORTED;
2848 }
2849 else if( truncated > operation->mac_size )
2850 {
2851 /* It's impossible to "truncate" to a larger length. */
2852 status = PSA_ERROR_INVALID_ARGUMENT;
2853 }
2854 else
2855 operation->mac_size = truncated;
2856
Gilles Peskinefbfac682018-07-08 20:51:54 +02002857exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002858 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002859 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002860 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002861 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002862 else
2863 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002864 operation->key_set = 1;
2865 }
2866 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002867}
2868
Gilles Peskine89167cb2018-07-08 20:12:23 +02002869psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002870 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002871 psa_algorithm_t alg )
2872{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002873 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002874}
2875
2876psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002877 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002878 psa_algorithm_t alg )
2879{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002880 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002881}
2882
Gilles Peskine8c9def32018-02-08 10:02:12 +01002883psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2884 const uint8_t *input,
2885 size_t input_length )
2886{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002887 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002888 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002889 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002890 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002891 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002892 operation->has_input = 1;
2893
Gilles Peskine8c9def32018-02-08 10:02:12 +01002894#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002895 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002896 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002897 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2898 input, input_length );
2899 status = mbedtls_to_psa_error( ret );
2900 }
2901 else
2902#endif /* MBEDTLS_CMAC_C */
2903#if defined(MBEDTLS_MD_C)
2904 if( PSA_ALG_IS_HMAC( operation->alg ) )
2905 {
2906 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2907 input_length );
2908 }
2909 else
2910#endif /* MBEDTLS_MD_C */
2911 {
2912 /* This shouldn't happen if `operation` was initialized by
2913 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002914 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002915 }
2916
Gilles Peskinefbfac682018-07-08 20:51:54 +02002917 if( status != PSA_SUCCESS )
2918 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002919 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002920}
2921
Gilles Peskine01126fa2018-07-12 17:04:55 +02002922#if defined(MBEDTLS_MD_C)
2923static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2924 uint8_t *mac,
2925 size_t mac_size )
2926{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002927 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002928 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2929 size_t hash_size = 0;
2930 size_t block_size = psa_get_hash_block_size( hash_alg );
2931 psa_status_t status;
2932
Gilles Peskine01126fa2018-07-12 17:04:55 +02002933 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2934 if( status != PSA_SUCCESS )
2935 return( status );
2936 /* From here on, tmp needs to be wiped. */
2937
2938 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2939 if( status != PSA_SUCCESS )
2940 goto exit;
2941
2942 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2943 if( status != PSA_SUCCESS )
2944 goto exit;
2945
2946 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2947 if( status != PSA_SUCCESS )
2948 goto exit;
2949
Gilles Peskined911eb72018-08-14 15:18:45 +02002950 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2951 if( status != PSA_SUCCESS )
2952 goto exit;
2953
2954 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002955
2956exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002957 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002958 return( status );
2959}
2960#endif /* MBEDTLS_MD_C */
2961
mohammad16036df908f2018-04-02 08:34:15 -07002962static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002963 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002964 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002965{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002966 if( ! operation->key_set )
2967 return( PSA_ERROR_BAD_STATE );
2968 if( operation->iv_required && ! operation->iv_set )
2969 return( PSA_ERROR_BAD_STATE );
2970
Gilles Peskine8c9def32018-02-08 10:02:12 +01002971 if( mac_size < operation->mac_size )
2972 return( PSA_ERROR_BUFFER_TOO_SMALL );
2973
Gilles Peskine8c9def32018-02-08 10:02:12 +01002974#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002975 if( operation->alg == PSA_ALG_CMAC )
2976 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002977 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2978 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2979 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002980 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002981 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002982 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002983 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002984 else
2985#endif /* MBEDTLS_CMAC_C */
2986#if defined(MBEDTLS_MD_C)
2987 if( PSA_ALG_IS_HMAC( operation->alg ) )
2988 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002989 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002990 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002991 }
2992 else
2993#endif /* MBEDTLS_MD_C */
2994 {
2995 /* This shouldn't happen if `operation` was initialized by
2996 * a setup function. */
2997 return( PSA_ERROR_BAD_STATE );
2998 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002999}
3000
Gilles Peskineacd4be32018-07-08 19:56:25 +02003001psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3002 uint8_t *mac,
3003 size_t mac_size,
3004 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003005{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003006 psa_status_t status;
3007
Jaeden Amero252ef282019-02-15 14:05:35 +00003008 if( operation->alg == 0 )
3009 {
3010 return( PSA_ERROR_BAD_STATE );
3011 }
3012
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003013 /* Fill the output buffer with something that isn't a valid mac
3014 * (barring an attack on the mac and deliberately-crafted input),
3015 * in case the caller doesn't check the return status properly. */
3016 *mac_length = mac_size;
3017 /* If mac_size is 0 then mac may be NULL and then the
3018 * call to memset would have undefined behavior. */
3019 if( mac_size != 0 )
3020 memset( mac, '!', mac_size );
3021
Gilles Peskine89167cb2018-07-08 20:12:23 +02003022 if( ! operation->is_sign )
3023 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003024 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003025 }
mohammad16036df908f2018-04-02 08:34:15 -07003026
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003027 status = psa_mac_finish_internal( operation, mac, mac_size );
3028
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003029 if( status == PSA_SUCCESS )
3030 {
3031 status = psa_mac_abort( operation );
3032 if( status == PSA_SUCCESS )
3033 *mac_length = operation->mac_size;
3034 else
3035 memset( mac, '!', mac_size );
3036 }
3037 else
3038 psa_mac_abort( operation );
3039 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003040}
3041
Gilles Peskineacd4be32018-07-08 19:56:25 +02003042psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3043 const uint8_t *mac,
3044 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003045{
Gilles Peskine828ed142018-06-18 23:25:51 +02003046 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003047 psa_status_t status;
3048
Jaeden Amero252ef282019-02-15 14:05:35 +00003049 if( operation->alg == 0 )
3050 {
3051 return( PSA_ERROR_BAD_STATE );
3052 }
3053
Gilles Peskine89167cb2018-07-08 20:12:23 +02003054 if( operation->is_sign )
3055 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003056 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003057 }
3058 if( operation->mac_size != mac_length )
3059 {
3060 status = PSA_ERROR_INVALID_SIGNATURE;
3061 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003062 }
mohammad16036df908f2018-04-02 08:34:15 -07003063
3064 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003065 actual_mac, sizeof( actual_mac ) );
3066
3067 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3068 status = PSA_ERROR_INVALID_SIGNATURE;
3069
3070cleanup:
3071 if( status == PSA_SUCCESS )
3072 status = psa_mac_abort( operation );
3073 else
3074 psa_mac_abort( operation );
3075
Gilles Peskine3f108122018-12-07 18:14:53 +01003076 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003077
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003078 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003079}
3080
3081
Gilles Peskine20035e32018-02-03 22:44:14 +01003082
Gilles Peskine20035e32018-02-03 22:44:14 +01003083/****************************************************************/
3084/* Asymmetric cryptography */
3085/****************************************************************/
3086
Gilles Peskine2b450e32018-06-27 15:42:46 +02003087#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003088/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003089 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003090static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3091 size_t hash_length,
3092 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003093{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003094 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003095 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003096 *md_alg = mbedtls_md_get_type( md_info );
3097
3098 /* The Mbed TLS RSA module uses an unsigned int for hash length
3099 * parameters. Validate that it fits so that we don't risk an
3100 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003101#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003102 if( hash_length > UINT_MAX )
3103 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003104#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003105
3106#if defined(MBEDTLS_PKCS1_V15)
3107 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3108 * must be correct. */
3109 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3110 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003111 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003112 if( md_info == NULL )
3113 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003114 if( mbedtls_md_get_size( md_info ) != hash_length )
3115 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003116 }
3117#endif /* MBEDTLS_PKCS1_V15 */
3118
3119#if defined(MBEDTLS_PKCS1_V21)
3120 /* PSS requires a hash internally. */
3121 if( PSA_ALG_IS_RSA_PSS( alg ) )
3122 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003123 if( md_info == NULL )
3124 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003125 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003126#endif /* MBEDTLS_PKCS1_V21 */
3127
Gilles Peskine61b91d42018-06-08 16:09:36 +02003128 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003129}
3130
Gilles Peskine2b450e32018-06-27 15:42:46 +02003131static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3132 psa_algorithm_t alg,
3133 const uint8_t *hash,
3134 size_t hash_length,
3135 uint8_t *signature,
3136 size_t signature_size,
3137 size_t *signature_length )
3138{
3139 psa_status_t status;
3140 int ret;
3141 mbedtls_md_type_t md_alg;
3142
3143 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3144 if( status != PSA_SUCCESS )
3145 return( status );
3146
Gilles Peskine630a18a2018-06-29 17:49:35 +02003147 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003148 return( PSA_ERROR_BUFFER_TOO_SMALL );
3149
3150#if defined(MBEDTLS_PKCS1_V15)
3151 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3152 {
3153 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3154 MBEDTLS_MD_NONE );
3155 ret = mbedtls_rsa_pkcs1_sign( rsa,
3156 mbedtls_ctr_drbg_random,
3157 &global_data.ctr_drbg,
3158 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003159 md_alg,
3160 (unsigned int) hash_length,
3161 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003162 signature );
3163 }
3164 else
3165#endif /* MBEDTLS_PKCS1_V15 */
3166#if defined(MBEDTLS_PKCS1_V21)
3167 if( PSA_ALG_IS_RSA_PSS( alg ) )
3168 {
3169 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3170 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3171 mbedtls_ctr_drbg_random,
3172 &global_data.ctr_drbg,
3173 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003174 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003175 (unsigned int) hash_length,
3176 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003177 signature );
3178 }
3179 else
3180#endif /* MBEDTLS_PKCS1_V21 */
3181 {
3182 return( PSA_ERROR_INVALID_ARGUMENT );
3183 }
3184
3185 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003186 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003187 return( mbedtls_to_psa_error( ret ) );
3188}
3189
3190static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3191 psa_algorithm_t alg,
3192 const uint8_t *hash,
3193 size_t hash_length,
3194 const uint8_t *signature,
3195 size_t signature_length )
3196{
3197 psa_status_t status;
3198 int ret;
3199 mbedtls_md_type_t md_alg;
3200
3201 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3202 if( status != PSA_SUCCESS )
3203 return( status );
3204
Gilles Peskine630a18a2018-06-29 17:49:35 +02003205 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003206 return( PSA_ERROR_BUFFER_TOO_SMALL );
3207
3208#if defined(MBEDTLS_PKCS1_V15)
3209 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3210 {
3211 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3212 MBEDTLS_MD_NONE );
3213 ret = mbedtls_rsa_pkcs1_verify( rsa,
3214 mbedtls_ctr_drbg_random,
3215 &global_data.ctr_drbg,
3216 MBEDTLS_RSA_PUBLIC,
3217 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003218 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003219 hash,
3220 signature );
3221 }
3222 else
3223#endif /* MBEDTLS_PKCS1_V15 */
3224#if defined(MBEDTLS_PKCS1_V21)
3225 if( PSA_ALG_IS_RSA_PSS( alg ) )
3226 {
3227 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3228 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3229 mbedtls_ctr_drbg_random,
3230 &global_data.ctr_drbg,
3231 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003232 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003233 (unsigned int) hash_length,
3234 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003235 signature );
3236 }
3237 else
3238#endif /* MBEDTLS_PKCS1_V21 */
3239 {
3240 return( PSA_ERROR_INVALID_ARGUMENT );
3241 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003242
3243 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3244 * the rest of the signature is invalid". This has little use in
3245 * practice and PSA doesn't report this distinction. */
3246 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3247 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003248 return( mbedtls_to_psa_error( ret ) );
3249}
3250#endif /* MBEDTLS_RSA_C */
3251
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003252#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003253/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3254 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3255 * (even though these functions don't modify it). */
3256static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3257 psa_algorithm_t alg,
3258 const uint8_t *hash,
3259 size_t hash_length,
3260 uint8_t *signature,
3261 size_t signature_size,
3262 size_t *signature_length )
3263{
3264 int ret;
3265 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003266 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003267 mbedtls_mpi_init( &r );
3268 mbedtls_mpi_init( &s );
3269
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003270 if( signature_size < 2 * curve_bytes )
3271 {
3272 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3273 goto cleanup;
3274 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003275
Gilles Peskinea05219c2018-11-16 16:02:56 +01003276#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003277 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3278 {
3279 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3280 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3281 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3282 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det( &ecp->grp, &r, &s, &ecp->d,
3283 hash, hash_length,
3284 md_alg ) );
3285 }
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 defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004398 if( operation->ctx.tls12_prf.key != NULL )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004399 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004400 mbedtls_platform_zeroize( operation->ctx.tls12_prf.key,
4401 operation->ctx.tls12_prf.key_len );
4402 mbedtls_free( operation->ctx.tls12_prf.key );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004403 }
Hanno Becker580fba12018-11-13 20:50:45 +00004404
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004405 if( operation->ctx.tls12_prf.Ai_with_seed != NULL )
Hanno Becker580fba12018-11-13 20:50:45 +00004406 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004407 mbedtls_platform_zeroize( operation->ctx.tls12_prf.Ai_with_seed,
4408 operation->ctx.tls12_prf.Ai_with_seed_len );
4409 mbedtls_free( operation->ctx.tls12_prf.Ai_with_seed );
Hanno Becker580fba12018-11-13 20:50:45 +00004410 }
Janos Follath6a1d2622019-06-11 10:37:28 +01004411#else
4412 if( operation->ctx.tls12_prf.seed != NULL )
4413 {
4414 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4415 operation->ctx.tls12_prf.seed_length );
4416 mbedtls_free( operation->ctx.tls12_prf.seed );
4417 }
4418
4419 if( operation->ctx.tls12_prf.label != NULL )
4420 {
4421 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4422 operation->ctx.tls12_prf.label_length );
4423 mbedtls_free( operation->ctx.tls12_prf.label );
4424 }
4425
4426 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4427
4428 /* We leave the fields Ai and output_block to be erased safely by the
4429 * mbedtls_platform_zeroize() in the end of this function. */
Janos Follath999f6482019-06-11 12:04:10 +01004430#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004431 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004432 else
4433#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004434 {
4435 status = PSA_ERROR_BAD_STATE;
4436 }
Janos Follath083036a2019-06-11 10:22:26 +01004437 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004438 return( status );
4439}
4440
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004441psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004442 size_t *capacity)
4443{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004444 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004445 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004446 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004447 return PSA_ERROR_BAD_STATE;
4448 }
4449
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004450 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004451 return( PSA_SUCCESS );
4452}
4453
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004454psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004455 size_t capacity )
4456{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004457 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004458 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004459 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004460 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004461 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004462 return( PSA_SUCCESS );
4463}
4464
Gilles Peskinebef7f142018-07-12 17:22:21 +02004465#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004466/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004467 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004468static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004469 psa_algorithm_t hash_alg,
4470 uint8_t *output,
4471 size_t output_length )
4472{
4473 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4474 psa_status_t status;
4475
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004476 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4477 return( PSA_ERROR_BAD_STATE );
4478 hkdf->state = HKDF_STATE_OUTPUT;
4479
Gilles Peskinebef7f142018-07-12 17:22:21 +02004480 while( output_length != 0 )
4481 {
4482 /* Copy what remains of the current block */
4483 uint8_t n = hash_length - hkdf->offset_in_block;
4484 if( n > output_length )
4485 n = (uint8_t) output_length;
4486 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4487 output += n;
4488 output_length -= n;
4489 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004490 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004491 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004492 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004493 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004494 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004495 * object was corrupted or if this function is called directly
4496 * inside the library. */
4497 if( hkdf->block_number == 0xff )
4498 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004499
4500 /* We need a new block */
4501 ++hkdf->block_number;
4502 hkdf->offset_in_block = 0;
4503 status = psa_hmac_setup_internal( &hkdf->hmac,
4504 hkdf->prk, hash_length,
4505 hash_alg );
4506 if( status != PSA_SUCCESS )
4507 return( status );
4508 if( hkdf->block_number != 1 )
4509 {
4510 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4511 hkdf->output_block,
4512 hash_length );
4513 if( status != PSA_SUCCESS )
4514 return( status );
4515 }
4516 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4517 hkdf->info,
4518 hkdf->info_length );
4519 if( status != PSA_SUCCESS )
4520 return( status );
4521 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4522 &hkdf->block_number, 1 );
4523 if( status != PSA_SUCCESS )
4524 return( status );
4525 status = psa_hmac_finish_internal( &hkdf->hmac,
4526 hkdf->output_block,
4527 sizeof( hkdf->output_block ) );
4528 if( status != PSA_SUCCESS )
4529 return( status );
4530 }
4531
4532 return( PSA_SUCCESS );
4533}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004534
Janos Follath999f6482019-06-11 12:04:10 +01004535#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004536static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4537 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004538 psa_algorithm_t alg )
4539{
4540 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4541 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4542 psa_hmac_internal_data hmac;
4543 psa_status_t status, cleanup_status;
4544
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004545 uint8_t *Ai;
Hanno Becker3b339e22018-11-13 20:56:14 +00004546 size_t Ai_len;
4547
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004548 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004549 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004550 * prevented this call. It could happen only if the operation
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004551 * object was corrupted or if this function is called directly
4552 * inside the library. */
4553 if( tls12_prf->block_number == 0xff )
4554 return( PSA_ERROR_BAD_STATE );
4555
4556 /* We need a new block */
4557 ++tls12_prf->block_number;
4558 tls12_prf->offset_in_block = 0;
4559
4560 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4561 *
4562 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4563 *
4564 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4565 * HMAC_hash(secret, A(2) + seed) +
4566 * HMAC_hash(secret, A(3) + seed) + ...
4567 *
4568 * A(0) = seed
4569 * A(i) = HMAC_hash( secret, A(i-1) )
4570 *
Gilles Peskinecbe66502019-05-16 16:59:18 +02004571 * The `psa_tls12_prf_key_derivation` structures saves the block
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004572 * `HMAC_hash(secret, A(i) + seed)` from which the output
4573 * is currently extracted as `output_block`, while
4574 * `A(i) + seed` is stored in `Ai_with_seed`.
4575 *
4576 * Generating a new block means recalculating `Ai_with_seed`
4577 * from the A(i)-part of it, and afterwards recalculating
4578 * `output_block`.
4579 *
4580 * A(0) is computed at setup time.
4581 *
4582 */
4583
4584 psa_hmac_init_internal( &hmac );
4585
4586 /* We must distinguish the calculation of A(1) from those
4587 * of A(2) and higher, because A(0)=seed has a different
4588 * length than the other A(i). */
4589 if( tls12_prf->block_number == 1 )
4590 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004591 Ai = tls12_prf->Ai_with_seed + hash_length;
4592 Ai_len = tls12_prf->Ai_with_seed_len - hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004593 }
4594 else
4595 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004596 Ai = tls12_prf->Ai_with_seed;
4597 Ai_len = hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004598 }
4599
Hanno Becker3b339e22018-11-13 20:56:14 +00004600 /* Compute A(i+1) = HMAC_hash(secret, A(i)) */
4601 status = psa_hmac_setup_internal( &hmac,
4602 tls12_prf->key,
4603 tls12_prf->key_len,
4604 hash_alg );
4605 if( status != PSA_SUCCESS )
4606 goto cleanup;
4607
4608 status = psa_hash_update( &hmac.hash_ctx,
4609 Ai, Ai_len );
4610 if( status != PSA_SUCCESS )
4611 goto cleanup;
4612
4613 status = psa_hmac_finish_internal( &hmac,
4614 tls12_prf->Ai_with_seed,
4615 hash_length );
4616 if( status != PSA_SUCCESS )
4617 goto cleanup;
4618
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004619 /* Compute the next block `HMAC_hash(secret, A(i+1) + seed)`. */
4620 status = psa_hmac_setup_internal( &hmac,
4621 tls12_prf->key,
4622 tls12_prf->key_len,
4623 hash_alg );
4624 if( status != PSA_SUCCESS )
4625 goto cleanup;
4626
4627 status = psa_hash_update( &hmac.hash_ctx,
4628 tls12_prf->Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00004629 tls12_prf->Ai_with_seed_len );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004630 if( status != PSA_SUCCESS )
4631 goto cleanup;
4632
4633 status = psa_hmac_finish_internal( &hmac,
4634 tls12_prf->output_block,
4635 hash_length );
4636 if( status != PSA_SUCCESS )
4637 goto cleanup;
4638
4639cleanup:
4640
4641 cleanup_status = psa_hmac_abort_internal( &hmac );
4642 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4643 status = cleanup_status;
4644
4645 return( status );
4646}
Janos Follath7742fee2019-06-17 12:58:10 +01004647#else
4648static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4649 psa_tls12_prf_key_derivation_t *tls12_prf,
4650 psa_algorithm_t alg )
4651{
4652 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4653 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004654 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4655 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004656
Janos Follath7742fee2019-06-17 12:58:10 +01004657 /* We can't be wanting more output after block 0xff, otherwise
4658 * the capacity check in psa_key_derivation_output_bytes() would have
4659 * prevented this call. It could happen only if the operation
4660 * object was corrupted or if this function is called directly
4661 * inside the library. */
4662 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004663 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004664
4665 /* We need a new block */
4666 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004667 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004668
4669 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4670 *
4671 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4672 *
4673 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4674 * HMAC_hash(secret, A(2) + seed) +
4675 * HMAC_hash(secret, A(3) + seed) + ...
4676 *
4677 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004678 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004679 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004680 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004681 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004682 * is currently extracted as `output_block` and where i is
4683 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004684 */
4685
Janos Follathea29bfb2019-06-19 12:21:20 +01004686 /* Save the hash context before using it, to preserve the hash state with
4687 * only the inner padding in it. We need this, because inner padding depends
4688 * on the key (secret in the RFC's terminology). */
4689 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4690 if( status != PSA_SUCCESS )
4691 goto cleanup;
4692
4693 /* Calculate A(i) where i = tls12_prf->block_number. */
4694 if( tls12_prf->block_number == 1 )
4695 {
4696 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4697 * the variable seed and in this instance means it in the context of the
4698 * P_hash function, where seed = label + seed.) */
4699 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4700 tls12_prf->label, tls12_prf->label_length );
4701 if( status != PSA_SUCCESS )
4702 goto cleanup;
4703 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4704 tls12_prf->seed, tls12_prf->seed_length );
4705 if( status != PSA_SUCCESS )
4706 goto cleanup;
4707 }
4708 else
4709 {
4710 /* A(i) = HMAC_hash(secret, A(i-1)) */
4711 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4712 tls12_prf->Ai, hash_length );
4713 if( status != PSA_SUCCESS )
4714 goto cleanup;
4715 }
4716
4717 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4718 tls12_prf->Ai, hash_length );
4719 if( status != PSA_SUCCESS )
4720 goto cleanup;
4721 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4722 if( status != PSA_SUCCESS )
4723 goto cleanup;
4724
4725 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4726 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4727 tls12_prf->Ai, hash_length );
4728 if( status != PSA_SUCCESS )
4729 goto cleanup;
4730 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4731 tls12_prf->label, tls12_prf->label_length );
4732 if( status != PSA_SUCCESS )
4733 goto cleanup;
4734 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4735 tls12_prf->seed, tls12_prf->seed_length );
4736 if( status != PSA_SUCCESS )
4737 goto cleanup;
4738 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4739 tls12_prf->output_block, hash_length );
4740 if( status != PSA_SUCCESS )
4741 goto cleanup;
4742 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4743 if( status != PSA_SUCCESS )
4744 goto cleanup;
4745
Janos Follath7742fee2019-06-17 12:58:10 +01004746
4747cleanup:
4748
Janos Follathea29bfb2019-06-19 12:21:20 +01004749 cleanup_status = psa_hash_abort( &backup );
4750 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4751 status = cleanup_status;
4752
4753 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004754}
Janos Follath999f6482019-06-11 12:04:10 +01004755#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004756
Janos Follath999f6482019-06-11 12:04:10 +01004757#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004758/* Read some bytes from an TLS-1.2-PRF-based operation.
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004759 * See Section 5 of RFC 5246. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004760static psa_status_t psa_key_derivation_tls12_prf_read(
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004761 psa_tls12_prf_key_derivation_t *tls12_prf,
4762 psa_algorithm_t alg,
4763 uint8_t *output,
4764 size_t output_length )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004765{
4766 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4767 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4768 psa_status_t status;
4769
4770 while( output_length != 0 )
4771 {
4772 /* Copy what remains of the current block */
4773 uint8_t n = hash_length - tls12_prf->offset_in_block;
4774
4775 /* Check if we have fully processed the current block. */
4776 if( n == 0 )
4777 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004778 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004779 alg );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004780 if( status != PSA_SUCCESS )
4781 return( status );
4782
4783 continue;
4784 }
4785
4786 if( n > output_length )
4787 n = (uint8_t) output_length;
4788 memcpy( output, tls12_prf->output_block + tls12_prf->offset_in_block,
4789 n );
4790 output += n;
4791 output_length -= n;
4792 tls12_prf->offset_in_block += n;
4793 }
4794
4795 return( PSA_SUCCESS );
4796}
Janos Follath844eb0e2019-06-19 12:10:49 +01004797#else
4798static psa_status_t psa_key_derivation_tls12_prf_read(
4799 psa_tls12_prf_key_derivation_t *tls12_prf,
4800 psa_algorithm_t alg,
4801 uint8_t *output,
4802 size_t output_length )
4803{
4804 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4805 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4806 psa_status_t status;
4807 uint8_t offset, length;
4808
4809 while( output_length != 0 )
4810 {
4811 /* Check if we have fully processed the current block. */
4812 if( tls12_prf->left_in_block == 0 )
4813 {
4814 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4815 alg );
4816 if( status != PSA_SUCCESS )
4817 return( status );
4818
4819 continue;
4820 }
4821
4822 if( tls12_prf->left_in_block > output_length )
4823 length = (uint8_t) output_length;
4824 else
4825 length = tls12_prf->left_in_block;
4826
4827 offset = hash_length - tls12_prf->left_in_block;
4828 memcpy( output, tls12_prf->output_block + offset, length );
4829 output += length;
4830 output_length -= length;
4831 tls12_prf->left_in_block -= length;
4832 }
4833
4834 return( PSA_SUCCESS );
4835}
Janos Follath999f6482019-06-11 12:04:10 +01004836#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004837#endif /* MBEDTLS_MD_C */
4838
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004839psa_status_t psa_key_derivation_output_bytes(
4840 psa_key_derivation_operation_t *operation,
4841 uint8_t *output,
4842 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004843{
4844 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004845 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004846
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004847 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004848 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004849 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004850 return PSA_ERROR_BAD_STATE;
4851 }
4852
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004853 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004854 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004855 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004856 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004857 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004858 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004859 goto exit;
4860 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004861 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004862 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004863 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004864 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004865 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4866 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004867 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004868 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004869 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004870 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004871 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004872
Gilles Peskinebef7f142018-07-12 17:22:21 +02004873#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004874 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004875 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004876 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004877 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004878 output, output_length );
4879 }
Janos Follathadbec812019-06-14 11:05:39 +01004880 else
Janos Follathadbec812019-06-14 11:05:39 +01004881 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004882 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004883 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004884 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004885 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004886 output_length );
4887 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004888 else
4889#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004890 {
4891 return( PSA_ERROR_BAD_STATE );
4892 }
4893
4894exit:
4895 if( status != PSA_SUCCESS )
4896 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004897 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004898 * This allows us to differentiate between exhausted operations and
4899 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4900 * operations. */
4901 psa_algorithm_t alg = operation->alg;
4902 psa_key_derivation_abort( operation );
4903 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004904 memset( output, '!', output_length );
4905 }
4906 return( status );
4907}
4908
Gilles Peskine08542d82018-07-19 17:05:42 +02004909#if defined(MBEDTLS_DES_C)
4910static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4911{
4912 if( data_size >= 8 )
4913 mbedtls_des_key_set_parity( data );
4914 if( data_size >= 16 )
4915 mbedtls_des_key_set_parity( data + 8 );
4916 if( data_size >= 24 )
4917 mbedtls_des_key_set_parity( data + 16 );
4918}
4919#endif /* MBEDTLS_DES_C */
4920
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004921static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004922 psa_key_slot_t *slot,
4923 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004924 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004925{
4926 uint8_t *data = NULL;
4927 size_t bytes = PSA_BITS_TO_BYTES( bits );
4928 psa_status_t status;
4929
Gilles Peskine8e338702019-07-30 20:06:31 +02004930 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004931 return( PSA_ERROR_INVALID_ARGUMENT );
4932 if( bits % 8 != 0 )
4933 return( PSA_ERROR_INVALID_ARGUMENT );
4934 data = mbedtls_calloc( 1, bytes );
4935 if( data == NULL )
4936 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4937
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004938 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004939 if( status != PSA_SUCCESS )
4940 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02004941#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004942 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004943 psa_des_set_key_parity( data, bytes );
4944#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004945 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004946
4947exit:
4948 mbedtls_free( data );
4949 return( status );
4950}
4951
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004952psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004953 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004954 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004955{
4956 psa_status_t status;
4957 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004958 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinedf179142019-07-15 22:02:14 +02004959 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
4960 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004961#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4962 if( driver != NULL )
4963 {
4964 /* Deriving a key in a secure element is not implemented yet. */
4965 status = PSA_ERROR_NOT_SUPPORTED;
4966 }
4967#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004968 if( status == PSA_SUCCESS )
4969 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004970 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004971 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004972 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004973 }
4974 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004975 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004976 if( status != PSA_SUCCESS )
4977 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004978 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004979 *handle = 0;
4980 }
4981 return( status );
4982}
4983
Gilles Peskineeab56e42018-07-12 17:12:33 +02004984
4985
4986/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004987/* Key derivation */
4988/****************************************************************/
4989
Gilles Peskinea05219c2018-11-16 16:02:56 +01004990#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004991#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004992/* Set up an HKDF-based operation. This is exactly the extract phase
Gilles Peskine346797d2018-11-16 16:05:06 +01004993 * of the HKDF algorithm.
4994 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004995 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004996 * to potentially free embedded data structures and wipe confidential data.
4997 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004998static psa_status_t psa_key_derivation_hkdf_setup( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004999 const uint8_t *secret,
5000 size_t secret_length,
5001 psa_algorithm_t hash_alg,
5002 const uint8_t *salt,
5003 size_t salt_length,
5004 const uint8_t *label,
5005 size_t label_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005006{
5007 psa_status_t status;
5008 status = psa_hmac_setup_internal( &hkdf->hmac,
5009 salt, salt_length,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005010 hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005011 if( status != PSA_SUCCESS )
5012 return( status );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005013 status = psa_hash_update( &hkdf->hmac.hash_ctx, secret, secret_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005014 if( status != PSA_SUCCESS )
5015 return( status );
5016 status = psa_hmac_finish_internal( &hkdf->hmac,
5017 hkdf->prk,
5018 sizeof( hkdf->prk ) );
5019 if( status != PSA_SUCCESS )
5020 return( status );
5021 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5022 hkdf->block_number = 0;
5023 hkdf->info_length = label_length;
5024 if( label_length != 0 )
5025 {
5026 hkdf->info = mbedtls_calloc( 1, label_length );
5027 if( hkdf->info == NULL )
5028 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5029 memcpy( hkdf->info, label, label_length );
5030 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005031 hkdf->state = HKDF_STATE_KEYED;
5032 hkdf->info_set = 1;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005033 return( PSA_SUCCESS );
5034}
Janos Follath71a4c912019-06-11 09:14:47 +01005035#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01005036#endif /* MBEDTLS_MD_C */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005037
Gilles Peskinea05219c2018-11-16 16:02:56 +01005038#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01005039#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005040/* Set up a TLS-1.2-prf-based operation (see RFC 5246, Section 5).
Gilles Peskine346797d2018-11-16 16:05:06 +01005041 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005042 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005043 * to potentially free embedded data structures and wipe confidential data.
5044 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005045static psa_status_t psa_key_derivation_tls12_prf_setup(
5046 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005047 const uint8_t *key,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005048 size_t key_len,
5049 psa_algorithm_t hash_alg,
5050 const uint8_t *salt,
5051 size_t salt_length,
5052 const uint8_t *label,
5053 size_t label_length )
5054{
5055 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Hanno Becker580fba12018-11-13 20:50:45 +00005056 size_t Ai_with_seed_len = hash_length + salt_length + label_length;
5057 int overflow;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005058
5059 tls12_prf->key = mbedtls_calloc( 1, key_len );
5060 if( tls12_prf->key == NULL )
5061 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5062 tls12_prf->key_len = key_len;
5063 memcpy( tls12_prf->key, key, key_len );
5064
Hanno Becker580fba12018-11-13 20:50:45 +00005065 overflow = ( salt_length + label_length < salt_length ) ||
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005066 ( salt_length + label_length + hash_length < hash_length );
Hanno Becker580fba12018-11-13 20:50:45 +00005067 if( overflow )
5068 return( PSA_ERROR_INVALID_ARGUMENT );
5069
5070 tls12_prf->Ai_with_seed = mbedtls_calloc( 1, Ai_with_seed_len );
5071 if( tls12_prf->Ai_with_seed == NULL )
5072 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5073 tls12_prf->Ai_with_seed_len = Ai_with_seed_len;
5074
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005075 /* Write `label + seed' at the end of the `A(i) + seed` buffer,
5076 * leaving the initial `hash_length` bytes unspecified for now. */
Hanno Becker353e4532018-11-15 09:53:57 +00005077 if( label_length != 0 )
5078 {
5079 memcpy( tls12_prf->Ai_with_seed + hash_length,
5080 label, label_length );
5081 }
5082
5083 if( salt_length != 0 )
5084 {
5085 memcpy( tls12_prf->Ai_with_seed + hash_length + label_length,
5086 salt, salt_length );
5087 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005088
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005089 /* The first block gets generated when
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005090 * psa_key_derivation_output_bytes() is called. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005091 tls12_prf->block_number = 0;
5092 tls12_prf->offset_in_block = hash_length;
5093
5094 return( PSA_SUCCESS );
5095}
Janos Follath71a4c912019-06-11 09:14:47 +01005096#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Becker1aaedc02018-11-16 11:35:34 +00005097
Janos Follath71a4c912019-06-11 09:14:47 +01005098#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005099/* Set up a TLS-1.2-PSK-to-MS-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005100static psa_status_t psa_key_derivation_tls12_psk_to_ms_setup(
5101 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005102 const uint8_t *psk,
Hanno Becker1aaedc02018-11-16 11:35:34 +00005103 size_t psk_len,
5104 psa_algorithm_t hash_alg,
5105 const uint8_t *salt,
5106 size_t salt_length,
5107 const uint8_t *label,
5108 size_t label_length )
5109{
5110 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005111 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
Hanno Becker1aaedc02018-11-16 11:35:34 +00005112
5113 if( psk_len > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5114 return( PSA_ERROR_INVALID_ARGUMENT );
5115
5116 /* Quoting RFC 4279, Section 2:
5117 *
5118 * The premaster secret is formed as follows: if the PSK is N octets
5119 * long, concatenate a uint16 with the value N, N zero octets, a second
5120 * uint16 with the value N, and the PSK itself.
5121 */
5122
5123 pms[0] = ( psk_len >> 8 ) & 0xff;
5124 pms[1] = ( psk_len >> 0 ) & 0xff;
5125 memset( pms + 2, 0, psk_len );
5126 pms[2 + psk_len + 0] = pms[0];
5127 pms[2 + psk_len + 1] = pms[1];
5128 memcpy( pms + 4 + psk_len, psk, psk_len );
5129
Gilles Peskinecbe66502019-05-16 16:59:18 +02005130 status = psa_key_derivation_tls12_prf_setup( tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005131 pms, 4 + 2 * psk_len,
5132 hash_alg,
5133 salt, salt_length,
5134 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005135
Gilles Peskine3f108122018-12-07 18:14:53 +01005136 mbedtls_platform_zeroize( pms, sizeof( pms ) );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005137 return( status );
5138}
Janos Follath71a4c912019-06-11 09:14:47 +01005139#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01005140#endif /* MBEDTLS_MD_C */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005141
Janos Follath71a4c912019-06-11 09:14:47 +01005142#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005143/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005144 * to potentially free embedded data structures and wipe confidential data.
5145 */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005146static psa_status_t psa_key_derivation_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005147 psa_key_derivation_operation_t *operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005148 const uint8_t *secret, size_t secret_length,
5149 psa_algorithm_t alg,
5150 const uint8_t *salt, size_t salt_length,
5151 const uint8_t *label, size_t label_length,
5152 size_t capacity )
5153{
5154 psa_status_t status;
5155 size_t max_capacity;
5156
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005157 /* Set operation->alg even on failure so that abort knows what to do. */
5158 operation->alg = alg;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005159
5160#if defined(MBEDTLS_MD_C)
5161 if( PSA_ALG_IS_HKDF( alg ) )
5162 {
5163 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5164 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5165 if( hash_size == 0 )
5166 return( PSA_ERROR_NOT_SUPPORTED );
5167 max_capacity = 255 * hash_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005168 status = psa_key_derivation_hkdf_setup( &operation->ctx.hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005169 secret, secret_length,
5170 hash_alg,
5171 salt, salt_length,
5172 label, label_length );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005173 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00005174 /* TLS-1.2 PRF and TLS-1.2 PSK-to-MS are very similar, so share code. */
5175 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
5176 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005177 {
5178 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5179 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5180
5181 /* TLS-1.2 PRF supports only SHA-256 and SHA-384. */
5182 if( hash_alg != PSA_ALG_SHA_256 &&
5183 hash_alg != PSA_ALG_SHA_384 )
5184 {
5185 return( PSA_ERROR_NOT_SUPPORTED );
5186 }
5187
5188 max_capacity = 255 * hash_size;
Hanno Becker1aaedc02018-11-16 11:35:34 +00005189
5190 if( PSA_ALG_IS_TLS12_PRF( alg ) )
5191 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005192 status = psa_key_derivation_tls12_prf_setup( &operation->ctx.tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005193 secret, secret_length,
5194 hash_alg, salt, salt_length,
5195 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005196 }
5197 else
5198 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02005199 status = psa_key_derivation_tls12_psk_to_ms_setup(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005200 &operation->ctx.tls12_prf,
Hanno Becker1aaedc02018-11-16 11:35:34 +00005201 secret, secret_length,
5202 hash_alg, salt, salt_length,
5203 label, label_length );
5204 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005205 }
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005206 else
5207#endif
5208 {
5209 return( PSA_ERROR_NOT_SUPPORTED );
5210 }
5211
5212 if( status != PSA_SUCCESS )
5213 return( status );
5214
5215 if( capacity <= max_capacity )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005216 operation->capacity = capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005217 else if( capacity == PSA_KEY_DERIVATION_UNLIMITED_CAPACITY )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005218 operation->capacity = max_capacity;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005219 else
5220 return( PSA_ERROR_INVALID_ARGUMENT );
5221
5222 return( PSA_SUCCESS );
5223}
Janos Follath71a4c912019-06-11 09:14:47 +01005224#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005225
Janos Follath71a4c912019-06-11 09:14:47 +01005226#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005227psa_status_t psa_key_derivation( psa_key_derivation_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01005228 psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +02005229 psa_algorithm_t alg,
5230 const uint8_t *salt,
5231 size_t salt_length,
5232 const uint8_t *label,
5233 size_t label_length,
5234 size_t capacity )
5235{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005236 psa_key_slot_t *slot;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005237 psa_status_t status;
5238
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005239 if( operation->alg != 0 )
Gilles Peskineea0fb492018-07-12 17:17:20 +02005240 return( PSA_ERROR_BAD_STATE );
5241
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005242 /* Make sure that alg is a key derivation algorithm. This prevents
5243 * key selection algorithms, which psa_key_derivation_internal
5244 * accepts for the sake of key agreement. */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005245 if( ! PSA_ALG_IS_KEY_DERIVATION( alg ) )
5246 return( PSA_ERROR_INVALID_ARGUMENT );
5247
Gilles Peskine28f8f302019-07-24 13:30:31 +02005248 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005249 if( status != PSA_SUCCESS )
5250 return( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005251
Gilles Peskine8e338702019-07-30 20:06:31 +02005252 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005253 return( PSA_ERROR_INVALID_ARGUMENT );
5254
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005255 status = psa_key_derivation_internal( operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005256 slot->data.raw.data,
5257 slot->data.raw.bytes,
5258 alg,
5259 salt, salt_length,
5260 label, label_length,
5261 capacity );
5262 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005263 psa_key_derivation_abort( operation );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005264 return( status );
5265}
Janos Follath71a4c912019-06-11 09:14:47 +01005266#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005267
Gilles Peskine969c5d62019-01-16 15:53:06 +01005268static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005269 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005270 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005271{
Janos Follath5fe19732019-06-20 15:09:30 +01005272 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5273 * initialisers for this union leave some bytes unspecified.) */
5274 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5275
Gilles Peskine969c5d62019-01-16 15:53:06 +01005276 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005277#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005278 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5279 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5280 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005281 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005282 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005283 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5284 if( hash_size == 0 )
5285 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005286 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5287 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005288 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005289 {
5290 return( PSA_ERROR_NOT_SUPPORTED );
5291 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005292 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005293 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005294 }
5295#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005296 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005297 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005298}
5299
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005300psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005301 psa_algorithm_t alg )
5302{
5303 psa_status_t status;
5304
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005305 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005306 return( PSA_ERROR_BAD_STATE );
5307
Gilles Peskine6843c292019-01-18 16:44:49 +01005308 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5309 return( PSA_ERROR_INVALID_ARGUMENT );
5310 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005311 {
5312 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005313 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005314 }
5315 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5316 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005317 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005318 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005319 else
5320 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005321
5322 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005323 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005324 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005325}
5326
5327#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005328static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005329 psa_algorithm_t hash_alg,
5330 psa_key_derivation_step_t step,
5331 const uint8_t *data,
5332 size_t data_length )
5333{
5334 psa_status_t status;
5335 switch( step )
5336 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005337 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005338 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005339 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005340 status = psa_hmac_setup_internal( &hkdf->hmac,
5341 data, data_length,
5342 hash_alg );
5343 if( status != PSA_SUCCESS )
5344 return( status );
5345 hkdf->state = HKDF_STATE_STARTED;
5346 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005347 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005348 /* If no salt was provided, use an empty salt. */
5349 if( hkdf->state == HKDF_STATE_INIT )
5350 {
5351 status = psa_hmac_setup_internal( &hkdf->hmac,
5352 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005353 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005354 if( status != PSA_SUCCESS )
5355 return( status );
5356 hkdf->state = HKDF_STATE_STARTED;
5357 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005358 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005359 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005360 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5361 data, data_length );
5362 if( status != PSA_SUCCESS )
5363 return( status );
5364 status = psa_hmac_finish_internal( &hkdf->hmac,
5365 hkdf->prk,
5366 sizeof( hkdf->prk ) );
5367 if( status != PSA_SUCCESS )
5368 return( status );
5369 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5370 hkdf->block_number = 0;
5371 hkdf->state = HKDF_STATE_KEYED;
5372 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005373 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005374 if( hkdf->state == HKDF_STATE_OUTPUT )
5375 return( PSA_ERROR_BAD_STATE );
5376 if( hkdf->info_set )
5377 return( PSA_ERROR_BAD_STATE );
5378 hkdf->info_length = data_length;
5379 if( data_length != 0 )
5380 {
5381 hkdf->info = mbedtls_calloc( 1, data_length );
5382 if( hkdf->info == NULL )
5383 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5384 memcpy( hkdf->info, data, data_length );
5385 }
5386 hkdf->info_set = 1;
5387 return( PSA_SUCCESS );
5388 default:
5389 return( PSA_ERROR_INVALID_ARGUMENT );
5390 }
5391}
Janos Follathb03233e2019-06-11 15:30:30 +01005392
5393#if defined(PSA_PRE_1_0_KEY_DERIVATION)
5394static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5395 psa_algorithm_t hash_alg,
5396 psa_key_derivation_step_t step,
5397 const uint8_t *data,
5398 size_t data_length )
5399{
5400 (void) prf;
5401 (void) hash_alg;
5402 (void) step;
5403 (void) data;
5404 (void) data_length;
5405
5406 return( PSA_ERROR_INVALID_ARGUMENT );
5407}
Janos Follath6660f0e2019-06-17 08:44:03 +01005408
5409static psa_status_t psa_tls12_prf_psk_to_ms_input(
5410 psa_tls12_prf_key_derivation_t *prf,
5411 psa_algorithm_t hash_alg,
5412 psa_key_derivation_step_t step,
5413 const uint8_t *data,
5414 size_t data_length )
5415{
5416 (void) prf;
5417 (void) hash_alg;
5418 (void) step;
5419 (void) data;
5420 (void) data_length;
5421
5422 return( PSA_ERROR_INVALID_ARGUMENT );
5423}
Janos Follathb03233e2019-06-11 15:30:30 +01005424#else
Janos Follathf08e2652019-06-13 09:05:41 +01005425static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5426 const uint8_t *data,
5427 size_t data_length )
5428{
5429 if( prf->state != TLS12_PRF_STATE_INIT )
5430 return( PSA_ERROR_BAD_STATE );
5431
Janos Follathd6dce9f2019-07-04 09:11:38 +01005432 if( data_length != 0 )
5433 {
5434 prf->seed = mbedtls_calloc( 1, data_length );
5435 if( prf->seed == NULL )
5436 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005437
Janos Follathd6dce9f2019-07-04 09:11:38 +01005438 memcpy( prf->seed, data, data_length );
5439 prf->seed_length = data_length;
5440 }
Janos Follathf08e2652019-06-13 09:05:41 +01005441
5442 prf->state = TLS12_PRF_STATE_SEED_SET;
5443
5444 return( PSA_SUCCESS );
5445}
5446
Janos Follath81550542019-06-13 14:26:34 +01005447static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5448 psa_algorithm_t hash_alg,
5449 const uint8_t *data,
5450 size_t data_length )
5451{
5452 psa_status_t status;
5453 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5454 return( PSA_ERROR_BAD_STATE );
5455
5456 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5457 if( status != PSA_SUCCESS )
5458 return( status );
5459
5460 prf->state = TLS12_PRF_STATE_KEY_SET;
5461
5462 return( PSA_SUCCESS );
5463}
5464
Janos Follath6660f0e2019-06-17 08:44:03 +01005465static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5466 psa_tls12_prf_key_derivation_t *prf,
5467 psa_algorithm_t hash_alg,
5468 const uint8_t *data,
5469 size_t data_length )
5470{
5471 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005472 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5473 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005474
5475 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5476 return( PSA_ERROR_INVALID_ARGUMENT );
5477
5478 /* Quoting RFC 4279, Section 2:
5479 *
5480 * The premaster secret is formed as follows: if the PSK is N octets
5481 * long, concatenate a uint16 with the value N, N zero octets, a second
5482 * uint16 with the value N, and the PSK itself.
5483 */
5484
Janos Follath40e13932019-06-26 13:22:29 +01005485 *cur++ = ( data_length >> 8 ) & 0xff;
5486 *cur++ = ( data_length >> 0 ) & 0xff;
5487 memset( cur, 0, data_length );
5488 cur += data_length;
5489 *cur++ = pms[0];
5490 *cur++ = pms[1];
5491 memcpy( cur, data, data_length );
5492 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005493
Janos Follath40e13932019-06-26 13:22:29 +01005494 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005495
5496 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5497 return( status );
5498}
5499
Janos Follath63028dd2019-06-13 09:15:47 +01005500static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5501 const uint8_t *data,
5502 size_t data_length )
5503{
5504 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5505 return( PSA_ERROR_BAD_STATE );
5506
Janos Follathd6dce9f2019-07-04 09:11:38 +01005507 if( data_length != 0 )
5508 {
5509 prf->label = mbedtls_calloc( 1, data_length );
5510 if( prf->label == NULL )
5511 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005512
Janos Follathd6dce9f2019-07-04 09:11:38 +01005513 memcpy( prf->label, data, data_length );
5514 prf->label_length = data_length;
5515 }
Janos Follath63028dd2019-06-13 09:15:47 +01005516
5517 prf->state = TLS12_PRF_STATE_LABEL_SET;
5518
5519 return( PSA_SUCCESS );
5520}
5521
Janos Follathb03233e2019-06-11 15:30:30 +01005522static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5523 psa_algorithm_t hash_alg,
5524 psa_key_derivation_step_t step,
5525 const uint8_t *data,
5526 size_t data_length )
5527{
Janos Follathb03233e2019-06-11 15:30:30 +01005528 switch( step )
5529 {
Janos Follathf08e2652019-06-13 09:05:41 +01005530 case PSA_KEY_DERIVATION_INPUT_SEED:
5531 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005532 case PSA_KEY_DERIVATION_INPUT_SECRET:
5533 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005534 case PSA_KEY_DERIVATION_INPUT_LABEL:
5535 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005536 default:
5537 return( PSA_ERROR_INVALID_ARGUMENT );
5538 }
5539}
Janos Follath6660f0e2019-06-17 08:44:03 +01005540
5541static psa_status_t psa_tls12_prf_psk_to_ms_input(
5542 psa_tls12_prf_key_derivation_t *prf,
5543 psa_algorithm_t hash_alg,
5544 psa_key_derivation_step_t step,
5545 const uint8_t *data,
5546 size_t data_length )
5547{
5548 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005549 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005550 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5551 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005552 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005553
5554 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5555}
Janos Follathb03233e2019-06-11 15:30:30 +01005556#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005557#endif /* MBEDTLS_MD_C */
5558
Janos Follathb80a94e2019-06-12 15:54:46 +01005559static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005560 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005561 psa_key_derivation_step_t step,
5562 const uint8_t *data,
5563 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005564{
5565 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005566 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005567
5568#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005569 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005570 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005571 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005572 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005573 step, data, data_length );
5574 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005575 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005576#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005577#if defined(MBEDTLS_MD_C)
Janos Follath6660f0e2019-06-17 08:44:03 +01005578 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005579 {
Janos Follathb03233e2019-06-11 15:30:30 +01005580 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5581 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5582 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005583 }
5584 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5585 {
5586 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5587 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5588 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005589 }
5590 else
5591#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005592 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005593 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005594 return( PSA_ERROR_BAD_STATE );
5595 }
5596
5597 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005598 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005599 return( status );
5600}
5601
Janos Follath51f4a0f2019-06-14 11:35:55 +01005602psa_status_t psa_key_derivation_input_bytes(
5603 psa_key_derivation_operation_t *operation,
5604 psa_key_derivation_step_t step,
5605 const uint8_t *data,
5606 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005607{
Janos Follathc5621512019-06-14 11:27:57 +01005608 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5609 return( PSA_ERROR_INVALID_ARGUMENT );
5610
5611 return( psa_key_derivation_input_internal( operation, step,
5612 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005613}
5614
Janos Follath51f4a0f2019-06-14 11:35:55 +01005615psa_status_t psa_key_derivation_input_key(
5616 psa_key_derivation_operation_t *operation,
5617 psa_key_derivation_step_t step,
5618 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005619{
5620 psa_key_slot_t *slot;
5621 psa_status_t status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02005622 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005623 PSA_KEY_USAGE_DERIVE,
5624 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005625 if( status != PSA_SUCCESS )
5626 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02005627 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005628 return( PSA_ERROR_INVALID_ARGUMENT );
5629 /* Don't allow a key to be used as an input that is usually public.
5630 * This is debatable. It's ok from a cryptographic perspective to
5631 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005632 * the material should be dedicated to a particular input step,
5633 * otherwise this may allow the key to be used in an unintended way
5634 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005635 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005636 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005637 return( psa_key_derivation_input_internal( operation,
5638 step,
5639 slot->data.raw.data,
5640 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005641}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005642
5643
5644
5645/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005646/* Key agreement */
5647/****************************************************************/
5648
Gilles Peskinea05219c2018-11-16 16:02:56 +01005649#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005650static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5651 size_t peer_key_length,
5652 const mbedtls_ecp_keypair *our_key,
5653 uint8_t *shared_secret,
5654 size_t shared_secret_size,
5655 size_t *shared_secret_length )
5656{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005657 mbedtls_ecp_keypair *their_key = NULL;
5658 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005659 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005660 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005661
Jaeden Ameroccdce902019-01-10 11:42:27 +00005662 status = psa_import_ec_public_key(
5663 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5664 peer_key, peer_key_length,
5665 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005666 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005667 goto exit;
5668
Jaeden Amero97271b32019-01-10 19:38:51 +00005669 status = mbedtls_to_psa_error(
5670 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5671 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005672 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005673 status = mbedtls_to_psa_error(
5674 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5675 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005676 goto exit;
5677
Jaeden Amero97271b32019-01-10 19:38:51 +00005678 status = mbedtls_to_psa_error(
5679 mbedtls_ecdh_calc_secret( &ecdh,
5680 shared_secret_length,
5681 shared_secret, shared_secret_size,
5682 mbedtls_ctr_drbg_random,
5683 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005684
5685exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005686 mbedtls_ecdh_free( &ecdh );
Jaeden Ameroccdce902019-01-10 11:42:27 +00005687 mbedtls_ecp_keypair_free( their_key );
5688 mbedtls_free( their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005689 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005690}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005691#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005692
Gilles Peskine01d718c2018-09-18 12:01:02 +02005693#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5694
Gilles Peskine0216fe12019-04-11 21:23:21 +02005695static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5696 psa_key_slot_t *private_key,
5697 const uint8_t *peer_key,
5698 size_t peer_key_length,
5699 uint8_t *shared_secret,
5700 size_t shared_secret_size,
5701 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005702{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005703 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005704 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005705#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005706 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005707 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005708 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005709 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5710 private_key->data.ecp,
5711 shared_secret, shared_secret_size,
5712 shared_secret_length ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005713#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005714 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005715 (void) private_key;
5716 (void) peer_key;
5717 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005718 (void) shared_secret;
5719 (void) shared_secret_size;
5720 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005721 return( PSA_ERROR_NOT_SUPPORTED );
5722 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005723}
5724
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005725/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005726 * to potentially free embedded data structures and wipe confidential data.
5727 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005728static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005729 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005730 psa_key_slot_t *private_key,
5731 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005732 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005733{
5734 psa_status_t status;
5735 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5736 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005737 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005738
5739 /* Step 1: run the secret agreement algorithm to generate the shared
5740 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005741 status = psa_key_agreement_raw_internal( ka_alg,
5742 private_key,
5743 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005744 shared_secret,
5745 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005746 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005747 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005748 goto exit;
5749
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005750 /* Step 2: set up the key derivation to generate key material from
5751 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005752 status = psa_key_derivation_input_internal( operation, step,
5753 shared_secret,
5754 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005755
Gilles Peskine12313cd2018-06-20 00:20:32 +02005756exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005757 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005758 return( status );
5759}
5760
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005761psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005762 psa_key_derivation_step_t step,
5763 psa_key_handle_t private_key,
5764 const uint8_t *peer_key,
5765 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005766{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005767 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005768 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005769 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005770 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005771 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005772 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005773 if( status != PSA_SUCCESS )
5774 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005775 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005776 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005777 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005778 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005779 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005780 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005781}
5782
Gilles Peskinebe697d82019-05-16 18:00:41 +02005783psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5784 psa_key_handle_t private_key,
5785 const uint8_t *peer_key,
5786 size_t peer_key_length,
5787 uint8_t *output,
5788 size_t output_size,
5789 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005790{
5791 psa_key_slot_t *slot;
5792 psa_status_t status;
5793
5794 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5795 {
5796 status = PSA_ERROR_INVALID_ARGUMENT;
5797 goto exit;
5798 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005799 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005800 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005801 if( status != PSA_SUCCESS )
5802 goto exit;
5803
5804 status = psa_key_agreement_raw_internal( alg, slot,
5805 peer_key, peer_key_length,
5806 output, output_size,
5807 output_length );
5808
5809exit:
5810 if( status != PSA_SUCCESS )
5811 {
5812 /* If an error happens and is not handled properly, the output
5813 * may be used as a key to protect sensitive data. Arrange for such
5814 * a key to be random, which is likely to result in decryption or
5815 * verification errors. This is better than filling the buffer with
5816 * some constant data such as zeros, which would result in the data
5817 * being protected with a reproducible, easily knowable key.
5818 */
5819 psa_generate_random( output, output_size );
5820 *output_length = output_size;
5821 }
5822 return( status );
5823}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005824
5825
5826/****************************************************************/
5827/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005828/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005829
Gilles Peskine4c317f42018-07-12 01:24:09 +02005830psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005831 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005832{
Gilles Peskine4c317f42018-07-12 01:24:09 +02005833 int ret;
5834 GUARD_MODULE_INITIALIZED;
5835
Gilles Peskinef181eca2019-08-07 13:49:00 +02005836 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5837 {
5838 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5839 output,
5840 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5841 if( ret != 0 )
5842 return( mbedtls_to_psa_error( ret ) );
5843 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5844 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5845 }
5846
Gilles Peskinee59236f2018-01-27 23:32:46 +01005847 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5848 return( mbedtls_to_psa_error( ret ) );
5849}
5850
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005851#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5852#include "mbedtls/entropy_poll.h"
5853
Gilles Peskine7228da22019-07-15 11:06:15 +02005854psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005855 size_t seed_size )
5856{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005857 if( global_data.initialized )
5858 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005859
5860 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5861 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5862 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5863 return( PSA_ERROR_INVALID_ARGUMENT );
5864
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005865 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005866}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005867#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005868
Gilles Peskinee56e8782019-04-26 17:34:02 +02005869#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5870static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5871 size_t domain_parameters_size,
5872 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005873{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005874 size_t i;
5875 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005876
Gilles Peskinee56e8782019-04-26 17:34:02 +02005877 if( domain_parameters_size == 0 )
5878 {
5879 *exponent = 65537;
5880 return( PSA_SUCCESS );
5881 }
5882
5883 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5884 * support values that fit in a 32-bit integer, which is larger than
5885 * int on just about every platform anyway. */
5886 if( domain_parameters_size > sizeof( acc ) )
5887 return( PSA_ERROR_NOT_SUPPORTED );
5888 for( i = 0; i < domain_parameters_size; i++ )
5889 acc = ( acc << 8 ) | domain_parameters[i];
5890 if( acc > INT_MAX )
5891 return( PSA_ERROR_NOT_SUPPORTED );
5892 *exponent = acc;
5893 return( PSA_SUCCESS );
5894}
5895#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5896
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005897static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005898 psa_key_slot_t *slot, size_t bits,
5899 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005900{
Gilles Peskine8e338702019-07-30 20:06:31 +02005901 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005902
Gilles Peskinee56e8782019-04-26 17:34:02 +02005903 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005904 return( PSA_ERROR_INVALID_ARGUMENT );
5905
Gilles Peskinee59236f2018-01-27 23:32:46 +01005906 if( key_type_is_raw_bytes( type ) )
5907 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005908 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005909 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
5910 if( status != PSA_SUCCESS )
5911 return( status );
5912 status = psa_generate_random( slot->data.raw.data,
5913 slot->data.raw.bytes );
5914 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005915 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005916#if defined(MBEDTLS_DES_C)
5917 if( type == PSA_KEY_TYPE_DES )
5918 psa_des_set_key_parity( slot->data.raw.data,
5919 slot->data.raw.bytes );
5920#endif /* MBEDTLS_DES_C */
5921 }
5922 else
5923
5924#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005925 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005926 {
5927 mbedtls_rsa_context *rsa;
5928 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005929 int exponent;
5930 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005931 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5932 return( PSA_ERROR_NOT_SUPPORTED );
5933 /* Accept only byte-aligned keys, for the same reasons as
5934 * in psa_import_rsa_key(). */
5935 if( bits % 8 != 0 )
5936 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005937 status = psa_read_rsa_exponent( domain_parameters,
5938 domain_parameters_size,
5939 &exponent );
5940 if( status != PSA_SUCCESS )
5941 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005942 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5943 if( rsa == NULL )
5944 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5945 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5946 ret = mbedtls_rsa_gen_key( rsa,
5947 mbedtls_ctr_drbg_random,
5948 &global_data.ctr_drbg,
5949 (unsigned int) bits,
5950 exponent );
5951 if( ret != 0 )
5952 {
5953 mbedtls_rsa_free( rsa );
5954 mbedtls_free( rsa );
5955 return( mbedtls_to_psa_error( ret ) );
5956 }
5957 slot->data.rsa = rsa;
5958 }
5959 else
5960#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5961
5962#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005963 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005964 {
5965 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5966 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5967 const mbedtls_ecp_curve_info *curve_info =
5968 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5969 mbedtls_ecp_keypair *ecp;
5970 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005971 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005972 return( PSA_ERROR_NOT_SUPPORTED );
5973 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5974 return( PSA_ERROR_NOT_SUPPORTED );
5975 if( curve_info->bit_size != bits )
5976 return( PSA_ERROR_INVALID_ARGUMENT );
5977 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5978 if( ecp == NULL )
5979 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5980 mbedtls_ecp_keypair_init( ecp );
5981 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5982 mbedtls_ctr_drbg_random,
5983 &global_data.ctr_drbg );
5984 if( ret != 0 )
5985 {
5986 mbedtls_ecp_keypair_free( ecp );
5987 mbedtls_free( ecp );
5988 return( mbedtls_to_psa_error( ret ) );
5989 }
5990 slot->data.ecp = ecp;
5991 }
5992 else
5993#endif /* MBEDTLS_ECP_C */
5994
5995 return( PSA_ERROR_NOT_SUPPORTED );
5996
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005997 return( PSA_SUCCESS );
5998}
Darryl Green0c6575a2018-11-07 16:05:30 +00005999
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006000psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006001 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006002{
6003 psa_status_t status;
6004 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006005 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006006
Gilles Peskinedf179142019-07-15 22:02:14 +02006007 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6008 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006009 if( status != PSA_SUCCESS )
6010 goto exit;
6011
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006012#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6013 if( driver != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00006014 {
Gilles Peskine11792082019-08-06 18:36:36 +02006015 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
6016 size_t pubkey_length = 0; /* We don't support this feature yet */
6017 if( drv->key_management == NULL ||
6018 drv->key_management->p_generate == NULL )
6019 {
6020 status = PSA_ERROR_NOT_SUPPORTED;
6021 goto exit;
6022 }
6023 status = drv->key_management->p_generate(
6024 psa_get_se_driver_context( driver ),
6025 slot->data.se.slot_number, attributes,
6026 NULL, 0, &pubkey_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00006027 }
Gilles Peskine11792082019-08-06 18:36:36 +02006028 else
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006029#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006030 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006031 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02006032 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006033 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006034 }
Gilles Peskine11792082019-08-06 18:36:36 +02006035
6036exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006037 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006038 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006039 if( status != PSA_SUCCESS )
6040 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006041 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006042 *handle = 0;
6043 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006044 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006045}
6046
6047
Gilles Peskinee59236f2018-01-27 23:32:46 +01006048
6049/****************************************************************/
6050/* Module setup */
6051/****************************************************************/
6052
Gilles Peskine5e769522018-11-20 21:59:56 +01006053psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6054 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6055 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6056{
6057 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6058 return( PSA_ERROR_BAD_STATE );
6059 global_data.entropy_init = entropy_init;
6060 global_data.entropy_free = entropy_free;
6061 return( PSA_SUCCESS );
6062}
6063
Gilles Peskinee59236f2018-01-27 23:32:46 +01006064void mbedtls_psa_crypto_free( void )
6065{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006066 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006067 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6068 {
6069 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006070 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006071 }
6072 /* Wipe all remaining data, including configuration.
6073 * In particular, this sets all state indicator to the value
6074 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006075 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006076#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006077 /* Unregister all secure element drivers, so that we restart from
6078 * a pristine state. */
6079 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006080#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006081}
6082
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006083#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6084/** Recover a transaction that was interrupted by a power failure.
6085 *
6086 * This function is called during initialization, before psa_crypto_init()
6087 * returns. If this function returns a failure status, the initialization
6088 * fails.
6089 */
6090static psa_status_t psa_crypto_recover_transaction(
6091 const psa_crypto_transaction_t *transaction )
6092{
6093 switch( transaction->unknown.type )
6094 {
6095 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6096 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006097 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006098 * is implemented.
6099 * https://github.com/ARMmbed/mbed-crypto/issues/218
6100 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006101 default:
6102 /* We found an unsupported transaction in the storage.
6103 * We don't know what state the storage is in. Give up. */
6104 return( PSA_ERROR_STORAGE_FAILURE );
6105 }
6106}
6107#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6108
Gilles Peskinee59236f2018-01-27 23:32:46 +01006109psa_status_t psa_crypto_init( void )
6110{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006111 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006112 const unsigned char drbg_seed[] = "PSA";
6113
Gilles Peskinec6b69072018-11-20 21:42:52 +01006114 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006115 if( global_data.initialized != 0 )
6116 return( PSA_SUCCESS );
6117
Gilles Peskine5e769522018-11-20 21:59:56 +01006118 /* Set default configuration if
6119 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6120 if( global_data.entropy_init == NULL )
6121 global_data.entropy_init = mbedtls_entropy_init;
6122 if( global_data.entropy_free == NULL )
6123 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006124
Gilles Peskinec6b69072018-11-20 21:42:52 +01006125 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006126 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006127#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6128 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6129 /* The PSA entropy injection feature depends on using NV seed as an entropy
6130 * source. Add NV seed as an entropy source for PSA entropy injection. */
6131 mbedtls_entropy_add_source( &global_data.entropy,
6132 mbedtls_nv_seed_poll, NULL,
6133 MBEDTLS_ENTROPY_BLOCK_SIZE,
6134 MBEDTLS_ENTROPY_SOURCE_STRONG );
6135#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006136 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006137 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006138 status = mbedtls_to_psa_error(
6139 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6140 mbedtls_entropy_func,
6141 &global_data.entropy,
6142 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6143 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006144 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006145 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006146
Gilles Peskine66fb1262018-12-10 16:29:04 +01006147 status = psa_initialize_key_slots( );
6148 if( status != PSA_SUCCESS )
6149 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006150
Gilles Peskine4b734222019-07-24 15:56:31 +02006151#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006152 status = psa_crypto_load_transaction( );
6153 if( status == PSA_SUCCESS )
6154 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006155 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6156 if( status != PSA_SUCCESS )
6157 goto exit;
6158 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006159 }
6160 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6161 {
6162 /* There's no transaction to complete. It's all good. */
6163 status = PSA_SUCCESS;
6164 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006165#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006166
Gilles Peskinec6b69072018-11-20 21:42:52 +01006167 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006168 global_data.initialized = 1;
6169
6170exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006171 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006172 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006173 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006174}
6175
6176#endif /* MBEDTLS_PSA_CRYPTO_C */