blob: 856d8622d460c881085a23da4d44b73c4fe19870 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
4/* Copyright (C) 2018, ARM Limited, All Rights Reserved
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS (https://tls.mbed.org)
20 */
21
22#if !defined(MBEDTLS_CONFIG_FILE)
23#include "mbedtls/config.h"
24#else
25#include MBEDTLS_CONFIG_FILE
26#endif
27
28#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030029
itayzafrir7723ab12019-02-14 10:28:02 +020030#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031#include "psa/crypto.h"
32
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020036#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010038#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010039/* Include internal declarations that are useful for implementing persistently
40 * stored keys. */
41#include "psa_crypto_storage.h"
42
Gilles Peskineb46bef22019-07-30 21:32:04 +020043#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include <stdlib.h>
45#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010046#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020047#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#define mbedtls_calloc calloc
49#define mbedtls_free free
50#endif
51
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020053#include "mbedtls/asn1.h"
Jaeden Amero6b196002019-01-10 10:23:21 +000054#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020055#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/blowfish.h"
57#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020058#include "mbedtls/chacha20.h"
59#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/cipher.h"
61#include "mbedtls/ccm.h"
62#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020065#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010067#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/error.h"
69#include "mbedtls/gcm.h"
70#include "mbedtls/md2.h"
71#include "mbedtls/md4.h"
72#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010073#include "mbedtls/md.h"
74#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010075#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010077#include "mbedtls/platform_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010078#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010079#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010080#include "mbedtls/sha1.h"
81#include "mbedtls/sha256.h"
82#include "mbedtls/sha512.h"
83#include "mbedtls/xtea.h"
84
Gilles Peskine996deb12018-08-01 15:45:45 +020085#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
86
Gilles Peskine9ef733f2018-02-07 21:05:37 +010087/* constant-time buffer comparison */
88static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
89{
90 size_t i;
91 unsigned char diff = 0;
92
93 for( i = 0; i < n; i++ )
94 diff |= a[i] ^ b[i];
95
96 return( diff );
97}
98
99
100
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100101/****************************************************************/
102/* Global data, support functions and library management */
103/****************************************************************/
104
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105static int key_type_is_raw_bytes( psa_key_type_t type )
106{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200107 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200108}
109
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100110/* Values for psa_global_data_t::rng_state */
111#define RNG_NOT_INITIALIZED 0
112#define RNG_INITIALIZED 1
113#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100114
Gilles Peskine2d277862018-06-18 15:41:12 +0200115typedef struct
116{
Gilles Peskine5e769522018-11-20 21:59:56 +0100117 void (* entropy_init )( mbedtls_entropy_context *ctx );
118 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100119 mbedtls_entropy_context entropy;
120 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100121 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100122 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123} psa_global_data_t;
124
125static psa_global_data_t global_data;
126
itayzafrir0adf0fc2018-09-06 16:24:41 +0300127#define GUARD_MODULE_INITIALIZED \
128 if( global_data.initialized == 0 ) \
129 return( PSA_ERROR_BAD_STATE );
130
Gilles Peskinee59236f2018-01-27 23:32:46 +0100131static psa_status_t mbedtls_to_psa_error( int ret )
132{
Gilles Peskinea5905292018-02-07 20:59:33 +0100133 /* If there's both a high-level code and low-level code, dispatch on
134 * the high-level code. */
135 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100136 {
137 case 0:
138 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100139
140 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
141 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
142 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
143 return( PSA_ERROR_NOT_SUPPORTED );
144 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
147 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
148 return( PSA_ERROR_HARDWARE_FAILURE );
149
Gilles Peskine9a944802018-06-21 09:35:35 +0200150 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
151 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
152 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
153 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
154 case MBEDTLS_ERR_ASN1_INVALID_DATA:
155 return( PSA_ERROR_INVALID_ARGUMENT );
156 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
157 return( PSA_ERROR_INSUFFICIENT_MEMORY );
158 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
159 return( PSA_ERROR_BUFFER_TOO_SMALL );
160
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000162 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000163#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
Gilles Peskinea5905292018-02-07 20:59:33 +0100164 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
Jaeden Amero93e21112019-02-20 13:57:28 +0000165#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
169 return( PSA_ERROR_HARDWARE_FAILURE );
170
Jaeden Amero93e21112019-02-20 13:57:28 +0000171#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000172 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
Jaeden Amero93e21112019-02-20 13:57:28 +0000175#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
177 return( PSA_ERROR_NOT_SUPPORTED );
178 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
179 return( PSA_ERROR_HARDWARE_FAILURE );
180
181 case MBEDTLS_ERR_CCM_BAD_INPUT:
182 return( PSA_ERROR_INVALID_ARGUMENT );
183 case MBEDTLS_ERR_CCM_AUTH_FAILED:
184 return( PSA_ERROR_INVALID_SIGNATURE );
185 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
186 return( PSA_ERROR_HARDWARE_FAILURE );
187
Gilles Peskine26869f22019-05-06 15:25:00 +0200188 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
189 return( PSA_ERROR_INVALID_ARGUMENT );
190
191 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
192 return( PSA_ERROR_BAD_STATE );
193 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
194 return( PSA_ERROR_INVALID_SIGNATURE );
195
Gilles Peskinea5905292018-02-07 20:59:33 +0100196 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
197 return( PSA_ERROR_NOT_SUPPORTED );
198 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
199 return( PSA_ERROR_INVALID_ARGUMENT );
200 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
201 return( PSA_ERROR_INSUFFICIENT_MEMORY );
202 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
203 return( PSA_ERROR_INVALID_PADDING );
204 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
205 return( PSA_ERROR_BAD_STATE );
206 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
207 return( PSA_ERROR_INVALID_SIGNATURE );
208 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200209 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100210 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
214 return( PSA_ERROR_HARDWARE_FAILURE );
215
216 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
219 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
220 return( PSA_ERROR_NOT_SUPPORTED );
221 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
222 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
223
224 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
225 return( PSA_ERROR_NOT_SUPPORTED );
226 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
227 return( PSA_ERROR_HARDWARE_FAILURE );
228
Gilles Peskinee59236f2018-01-27 23:32:46 +0100229 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
230 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
231 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
232 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100233
234 case MBEDTLS_ERR_GCM_AUTH_FAILED:
235 return( PSA_ERROR_INVALID_SIGNATURE );
236 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200237 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100238 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
239 return( PSA_ERROR_HARDWARE_FAILURE );
240
241 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
242 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
243 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
244 return( PSA_ERROR_HARDWARE_FAILURE );
245
246 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
247 return( PSA_ERROR_NOT_SUPPORTED );
248 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
249 return( PSA_ERROR_INVALID_ARGUMENT );
250 case MBEDTLS_ERR_MD_ALLOC_FAILED:
251 return( PSA_ERROR_INSUFFICIENT_MEMORY );
252 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
253 return( PSA_ERROR_STORAGE_FAILURE );
254 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
255 return( PSA_ERROR_HARDWARE_FAILURE );
256
Gilles Peskinef76aa772018-10-29 19:24:33 +0100257 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
258 return( PSA_ERROR_STORAGE_FAILURE );
259 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
260 return( PSA_ERROR_INVALID_ARGUMENT );
261 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
264 return( PSA_ERROR_BUFFER_TOO_SMALL );
265 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
266 return( PSA_ERROR_INVALID_ARGUMENT );
267 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
268 return( PSA_ERROR_INVALID_ARGUMENT );
269 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
270 return( PSA_ERROR_INVALID_ARGUMENT );
271 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100274 case MBEDTLS_ERR_PK_ALLOC_FAILED:
275 return( PSA_ERROR_INSUFFICIENT_MEMORY );
276 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
277 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100281 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
282 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
283 return( PSA_ERROR_INVALID_ARGUMENT );
284 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
285 return( PSA_ERROR_NOT_SUPPORTED );
286 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
287 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
288 return( PSA_ERROR_NOT_PERMITTED );
289 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
290 return( PSA_ERROR_INVALID_ARGUMENT );
291 case MBEDTLS_ERR_PK_INVALID_ALG:
292 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
293 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
294 return( PSA_ERROR_NOT_SUPPORTED );
295 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
296 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100297 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299
Gilles Peskineff2d2002019-05-06 15:26:23 +0200300 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
301 return( PSA_ERROR_HARDWARE_FAILURE );
302 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
303 return( PSA_ERROR_NOT_SUPPORTED );
304
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
306 return( PSA_ERROR_HARDWARE_FAILURE );
307
308 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
309 return( PSA_ERROR_INVALID_ARGUMENT );
310 case MBEDTLS_ERR_RSA_INVALID_PADDING:
311 return( PSA_ERROR_INVALID_PADDING );
312 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
313 return( PSA_ERROR_HARDWARE_FAILURE );
314 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
315 return( PSA_ERROR_INVALID_ARGUMENT );
316 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
317 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200318 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100319 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
320 return( PSA_ERROR_INVALID_SIGNATURE );
321 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
322 return( PSA_ERROR_BUFFER_TOO_SMALL );
323 case MBEDTLS_ERR_RSA_RNG_FAILED:
324 return( PSA_ERROR_INSUFFICIENT_MEMORY );
325 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
326 return( PSA_ERROR_NOT_SUPPORTED );
327 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
328 return( PSA_ERROR_HARDWARE_FAILURE );
329
330 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
331 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
332 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
333 return( PSA_ERROR_HARDWARE_FAILURE );
334
335 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
336 return( PSA_ERROR_INVALID_ARGUMENT );
337 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
338 return( PSA_ERROR_HARDWARE_FAILURE );
339
itayzafrir5c753392018-05-08 11:18:38 +0300340 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300341 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300342 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300343 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
344 return( PSA_ERROR_BUFFER_TOO_SMALL );
345 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
346 return( PSA_ERROR_NOT_SUPPORTED );
347 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
348 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
349 return( PSA_ERROR_INVALID_SIGNATURE );
350 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
351 return( PSA_ERROR_INSUFFICIENT_MEMORY );
352 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
353 return( PSA_ERROR_HARDWARE_FAILURE );
itayzafrir5c753392018-05-08 11:18:38 +0300354
Gilles Peskinee59236f2018-01-27 23:32:46 +0100355 default:
David Saadab4ecc272019-02-14 13:48:10 +0200356 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100357 }
358}
359
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200360
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200361
362
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100363/****************************************************************/
364/* Key management */
365/****************************************************************/
366
Gilles Peskine73167e12019-07-12 23:44:37 +0200367#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
368static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
369{
Gilles Peskine8e338702019-07-30 20:06:31 +0200370 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200371}
372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
373
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100374#if defined(MBEDTLS_ECP_C)
Gilles Peskine34ef7f52018-06-18 20:47:51 +0200375static psa_ecc_curve_t mbedtls_ecc_group_to_psa( mbedtls_ecp_group_id grpid )
376{
377 switch( grpid )
378 {
379 case MBEDTLS_ECP_DP_SECP192R1:
380 return( PSA_ECC_CURVE_SECP192R1 );
381 case MBEDTLS_ECP_DP_SECP224R1:
382 return( PSA_ECC_CURVE_SECP224R1 );
383 case MBEDTLS_ECP_DP_SECP256R1:
384 return( PSA_ECC_CURVE_SECP256R1 );
385 case MBEDTLS_ECP_DP_SECP384R1:
386 return( PSA_ECC_CURVE_SECP384R1 );
387 case MBEDTLS_ECP_DP_SECP521R1:
388 return( PSA_ECC_CURVE_SECP521R1 );
389 case MBEDTLS_ECP_DP_BP256R1:
390 return( PSA_ECC_CURVE_BRAINPOOL_P256R1 );
391 case MBEDTLS_ECP_DP_BP384R1:
392 return( PSA_ECC_CURVE_BRAINPOOL_P384R1 );
393 case MBEDTLS_ECP_DP_BP512R1:
394 return( PSA_ECC_CURVE_BRAINPOOL_P512R1 );
395 case MBEDTLS_ECP_DP_CURVE25519:
396 return( PSA_ECC_CURVE_CURVE25519 );
397 case MBEDTLS_ECP_DP_SECP192K1:
398 return( PSA_ECC_CURVE_SECP192K1 );
399 case MBEDTLS_ECP_DP_SECP224K1:
400 return( PSA_ECC_CURVE_SECP224K1 );
401 case MBEDTLS_ECP_DP_SECP256K1:
402 return( PSA_ECC_CURVE_SECP256K1 );
403 case MBEDTLS_ECP_DP_CURVE448:
404 return( PSA_ECC_CURVE_CURVE448 );
405 default:
406 return( 0 );
407 }
408}
409
Gilles Peskine12313cd2018-06-20 00:20:32 +0200410static mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_curve_t curve )
411{
412 switch( curve )
413 {
414 case PSA_ECC_CURVE_SECP192R1:
415 return( MBEDTLS_ECP_DP_SECP192R1 );
416 case PSA_ECC_CURVE_SECP224R1:
417 return( MBEDTLS_ECP_DP_SECP224R1 );
418 case PSA_ECC_CURVE_SECP256R1:
419 return( MBEDTLS_ECP_DP_SECP256R1 );
420 case PSA_ECC_CURVE_SECP384R1:
421 return( MBEDTLS_ECP_DP_SECP384R1 );
422 case PSA_ECC_CURVE_SECP521R1:
423 return( MBEDTLS_ECP_DP_SECP521R1 );
424 case PSA_ECC_CURVE_BRAINPOOL_P256R1:
425 return( MBEDTLS_ECP_DP_BP256R1 );
426 case PSA_ECC_CURVE_BRAINPOOL_P384R1:
427 return( MBEDTLS_ECP_DP_BP384R1 );
428 case PSA_ECC_CURVE_BRAINPOOL_P512R1:
429 return( MBEDTLS_ECP_DP_BP512R1 );
430 case PSA_ECC_CURVE_CURVE25519:
431 return( MBEDTLS_ECP_DP_CURVE25519 );
432 case PSA_ECC_CURVE_SECP192K1:
433 return( MBEDTLS_ECP_DP_SECP192K1 );
434 case PSA_ECC_CURVE_SECP224K1:
435 return( MBEDTLS_ECP_DP_SECP224K1 );
436 case PSA_ECC_CURVE_SECP256K1:
437 return( MBEDTLS_ECP_DP_SECP256K1 );
438 case PSA_ECC_CURVE_CURVE448:
439 return( MBEDTLS_ECP_DP_CURVE448 );
440 default:
441 return( MBEDTLS_ECP_DP_NONE );
442 }
443}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100444#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200445
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446static psa_status_t prepare_raw_data_slot( psa_key_type_t type,
447 size_t bits,
448 struct raw_data *raw )
449{
450 /* Check that the bit size is acceptable for the key type */
451 switch( type )
452 {
453 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200454 if( bits == 0 )
455 {
456 raw->bytes = 0;
457 raw->data = NULL;
458 return( PSA_SUCCESS );
459 }
460 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200461#if defined(MBEDTLS_MD_C)
462 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200463#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200464 case PSA_KEY_TYPE_DERIVE:
465 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200466#if defined(MBEDTLS_AES_C)
467 case PSA_KEY_TYPE_AES:
468 if( bits != 128 && bits != 192 && bits != 256 )
469 return( PSA_ERROR_INVALID_ARGUMENT );
470 break;
471#endif
472#if defined(MBEDTLS_CAMELLIA_C)
473 case PSA_KEY_TYPE_CAMELLIA:
474 if( bits != 128 && bits != 192 && bits != 256 )
475 return( PSA_ERROR_INVALID_ARGUMENT );
476 break;
477#endif
478#if defined(MBEDTLS_DES_C)
479 case PSA_KEY_TYPE_DES:
480 if( bits != 64 && bits != 128 && bits != 192 )
481 return( PSA_ERROR_INVALID_ARGUMENT );
482 break;
483#endif
484#if defined(MBEDTLS_ARC4_C)
485 case PSA_KEY_TYPE_ARC4:
486 if( bits < 8 || bits > 2048 )
487 return( PSA_ERROR_INVALID_ARGUMENT );
488 break;
489#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200490#if defined(MBEDTLS_CHACHA20_C)
491 case PSA_KEY_TYPE_CHACHA20:
492 if( bits != 256 )
493 return( PSA_ERROR_INVALID_ARGUMENT );
494 break;
495#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200496 default:
497 return( PSA_ERROR_NOT_SUPPORTED );
498 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200499 if( bits % 8 != 0 )
500 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200501
502 /* Allocate memory for the key */
503 raw->bytes = PSA_BITS_TO_BYTES( bits );
504 raw->data = mbedtls_calloc( 1, raw->bytes );
505 if( raw->data == NULL )
506 {
507 raw->bytes = 0;
508 return( PSA_ERROR_INSUFFICIENT_MEMORY );
509 }
510 return( PSA_SUCCESS );
511}
512
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200513#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100514/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
515 * that are not a multiple of 8) well. For example, there is only
516 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
517 * way to return the exact bit size of a key.
518 * To keep things simple, reject non-byte-aligned key sizes. */
519static psa_status_t psa_check_rsa_key_byte_aligned(
520 const mbedtls_rsa_context *rsa )
521{
522 mbedtls_mpi n;
523 psa_status_t status;
524 mbedtls_mpi_init( &n );
525 status = mbedtls_to_psa_error(
526 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
527 if( status == PSA_SUCCESS )
528 {
529 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
530 status = PSA_ERROR_NOT_SUPPORTED;
531 }
532 mbedtls_mpi_free( &n );
533 return( status );
534}
535
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000536static psa_status_t psa_import_rsa_key( psa_key_type_t type,
537 const uint8_t *data,
538 size_t data_length,
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200539 mbedtls_rsa_context **p_rsa )
540{
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000541 psa_status_t status;
542 mbedtls_pk_context pk;
543 mbedtls_rsa_context *rsa;
544 size_t bits;
545
546 mbedtls_pk_init( &pk );
547
548 /* Parse the data. */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200549 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000550 status = mbedtls_to_psa_error(
551 mbedtls_pk_parse_key( &pk, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200552 else
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000553 status = mbedtls_to_psa_error(
554 mbedtls_pk_parse_public_key( &pk, data, data_length ) );
555 if( status != PSA_SUCCESS )
556 goto exit;
557
558 /* We have something that the pkparse module recognizes. If it is a
559 * valid RSA key, store it. */
560 if( mbedtls_pk_get_type( &pk ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200561 {
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000562 status = PSA_ERROR_INVALID_ARGUMENT;
563 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200564 }
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000565
566 rsa = mbedtls_pk_rsa( pk );
567 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
568 * supports non-byte-aligned key sizes, but not well. For example,
569 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
570 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
571 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
572 {
573 status = PSA_ERROR_NOT_SUPPORTED;
574 goto exit;
575 }
576 status = psa_check_rsa_key_byte_aligned( rsa );
577
578exit:
579 /* Free the content of the pk object only on error. */
580 if( status != PSA_SUCCESS )
581 {
582 mbedtls_pk_free( &pk );
583 return( status );
584 }
585
586 /* On success, store the content of the object in the RSA context. */
587 *p_rsa = rsa;
588
589 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200590}
591#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
592
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000593#if defined(MBEDTLS_ECP_C)
594
595/* Import a public key given as the uncompressed representation defined by SEC1
596 * 2.3.3 as the content of an ECPoint. */
597static psa_status_t psa_import_ec_public_key( psa_ecc_curve_t curve,
598 const uint8_t *data,
599 size_t data_length,
600 mbedtls_ecp_keypair **p_ecp )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200601{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200602 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000603 mbedtls_ecp_keypair *ecp = NULL;
604 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
605
606 *p_ecp = NULL;
607 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
608 if( ecp == NULL )
609 return( PSA_ERROR_INSUFFICIENT_MEMORY );
610 mbedtls_ecp_keypair_init( ecp );
611
612 /* Load the group. */
613 status = mbedtls_to_psa_error(
614 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
615 if( status != PSA_SUCCESS )
616 goto exit;
617 /* Load the public value. */
618 status = mbedtls_to_psa_error(
619 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
620 data, data_length ) );
621 if( status != PSA_SUCCESS )
622 goto exit;
623
624 /* Check that the point is on the curve. */
625 status = mbedtls_to_psa_error(
626 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
627 if( status != PSA_SUCCESS )
628 goto exit;
629
630 *p_ecp = ecp;
631 return( PSA_SUCCESS );
632
633exit:
634 if( ecp != NULL )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200635 {
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000636 mbedtls_ecp_keypair_free( ecp );
637 mbedtls_free( ecp );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200638 }
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000639 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200640}
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000641#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200642
Gilles Peskinef76aa772018-10-29 19:24:33 +0100643#if defined(MBEDTLS_ECP_C)
644/* Import a private key given as a byte string which is the private value
645 * in big-endian order. */
646static psa_status_t psa_import_ec_private_key( psa_ecc_curve_t curve,
647 const uint8_t *data,
648 size_t data_length,
649 mbedtls_ecp_keypair **p_ecp )
650{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100652 mbedtls_ecp_keypair *ecp = NULL;
653 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
654
Gilles Peskinec9d910b2019-05-13 14:21:57 +0200655 if( PSA_BITS_TO_BYTES( PSA_ECC_CURVE_BITS( curve ) ) != data_length )
656 return( PSA_ERROR_INVALID_ARGUMENT );
657
Gilles Peskinef76aa772018-10-29 19:24:33 +0100658 *p_ecp = NULL;
659 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
660 if( ecp == NULL )
661 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Jaeden Amero83d29392019-01-10 20:17:42 +0000662 mbedtls_ecp_keypair_init( ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100663
664 /* Load the group. */
665 status = mbedtls_to_psa_error(
666 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
667 if( status != PSA_SUCCESS )
668 goto exit;
669 /* Load the secret value. */
670 status = mbedtls_to_psa_error(
671 mbedtls_mpi_read_binary( &ecp->d, data, data_length ) );
672 if( status != PSA_SUCCESS )
673 goto exit;
674 /* Validate the private key. */
675 status = mbedtls_to_psa_error(
676 mbedtls_ecp_check_privkey( &ecp->grp, &ecp->d ) );
677 if( status != PSA_SUCCESS )
678 goto exit;
679 /* Calculate the public key from the private key. */
680 status = mbedtls_to_psa_error(
681 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
682 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
683 if( status != PSA_SUCCESS )
684 goto exit;
685
686 *p_ecp = ecp;
687 return( PSA_SUCCESS );
688
689exit:
690 if( ecp != NULL )
691 {
692 mbedtls_ecp_keypair_free( ecp );
693 mbedtls_free( ecp );
694 }
695 return( status );
696}
697#endif /* defined(MBEDTLS_ECP_C) */
698
Gilles Peskineb46bef22019-07-30 21:32:04 +0200699
700/** Return the size of the key in the given slot, in bits.
701 *
702 * \param[in] slot A key slot.
703 *
704 * \return The key size in bits, read from the metadata in the slot.
705 */
706static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
707{
708 return( slot->attr.bits );
709}
710
711/** Calculate the size of the key in the given slot, in bits.
712 *
713 * \param[in] slot A key slot containing a transparent key.
714 *
715 * \return The key size in bits, calculated from the key data.
716 */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200717static psa_key_bits_t psa_calculate_key_bits( const psa_key_slot_t *slot )
Gilles Peskineb46bef22019-07-30 21:32:04 +0200718{
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200719 size_t bits = 0; /* return 0 on an empty slot */
720
Gilles Peskineb46bef22019-07-30 21:32:04 +0200721 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200722 bits = PSA_BYTES_TO_BITS( slot->data.raw.bytes );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200723#if defined(MBEDTLS_RSA_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200724 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
725 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200726#endif /* defined(MBEDTLS_RSA_C) */
727#if defined(MBEDTLS_ECP_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200728 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
729 bits = slot->data.ecp->grp.pbits;
Gilles Peskineb46bef22019-07-30 21:32:04 +0200730#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200731
732 /* We know that the size fits in psa_key_bits_t thanks to checks
733 * when the key was created. */
734 return( (psa_key_bits_t) bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200735}
736
Gilles Peskine8e338702019-07-30 20:06:31 +0200737/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100738 * previously. This function assumes that the slot does not contain
739 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100740psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
741 const uint8_t *data,
742 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100743{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200744 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100745
Gilles Peskine8e338702019-07-30 20:06:31 +0200746 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100747 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200748 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200749 /* Ensure that the bytes-to-bit conversion didn't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100750 if( data_length > SIZE_MAX / 8 )
751 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200752 /* Enforce a size limit, and in particular ensure that the bit
753 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200754 if( bit_size > PSA_MAX_KEY_BITS )
755 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine8e338702019-07-30 20:06:31 +0200756 status = prepare_raw_data_slot( slot->attr.type, bit_size,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200757 &slot->data.raw );
758 if( status != PSA_SUCCESS )
759 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200760 if( data_length != 0 )
761 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100762 }
763 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100764#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200765 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100766 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200767 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100768 data, data_length,
769 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100770 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200771 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000772 {
773 status = psa_import_ec_public_key(
Gilles Peskine8e338702019-07-30 20:06:31 +0200774 PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000775 data, data_length,
776 &slot->data.ecp );
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000777 }
Gilles Peskinef76aa772018-10-29 19:24:33 +0100778 else
779#endif /* MBEDTLS_ECP_C */
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000780#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200781 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100782 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200783 status = psa_import_rsa_key( slot->attr.type,
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000784 data, data_length,
785 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100786 }
787 else
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000788#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100789 {
790 return( PSA_ERROR_NOT_SUPPORTED );
791 }
Gilles Peskineb46bef22019-07-30 21:32:04 +0200792
793 if( status == PSA_SUCCESS )
794 {
795 /* Write the actual key size to the slot.
796 * psa_start_key_creation() wrote the size declared by the
797 * caller, which may be 0 (meaning unspecified) or wrong. */
798 slot->attr.bits = psa_calculate_key_bits( slot );
799 }
Jaeden Amero08ad3272019-01-14 13:12:39 +0000800 return( status );
Darryl Green940d72c2018-07-13 13:18:51 +0100801}
802
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100803/** Calculate the intersection of two algorithm usage policies.
804 *
805 * Return 0 (which allows no operation) on incompatibility.
806 */
807static psa_algorithm_t psa_key_policy_algorithm_intersection(
808 psa_algorithm_t alg1,
809 psa_algorithm_t alg2 )
810{
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200811 /* Common case: both sides actually specify the same policy. */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100812 if( alg1 == alg2 )
813 return( alg1 );
814 /* If the policies are from the same hash-and-sign family, check
Gilles Peskinef603c712019-01-19 13:40:11 +0100815 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100816 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
817 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
818 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
819 {
820 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
821 return( alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100822 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100823 return( alg1 );
824 }
825 /* If the policies are incompatible, allow nothing. */
826 return( 0 );
827}
828
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200829static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
830 psa_algorithm_t requested_alg )
831{
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200832 /* Common case: the policy only allows requested_alg. */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200833 if( requested_alg == policy_alg )
834 return( 1 );
835 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200836 * and requested_alg is the same hash-and-sign family with any hash,
837 * then requested_alg is compliant with policy_alg. */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200838 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
839 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
840 {
841 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
842 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
843 }
844 /* If it isn't permitted, it's forbidden. */
845 return( 0 );
846}
847
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100848/** Test whether a policy permits an algorithm.
849 *
850 * The caller must test usage flags separately.
851 */
852static int psa_key_policy_permits( const psa_key_policy_t *policy,
853 psa_algorithm_t alg )
854{
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200855 return( psa_key_algorithm_permits( policy->alg, alg ) ||
856 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100857}
858
Gilles Peskinef603c712019-01-19 13:40:11 +0100859/** Restrict a key policy based on a constraint.
860 *
861 * \param[in,out] policy The policy to restrict.
862 * \param[in] constraint The policy constraint to apply.
863 *
864 * \retval #PSA_SUCCESS
865 * \c *policy contains the intersection of the original value of
866 * \c *policy and \c *constraint.
867 * \retval #PSA_ERROR_INVALID_ARGUMENT
868 * \c *policy and \c *constraint are incompatible.
869 * \c *policy is unchanged.
870 */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100871static psa_status_t psa_restrict_key_policy(
872 psa_key_policy_t *policy,
873 const psa_key_policy_t *constraint )
874{
875 psa_algorithm_t intersection_alg =
876 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200877 psa_algorithm_t intersection_alg2 =
878 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100879 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
880 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200881 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
882 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100883 policy->usage &= constraint->usage;
Gilles Peskinef603c712019-01-19 13:40:11 +0100884 policy->alg = intersection_alg;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200885 policy->alg2 = intersection_alg2;
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100886 return( PSA_SUCCESS );
887}
888
Darryl Green06fd18d2018-07-16 11:21:11 +0100889/** Retrieve a slot which must contain a key. The key must have allow all the
890 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
891 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100892static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100893 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100894 psa_key_usage_t usage,
895 psa_algorithm_t alg )
896{
897 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100898 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100899
900 *p_slot = NULL;
901
Gilles Peskinec5487a82018-12-03 18:08:14 +0100902 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100903 if( status != PSA_SUCCESS )
904 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100905
906 /* Enforce that usage policy for the key slot contains all the flags
907 * required by the usage parameter. There is one exception: public
908 * keys can always be exported, so we treat public key objects as
909 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200910 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100911 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +0200912 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +0100913 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914
915 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200916 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100917 return( PSA_ERROR_NOT_PERMITTED );
918
919 *p_slot = slot;
920 return( PSA_SUCCESS );
921}
Darryl Green940d72c2018-07-13 13:18:51 +0100922
Gilles Peskine28f8f302019-07-24 13:30:31 +0200923/** Retrieve a slot which must contain a transparent key.
924 *
925 * A transparent key is a key for which the key material is directly
926 * available, as opposed to a key in a secure element.
927 *
Gilles Peskine60450a42019-07-25 11:32:45 +0200928 * This is a temporary function to use instead of psa_get_key_from_slot()
929 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200930 */
931#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
932static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
933 psa_key_slot_t **p_slot,
934 psa_key_usage_t usage,
935 psa_algorithm_t alg )
936{
937 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
938 if( status != PSA_SUCCESS )
939 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +0200940 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200941 {
942 *p_slot = NULL;
943 return( PSA_ERROR_NOT_SUPPORTED );
944 }
945 return( PSA_SUCCESS );
946}
947#else /* MBEDTLS_PSA_CRYPTO_SE_C */
948/* With no secure element support, all keys are transparent. */
949#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
950 psa_get_key_from_slot( handle, p_slot, usage, alg )
951#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
952
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100953/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100954static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000955{
Gilles Peskine73167e12019-07-12 23:44:37 +0200956#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
957 if( psa_key_slot_is_external( slot ) )
958 {
959 /* No key material to clean. */
960 }
961 else
962#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine8e338702019-07-30 20:06:31 +0200963 if( slot->attr.type == PSA_KEY_TYPE_NONE )
Darryl Green40225ba2018-11-15 14:48:15 +0000964 {
965 /* No key material to clean. */
966 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200967 else if( key_type_is_raw_bytes( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000968 {
969 mbedtls_free( slot->data.raw.data );
970 }
971 else
972#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200973 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000974 {
975 mbedtls_rsa_free( slot->data.rsa );
976 mbedtls_free( slot->data.rsa );
977 }
978 else
979#endif /* defined(MBEDTLS_RSA_C) */
980#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200981 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000982 {
983 mbedtls_ecp_keypair_free( slot->data.ecp );
984 mbedtls_free( slot->data.ecp );
985 }
986 else
987#endif /* defined(MBEDTLS_ECP_C) */
988 {
989 /* Shouldn't happen: the key type is not any type that we
990 * put in. */
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200991 return( PSA_ERROR_CORRUPTION_DETECTED );
Darryl Green40225ba2018-11-15 14:48:15 +0000992 }
993
994 return( PSA_SUCCESS );
995}
996
Gilles Peskine5f25dd02019-01-14 18:24:53 +0100997static void psa_abort_operations_using_key( psa_key_slot_t *slot )
998{
Gilles Peskinec88644d2019-04-12 15:03:38 +0200999 /*FIXME how to implement this?*/
Gilles Peskine5f25dd02019-01-14 18:24:53 +01001000 (void) slot;
1001}
1002
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001003/** Completely wipe a slot in memory, including its policy.
1004 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001005psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001006{
1007 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine5f25dd02019-01-14 18:24:53 +01001008 psa_abort_operations_using_key( slot );
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009 /* At this point, key material and other type-specific content has
1010 * been wiped. Clear remaining metadata. We can call memset and not
1011 * zeroize because the metadata is not particularly sensitive. */
1012 memset( slot, 0, sizeof( *slot ) );
1013 return( status );
1014}
1015
Gilles Peskinec5487a82018-12-03 18:08:14 +01001016psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001017{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001018 psa_key_slot_t *slot;
Darryl Greend49a4992018-06-18 17:27:26 +01001019 psa_status_t status = PSA_SUCCESS;
1020 psa_status_t storage_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001021#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1022 psa_se_drv_table_entry_t *driver;
1023#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001024
Gilles Peskinec5487a82018-12-03 18:08:14 +01001025 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001026 if( status != PSA_SUCCESS )
1027 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001028
1029#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001030 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001031 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001032 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001033 /* For a key in a secure element, we need to do three things:
1034 * remove the key file in internal storage, destroy the
1035 * key inside the secure element, and update the driver's
1036 * persistent data. Start a transaction that will encompass these
1037 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001038 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001039 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001040 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001041 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001042 status = psa_crypto_save_transaction( );
1043 if( status != PSA_SUCCESS )
1044 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001045 (void) psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02001046 /* TOnogrepDO: destroy what can be destroyed anyway */
1047 return( status );
1048 }
1049
Gilles Peskine354f7672019-07-12 23:46:38 +02001050 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskinefc762652019-07-22 19:30:34 +02001051 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001052#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1053
Darryl Greend49a4992018-06-18 17:27:26 +01001054#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001055 if( slot->attr.lifetime == PSA_KEY_LIFETIME_PERSISTENT )
Darryl Greend49a4992018-06-18 17:27:26 +01001056 {
Gilles Peskine69f976b2018-11-30 18:46:56 +01001057 storage_status =
Gilles Peskine8e338702019-07-30 20:06:31 +02001058 psa_destroy_persistent_key( slot->attr.id );
Darryl Greend49a4992018-06-18 17:27:26 +01001059 }
1060#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001061
Gilles Peskinefc762652019-07-22 19:30:34 +02001062#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1063 if( driver != NULL )
1064 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001065 psa_status_t status2;
1066 status = psa_save_se_persistent_data( driver );
1067 status2 = psa_crypto_stop_transaction( );
1068 if( status == PSA_SUCCESS )
1069 status = status2;
Gilles Peskinefc762652019-07-22 19:30:34 +02001070 if( status != PSA_SUCCESS )
1071 {
1072 /* TOnogrepDO: destroy what can be destroyed anyway */
1073 return( status );
1074 }
1075 }
1076#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1077
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001078 status = psa_wipe_key_slot( slot );
Darryl Greend49a4992018-06-18 17:27:26 +01001079 if( status != PSA_SUCCESS )
1080 return( status );
1081 return( storage_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001082}
1083
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001084void psa_reset_key_attributes( psa_key_attributes_t *attributes )
1085{
Gilles Peskineb699f072019-04-26 16:06:02 +02001086 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001087 memset( attributes, 0, sizeof( *attributes ) );
1088}
1089
Gilles Peskineb699f072019-04-26 16:06:02 +02001090psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1091 psa_key_type_t type,
1092 const uint8_t *data,
1093 size_t data_length )
1094{
1095 uint8_t *copy = NULL;
1096
1097 if( data_length != 0 )
1098 {
1099 copy = mbedtls_calloc( 1, data_length );
1100 if( copy == NULL )
1101 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1102 memcpy( copy, data, data_length );
1103 }
1104 /* After this point, this function is guaranteed to succeed, so it
1105 * can start modifying `*attributes`. */
1106
1107 if( attributes->domain_parameters != NULL )
1108 {
1109 mbedtls_free( attributes->domain_parameters );
1110 attributes->domain_parameters = NULL;
1111 attributes->domain_parameters_size = 0;
1112 }
1113
1114 attributes->domain_parameters = copy;
1115 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001116 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001117 return( PSA_SUCCESS );
1118}
1119
1120psa_status_t psa_get_key_domain_parameters(
1121 const psa_key_attributes_t *attributes,
1122 uint8_t *data, size_t data_size, size_t *data_length )
1123{
1124 if( attributes->domain_parameters_size > data_size )
1125 return( PSA_ERROR_BUFFER_TOO_SMALL );
1126 *data_length = attributes->domain_parameters_size;
1127 if( attributes->domain_parameters_size != 0 )
1128 memcpy( data, attributes->domain_parameters,
1129 attributes->domain_parameters_size );
1130 return( PSA_SUCCESS );
1131}
1132
1133#if defined(MBEDTLS_RSA_C)
1134static psa_status_t psa_get_rsa_public_exponent(
1135 const mbedtls_rsa_context *rsa,
1136 psa_key_attributes_t *attributes )
1137{
1138 mbedtls_mpi mpi;
1139 int ret;
1140 uint8_t *buffer = NULL;
1141 size_t buflen;
1142 mbedtls_mpi_init( &mpi );
1143
1144 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1145 if( ret != 0 )
1146 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001147 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1148 {
1149 /* It's the default value, which is reported as an empty string,
1150 * so there's nothing to do. */
1151 goto exit;
1152 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001153
1154 buflen = mbedtls_mpi_size( &mpi );
1155 buffer = mbedtls_calloc( 1, buflen );
1156 if( buffer == NULL )
1157 {
1158 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1159 goto exit;
1160 }
1161 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1162 if( ret != 0 )
1163 goto exit;
1164 attributes->domain_parameters = buffer;
1165 attributes->domain_parameters_size = buflen;
1166
1167exit:
1168 mbedtls_mpi_free( &mpi );
1169 if( ret != 0 )
1170 mbedtls_free( buffer );
1171 return( mbedtls_to_psa_error( ret ) );
1172}
1173#endif /* MBEDTLS_RSA_C */
1174
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001175/** Retrieve all the publicly-accessible attributes of a key.
1176 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001177psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1178 psa_key_attributes_t *attributes )
1179{
1180 psa_key_slot_t *slot;
1181 psa_status_t status;
1182
1183 psa_reset_key_attributes( attributes );
1184
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001185 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001186 if( status != PSA_SUCCESS )
1187 return( status );
1188
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001189 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001190 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1191 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1192
1193#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1194 if( psa_key_slot_is_external( slot ) )
1195 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1196#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001197
Gilles Peskine8e338702019-07-30 20:06:31 +02001198 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001199 {
1200#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001201 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001202 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001203#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1204 /* TOnogrepDO: reporting the public exponent for opaque keys
1205 * is not yet implemented. */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001207 break;
1208#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001209 status = psa_get_rsa_public_exponent( slot->data.rsa, attributes );
1210 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001211#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001212 default:
1213 /* Nothing else to do. */
1214 break;
1215 }
1216
1217 if( status != PSA_SUCCESS )
1218 psa_reset_key_attributes( attributes );
1219 return( status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001220}
1221
Gilles Peskinec8000c02019-08-02 20:15:51 +02001222#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1223psa_status_t psa_get_key_slot_number(
1224 const psa_key_attributes_t *attributes,
1225 psa_key_slot_number_t *slot_number )
1226{
1227 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1228 {
1229 *slot_number = attributes->slot_number;
1230 return( PSA_SUCCESS );
1231 }
1232 else
1233 return( PSA_ERROR_INVALID_ARGUMENT );
1234}
1235#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1236
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001237#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero6b196002019-01-10 10:23:21 +00001238static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1239 unsigned char *buf, size_t size )
1240{
1241 int ret;
1242 unsigned char *c;
1243 size_t len = 0;
1244
1245 c = buf + size;
1246
1247 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1248
1249 return( (int) len );
1250}
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001251#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero6b196002019-01-10 10:23:21 +00001252
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001253static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1254 uint8_t *data,
1255 size_t data_size,
1256 size_t *data_length,
1257 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001258{
Gilles Peskine5d309672019-07-12 23:47:28 +02001259#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1260 const psa_drv_se_t *drv;
1261 psa_drv_se_context_t *drv_context;
1262#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1263
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001264 *data_length = 0;
1265
Gilles Peskine8e338702019-07-30 20:06:31 +02001266 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001267 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001268
Gilles Peskine5d309672019-07-12 23:47:28 +02001269#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001270 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001271 {
1272 psa_drv_se_export_key_t method;
1273 if( drv->key_management == NULL )
1274 return( PSA_ERROR_NOT_SUPPORTED );
1275 method = ( export_public_key ?
1276 drv->key_management->p_export_public :
1277 drv->key_management->p_export );
1278 if( method == NULL )
1279 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001280 return( method( drv_context,
1281 slot->data.se.slot_number,
1282 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001283 }
1284#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1285
Gilles Peskine8e338702019-07-30 20:06:31 +02001286 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001287 {
1288 if( slot->data.raw.bytes > data_size )
1289 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine52b90182018-10-29 19:26:27 +01001290 if( data_size != 0 )
1291 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001292 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
Gilles Peskine52b90182018-10-29 19:26:27 +01001293 memset( data + slot->data.raw.bytes, 0,
1294 data_size - slot->data.raw.bytes );
1295 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001296 *data_length = slot->data.raw.bytes;
1297 return( PSA_SUCCESS );
1298 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001299#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001300 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) && !export_public_key )
Gilles Peskine188c71e2018-10-29 19:26:02 +01001301 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001302 psa_status_t status;
1303
Gilles Peskineb46bef22019-07-30 21:32:04 +02001304 size_t bytes = PSA_BITS_TO_BYTES( slot->attr.bits );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001305 if( bytes > data_size )
1306 return( PSA_ERROR_BUFFER_TOO_SMALL );
1307 status = mbedtls_to_psa_error(
1308 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1309 if( status != PSA_SUCCESS )
1310 return( status );
1311 memset( data + bytes, 0, data_size - bytes );
1312 *data_length = bytes;
1313 return( PSA_SUCCESS );
1314 }
1315#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001316 else
Moran Peker17e36e12018-05-02 12:55:20 +03001317 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001318#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001319 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1320 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001321 {
Moran Pekera998bc62018-04-16 18:16:20 +03001322 mbedtls_pk_context pk;
1323 int ret;
Gilles Peskine8e338702019-07-30 20:06:31 +02001324 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001325 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001326#if defined(MBEDTLS_RSA_C)
1327 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001328 pk.pk_info = &mbedtls_rsa_info;
1329 pk.pk_ctx = slot->data.rsa;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001330#else
1331 return( PSA_ERROR_NOT_SUPPORTED );
1332#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001333 }
1334 else
1335 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001336#if defined(MBEDTLS_ECP_C)
1337 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001338 pk.pk_info = &mbedtls_eckey_info;
1339 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001340#else
1341 return( PSA_ERROR_NOT_SUPPORTED );
1342#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001343 }
Gilles Peskine8e338702019-07-30 20:06:31 +02001344 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero6b196002019-01-10 10:23:21 +00001345 {
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001346 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero6b196002019-01-10 10:23:21 +00001347 }
Moran Peker17e36e12018-05-02 12:55:20 +03001348 else
Jaeden Amero6b196002019-01-10 10:23:21 +00001349 {
Moran Peker17e36e12018-05-02 12:55:20 +03001350 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero6b196002019-01-10 10:23:21 +00001351 }
Moran Peker60364322018-04-29 11:34:58 +03001352 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001353 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001354 /* If data_size is 0 then data may be NULL and then the
1355 * call to memset would have undefined behavior. */
1356 if( data_size != 0 )
1357 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001358 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001359 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001360 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1361 * Move the data to the beginning and erase remaining data
1362 * at the original location. */
1363 if( 2 * (size_t) ret <= data_size )
1364 {
1365 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001366 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001367 }
1368 else if( (size_t) ret < data_size )
1369 {
1370 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001371 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001372 }
Moran Pekera998bc62018-04-16 18:16:20 +03001373 *data_length = ret;
1374 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001375 }
1376 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001377#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001378 {
1379 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001380 it is valid for a special-purpose implementation to omit
1381 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001382 return( PSA_ERROR_NOT_SUPPORTED );
1383 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001384 }
1385}
1386
Gilles Peskinec5487a82018-12-03 18:08:14 +01001387psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001388 uint8_t *data,
1389 size_t data_size,
1390 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001391{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001392 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001393 psa_status_t status;
1394
1395 /* Set the key to empty now, so that even when there are errors, we always
1396 * set data_length to a value between 0 and data_size. On error, setting
1397 * the key to empty is a good choice because an empty key representation is
1398 * unlikely to be accepted anywhere. */
1399 *data_length = 0;
1400
1401 /* Export requires the EXPORT flag. There is an exception for public keys,
1402 * which don't require any flag, but psa_get_key_from_slot takes
1403 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001404 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001405 if( status != PSA_SUCCESS )
1406 return( status );
1407 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001408 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001409}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001410
Gilles Peskinec5487a82018-12-03 18:08:14 +01001411psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001412 uint8_t *data,
1413 size_t data_size,
1414 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001415{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001416 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001417 psa_status_t status;
1418
1419 /* Set the key to empty now, so that even when there are errors, we always
1420 * set data_length to a value between 0 and data_size. On error, setting
1421 * the key to empty is a good choice because an empty key representation is
1422 * unlikely to be accepted anywhere. */
1423 *data_length = 0;
1424
1425 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001426 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001427 if( status != PSA_SUCCESS )
1428 return( status );
1429 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001430 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001431}
1432
Gilles Peskine91e8c332019-08-02 19:19:39 +02001433#if defined(static_assert)
1434static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1435 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001436static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001437 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001438static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001439 "One or more key attribute flag is listed as both internal-only and external-only" );
1440#endif
1441
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001442/** Validate that a key policy is internally well-formed.
1443 *
1444 * This function only rejects invalid policies. It does not validate the
1445 * consistency of the policy with respect to other attributes of the key
1446 * such as the key type.
1447 */
1448static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001449{
1450 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001451 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001452 PSA_KEY_USAGE_ENCRYPT |
1453 PSA_KEY_USAGE_DECRYPT |
1454 PSA_KEY_USAGE_SIGN |
1455 PSA_KEY_USAGE_VERIFY |
1456 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1457 return( PSA_ERROR_INVALID_ARGUMENT );
1458
Gilles Peskine4747d192019-04-17 15:05:45 +02001459 return( PSA_SUCCESS );
1460}
1461
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001462/** Validate the internal consistency of key attributes.
1463 *
1464 * This function only rejects invalid attribute values. If does not
1465 * validate the consistency of the attributes with any key data that may
1466 * be involved in the creation of the key.
1467 *
1468 * Call this function early in the key creation process.
1469 *
1470 * \param[in] attributes Key attributes for the new key.
1471 * \param[out] p_drv On any return, the driver for the key, if any.
1472 * NULL for a transparent key.
1473 *
1474 */
1475static psa_status_t psa_validate_key_attributes(
1476 const psa_key_attributes_t *attributes,
1477 psa_se_drv_table_entry_t **p_drv )
1478{
1479 psa_status_t status;
1480
1481 if( attributes->core.lifetime != PSA_KEY_LIFETIME_VOLATILE )
1482 {
1483 status = psa_validate_persistent_key_parameters(
1484 attributes->core.lifetime, attributes->core.id,
1485 p_drv, 1 );
1486 if( status != PSA_SUCCESS )
1487 return( status );
1488 }
1489
1490 status = psa_validate_key_policy( &attributes->core.policy );
1491 if( status != PSA_SUCCESS )
1492 return( status );
1493
1494 /* Refuse to create overly large keys.
1495 * Note that this doesn't trigger on import if the attributes don't
1496 * explicitly specify a size (so psa_get_key_bits returns 0), so
1497 * psa_import_key() needs its own checks. */
1498 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1499 return( PSA_ERROR_NOT_SUPPORTED );
1500
Gilles Peskine91e8c332019-08-02 19:19:39 +02001501 /* Reject invalid flags. These should not be reachable through the API. */
1502 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1503 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1504 return( PSA_ERROR_INVALID_ARGUMENT );
1505
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001506 return( PSA_SUCCESS );
1507}
1508
Gilles Peskine4747d192019-04-17 15:05:45 +02001509/** Prepare a key slot to receive key material.
1510 *
1511 * This function allocates a key slot and sets its metadata.
1512 *
1513 * If this function fails, call psa_fail_key_creation().
1514 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001515 * This function is intended to be used as follows:
1516 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1517 * it with the specified attributes, and assign it a handle.
1518 * -# Populate the slot with the key material.
1519 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1520 * In case of failure at any step, stop the sequence and call
1521 * psa_fail_key_creation().
1522 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001523 * \param[in] attributes Key attributes for the new key.
1524 * \param[out] handle On success, a handle for the allocated slot.
1525 * \param[out] p_slot On success, a pointer to the prepared slot.
1526 * \param[out] p_drv On any return, the driver for the key, if any.
1527 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001528 *
1529 * \retval #PSA_SUCCESS
1530 * The key slot is ready to receive key material.
1531 * \return If this function fails, the key slot is an invalid state.
1532 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001533 */
1534static psa_status_t psa_start_key_creation(
1535 const psa_key_attributes_t *attributes,
1536 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001537 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001538 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001539{
1540 psa_status_t status;
1541 psa_key_slot_t *slot;
1542
Gilles Peskine011e4282019-06-26 18:34:38 +02001543 *p_drv = NULL;
1544
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001545 status = psa_validate_key_attributes( attributes, p_drv );
1546 if( status != PSA_SUCCESS )
1547 return( status );
1548
Gilles Peskineedbed562019-08-07 18:19:59 +02001549 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001550 if( status != PSA_SUCCESS )
1551 return( status );
1552 slot = *p_slot;
1553
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001554 /* We're storing the declared bit-size of the key. It's up to each
1555 * creation mechanism to verify that this information is correct.
1556 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001557 * an input (generate, device) but not for those where the bit-size
1558 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001559
1560 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001561
Gilles Peskine91e8c332019-08-02 19:19:39 +02001562 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001563 * external-only flags, query `attributes`. Thanks to the check
1564 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001565 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001566 * may have set. */
1567 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001568
Gilles Peskinecbaff462019-07-12 23:46:04 +02001569#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine60450a42019-07-25 11:32:45 +02001570 /* For a key in a secure element, we need to do three things:
1571 * create the key file in internal storage, create the
1572 * key inside the secure element, and update the driver's
1573 * persistent data. Start a transaction that will encompass these
1574 * three actions. */
1575 /* The first thing to do is to find a slot number for the new key.
1576 * We save the slot number in persistent storage as part of the
1577 * transaction data. It will be needed to recover if the power
1578 * fails during the key creation process, to clean up on the secure
1579 * element side after restarting. Obtaining a slot number from the
1580 * secure element driver updates its persistent state, but we do not yet
1581 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001582 * we can roll back to a state where the key doesn't exist. */
Gilles Peskinecbaff462019-07-12 23:46:04 +02001583 if( *p_drv != NULL )
1584 {
1585 status = psa_find_se_slot_for_key( attributes, *p_drv,
1586 &slot->data.se.slot_number );
1587 if( status != PSA_SUCCESS )
1588 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001589 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001590 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001591 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001592 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001593 status = psa_crypto_save_transaction( );
1594 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001595 {
1596 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001597 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001598 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001599 }
1600#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1601
Gilles Peskine4747d192019-04-17 15:05:45 +02001602 return( status );
1603}
1604
1605/** Finalize the creation of a key once its key material has been set.
1606 *
1607 * This entails writing the key to persistent storage.
1608 *
1609 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001610 * See the documentation of psa_start_key_creation() for the intended use
1611 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001612 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001613 * \param[in,out] slot Pointer to the slot with key material.
1614 * \param[in] driver The secure element driver for the key,
1615 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001616 *
1617 * \retval #PSA_SUCCESS
1618 * The key was successfully created. The handle is now valid.
1619 * \return If this function fails, the key slot is an invalid state.
1620 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001621 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001622static psa_status_t psa_finish_key_creation(
1623 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001624 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001625{
1626 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001627 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001628 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001629
1630#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001631 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001632 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001633#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1634 if( driver != NULL )
1635 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001636 psa_se_key_data_storage_t data;
1637#if defined(static_assert)
1638 static_assert( sizeof( slot->data.se.slot_number ) ==
1639 sizeof( data.slot_number ),
1640 "Slot number size does not match psa_se_key_data_storage_t" );
1641 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1642 "Bit-size size does not match psa_se_key_data_storage_t" );
1643#endif
1644 memcpy( &data.slot_number, &slot->data.se.slot_number,
1645 sizeof( slot->data.se.slot_number ) );
1646 memcpy( &data.bits, &slot->attr.bits,
1647 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001648 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001649 (uint8_t*) &data,
1650 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001651 }
1652 else
1653#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1654 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001655 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001656 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001657 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001658 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1659 size_t length = 0;
Gilles Peskine1df83d42019-07-23 16:13:14 +02001660 if( buffer == NULL && buffer_size != 0 )
1661 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1662 status = psa_internal_export_key( slot,
1663 buffer, buffer_size, &length,
1664 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001665 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001666 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001667 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001668
Gilles Peskine1df83d42019-07-23 16:13:14 +02001669 if( buffer_size != 0 )
1670 mbedtls_platform_zeroize( buffer, buffer_size );
1671 mbedtls_free( buffer );
1672 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001673 }
1674#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1675
Gilles Peskinecbaff462019-07-12 23:46:04 +02001676#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1677 if( driver != NULL )
1678 {
1679 status = psa_save_se_persistent_data( driver );
1680 if( status != PSA_SUCCESS )
1681 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001682 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001683 return( status );
1684 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001685 status = psa_crypto_stop_transaction( );
1686 if( status != PSA_SUCCESS )
1687 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001688 }
1689#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1690
Gilles Peskine4747d192019-04-17 15:05:45 +02001691 return( status );
1692}
1693
1694/** Abort the creation of a key.
1695 *
1696 * You may call this function after calling psa_start_key_creation(),
1697 * or after psa_finish_key_creation() fails. In other circumstances, this
1698 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001699 * See the documentation of psa_start_key_creation() for the intended use
1700 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001701 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001702 * \param[in,out] slot Pointer to the slot with key material.
1703 * \param[in] driver The secure element driver for the key,
1704 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001705 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001706static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001707 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001708{
Gilles Peskine011e4282019-06-26 18:34:38 +02001709 (void) driver;
1710
Gilles Peskine4747d192019-04-17 15:05:45 +02001711 if( slot == NULL )
1712 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001713
1714#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1715 /* TOnogrepDO: If the key has already been created in the secure
1716 * element, and the failure happened later (when saving metadata
1717 * to internal storage), we need to destroy the key in the secure
1718 * element. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001719
1720 /* Abort the ongoing transaction if any. We already did what it
1721 * takes to undo any partial creation. All that's left is to update
1722 * the transaction data itself. */
1723 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001724#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1725
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 psa_wipe_key_slot( slot );
1727}
1728
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001729/** Validate optional attributes during key creation.
1730 *
1731 * Some key attributes are optional during key creation. If they are
1732 * specified in the attributes structure, check that they are consistent
1733 * with the data in the slot.
1734 *
1735 * This function should be called near the end of key creation, after
1736 * the slot in memory is fully populated but before saving persistent data.
1737 */
1738static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001739 const psa_key_slot_t *slot,
1740 const psa_key_attributes_t *attributes )
1741{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001742 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001743 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001744 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001745 return( PSA_ERROR_INVALID_ARGUMENT );
1746 }
1747
1748 if( attributes->domain_parameters_size != 0 )
1749 {
1750#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001751 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001752 {
1753 mbedtls_mpi actual, required;
1754 int ret;
1755 mbedtls_mpi_init( &actual );
1756 mbedtls_mpi_init( &required );
1757 ret = mbedtls_rsa_export( slot->data.rsa,
1758 NULL, NULL, NULL, NULL, &actual );
1759 if( ret != 0 )
1760 goto rsa_exit;
1761 ret = mbedtls_mpi_read_binary( &required,
1762 attributes->domain_parameters,
1763 attributes->domain_parameters_size );
1764 if( ret != 0 )
1765 goto rsa_exit;
1766 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1767 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1768 rsa_exit:
1769 mbedtls_mpi_free( &actual );
1770 mbedtls_mpi_free( &required );
1771 if( ret != 0)
1772 return( mbedtls_to_psa_error( ret ) );
1773 }
1774 else
1775#endif
1776 {
1777 return( PSA_ERROR_INVALID_ARGUMENT );
1778 }
1779 }
1780
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001781 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001782 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001783 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001784 return( PSA_ERROR_INVALID_ARGUMENT );
1785 }
1786
1787 return( PSA_SUCCESS );
1788}
1789
Gilles Peskine4747d192019-04-17 15:05:45 +02001790psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001791 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001792 size_t data_length,
1793 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001794{
1795 psa_status_t status;
1796 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001797 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001798
Gilles Peskine011e4282019-06-26 18:34:38 +02001799 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001800 if( status != PSA_SUCCESS )
1801 goto exit;
1802
Gilles Peskine5d309672019-07-12 23:47:28 +02001803#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1804 if( driver != NULL )
1805 {
1806 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001807 size_t bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001808 if( drv->key_management == NULL ||
1809 drv->key_management->p_import == NULL )
1810 {
1811 status = PSA_ERROR_NOT_SUPPORTED;
1812 goto exit;
1813 }
1814 status = drv->key_management->p_import(
1815 psa_get_se_driver_context( driver ),
1816 slot->data.se.slot_number,
Gilles Peskine8e338702019-07-30 20:06:31 +02001817 slot->attr.lifetime, slot->attr.type,
1818 slot->attr.policy.alg, slot->attr.policy.usage,
Gilles Peskine18017402019-07-24 20:25:59 +02001819 data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001820 &bits );
1821 if( status != PSA_SUCCESS )
1822 goto exit;
1823 if( bits > PSA_MAX_KEY_BITS )
1824 {
1825 status = PSA_ERROR_NOT_SUPPORTED;
1826 goto exit;
1827 }
1828 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001829 }
1830 else
1831#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1832 {
1833 status = psa_import_key_into_slot( slot, data, data_length );
1834 if( status != PSA_SUCCESS )
1835 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001836 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001837 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001838 if( status != PSA_SUCCESS )
1839 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840
Gilles Peskine011e4282019-06-26 18:34:38 +02001841 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001843 if( status != PSA_SUCCESS )
1844 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001845 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001846 *handle = 0;
1847 }
1848 return( status );
1849}
1850
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001851static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001852 psa_key_slot_t *target )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001853{
1854 psa_status_t status;
1855 uint8_t *buffer = NULL;
1856 size_t buffer_size = 0;
1857 size_t length;
1858
Gilles Peskine8e338702019-07-30 20:06:31 +02001859 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001860 psa_get_key_slot_bits( source ) );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001861 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001862 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001863 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001864 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1865 if( status != PSA_SUCCESS )
1866 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001867 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001868 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001869
1870exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001871 if( buffer_size != 0 )
1872 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001873 mbedtls_free( buffer );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001874 return( status );
1875}
1876
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001877psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1878 const psa_key_attributes_t *specified_attributes,
1879 psa_key_handle_t *target_handle )
1880{
1881 psa_status_t status;
1882 psa_key_slot_t *source_slot = NULL;
1883 psa_key_slot_t *target_slot = NULL;
1884 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001885 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001886
Gilles Peskine28f8f302019-07-24 13:30:31 +02001887 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001888 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001889 if( status != PSA_SUCCESS )
1890 goto exit;
1891
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001892 status = psa_validate_optional_attributes( source_slot,
1893 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001894 if( status != PSA_SUCCESS )
1895 goto exit;
1896
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001897 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001898 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001899 if( status != PSA_SUCCESS )
1900 goto exit;
1901
1902 status = psa_start_key_creation( &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001903 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001904 if( status != PSA_SUCCESS )
1905 goto exit;
1906
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001907#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1908 if( driver != NULL )
1909 {
1910 /* Copying to a secure element is not implemented yet. */
1911 status = PSA_ERROR_NOT_SUPPORTED;
1912 goto exit;
1913 }
1914#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1915
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001916 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001917 if( status != PSA_SUCCESS )
1918 goto exit;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001919
Gilles Peskine011e4282019-06-26 18:34:38 +02001920 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001921exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001922 if( status != PSA_SUCCESS )
1923 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001924 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001925 *target_handle = 0;
1926 }
1927 return( status );
1928}
1929
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001930
1931
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001932/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001933/* Message digests */
1934/****************************************************************/
1935
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001936static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001937{
1938 switch( alg )
1939 {
1940#if defined(MBEDTLS_MD2_C)
1941 case PSA_ALG_MD2:
1942 return( &mbedtls_md2_info );
1943#endif
1944#if defined(MBEDTLS_MD4_C)
1945 case PSA_ALG_MD4:
1946 return( &mbedtls_md4_info );
1947#endif
1948#if defined(MBEDTLS_MD5_C)
1949 case PSA_ALG_MD5:
1950 return( &mbedtls_md5_info );
1951#endif
1952#if defined(MBEDTLS_RIPEMD160_C)
1953 case PSA_ALG_RIPEMD160:
1954 return( &mbedtls_ripemd160_info );
1955#endif
1956#if defined(MBEDTLS_SHA1_C)
1957 case PSA_ALG_SHA_1:
1958 return( &mbedtls_sha1_info );
1959#endif
1960#if defined(MBEDTLS_SHA256_C)
1961 case PSA_ALG_SHA_224:
1962 return( &mbedtls_sha224_info );
1963 case PSA_ALG_SHA_256:
1964 return( &mbedtls_sha256_info );
1965#endif
1966#if defined(MBEDTLS_SHA512_C)
1967 case PSA_ALG_SHA_384:
1968 return( &mbedtls_sha384_info );
1969 case PSA_ALG_SHA_512:
1970 return( &mbedtls_sha512_info );
1971#endif
1972 default:
1973 return( NULL );
1974 }
1975}
1976
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001977psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
1978{
1979 switch( operation->alg )
1980 {
Gilles Peskine81736312018-06-26 15:04:31 +02001981 case 0:
1982 /* The object has (apparently) been initialized but it is not
1983 * in use. It's ok to call abort on such an object, and there's
1984 * nothing to do. */
1985 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001986#if defined(MBEDTLS_MD2_C)
1987 case PSA_ALG_MD2:
1988 mbedtls_md2_free( &operation->ctx.md2 );
1989 break;
1990#endif
1991#if defined(MBEDTLS_MD4_C)
1992 case PSA_ALG_MD4:
1993 mbedtls_md4_free( &operation->ctx.md4 );
1994 break;
1995#endif
1996#if defined(MBEDTLS_MD5_C)
1997 case PSA_ALG_MD5:
1998 mbedtls_md5_free( &operation->ctx.md5 );
1999 break;
2000#endif
2001#if defined(MBEDTLS_RIPEMD160_C)
2002 case PSA_ALG_RIPEMD160:
2003 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2004 break;
2005#endif
2006#if defined(MBEDTLS_SHA1_C)
2007 case PSA_ALG_SHA_1:
2008 mbedtls_sha1_free( &operation->ctx.sha1 );
2009 break;
2010#endif
2011#if defined(MBEDTLS_SHA256_C)
2012 case PSA_ALG_SHA_224:
2013 case PSA_ALG_SHA_256:
2014 mbedtls_sha256_free( &operation->ctx.sha256 );
2015 break;
2016#endif
2017#if defined(MBEDTLS_SHA512_C)
2018 case PSA_ALG_SHA_384:
2019 case PSA_ALG_SHA_512:
2020 mbedtls_sha512_free( &operation->ctx.sha512 );
2021 break;
2022#endif
2023 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002024 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002025 }
2026 operation->alg = 0;
2027 return( PSA_SUCCESS );
2028}
2029
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002030psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002031 psa_algorithm_t alg )
2032{
2033 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002034
2035 /* A context must be freshly initialized before it can be set up. */
2036 if( operation->alg != 0 )
2037 {
2038 return( PSA_ERROR_BAD_STATE );
2039 }
2040
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002041 switch( alg )
2042 {
2043#if defined(MBEDTLS_MD2_C)
2044 case PSA_ALG_MD2:
2045 mbedtls_md2_init( &operation->ctx.md2 );
2046 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2047 break;
2048#endif
2049#if defined(MBEDTLS_MD4_C)
2050 case PSA_ALG_MD4:
2051 mbedtls_md4_init( &operation->ctx.md4 );
2052 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2053 break;
2054#endif
2055#if defined(MBEDTLS_MD5_C)
2056 case PSA_ALG_MD5:
2057 mbedtls_md5_init( &operation->ctx.md5 );
2058 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2059 break;
2060#endif
2061#if defined(MBEDTLS_RIPEMD160_C)
2062 case PSA_ALG_RIPEMD160:
2063 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2064 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2065 break;
2066#endif
2067#if defined(MBEDTLS_SHA1_C)
2068 case PSA_ALG_SHA_1:
2069 mbedtls_sha1_init( &operation->ctx.sha1 );
2070 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2071 break;
2072#endif
2073#if defined(MBEDTLS_SHA256_C)
2074 case PSA_ALG_SHA_224:
2075 mbedtls_sha256_init( &operation->ctx.sha256 );
2076 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2077 break;
2078 case PSA_ALG_SHA_256:
2079 mbedtls_sha256_init( &operation->ctx.sha256 );
2080 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2081 break;
2082#endif
2083#if defined(MBEDTLS_SHA512_C)
2084 case PSA_ALG_SHA_384:
2085 mbedtls_sha512_init( &operation->ctx.sha512 );
2086 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2087 break;
2088 case PSA_ALG_SHA_512:
2089 mbedtls_sha512_init( &operation->ctx.sha512 );
2090 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2091 break;
2092#endif
2093 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002094 return( PSA_ALG_IS_HASH( alg ) ?
2095 PSA_ERROR_NOT_SUPPORTED :
2096 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002097 }
2098 if( ret == 0 )
2099 operation->alg = alg;
2100 else
2101 psa_hash_abort( operation );
2102 return( mbedtls_to_psa_error( ret ) );
2103}
2104
2105psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2106 const uint8_t *input,
2107 size_t input_length )
2108{
2109 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002110
2111 /* Don't require hash implementations to behave correctly on a
2112 * zero-length input, which may have an invalid pointer. */
2113 if( input_length == 0 )
2114 return( PSA_SUCCESS );
2115
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002116 switch( operation->alg )
2117 {
2118#if defined(MBEDTLS_MD2_C)
2119 case PSA_ALG_MD2:
2120 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2121 input, input_length );
2122 break;
2123#endif
2124#if defined(MBEDTLS_MD4_C)
2125 case PSA_ALG_MD4:
2126 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2127 input, input_length );
2128 break;
2129#endif
2130#if defined(MBEDTLS_MD5_C)
2131 case PSA_ALG_MD5:
2132 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2133 input, input_length );
2134 break;
2135#endif
2136#if defined(MBEDTLS_RIPEMD160_C)
2137 case PSA_ALG_RIPEMD160:
2138 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2139 input, input_length );
2140 break;
2141#endif
2142#if defined(MBEDTLS_SHA1_C)
2143 case PSA_ALG_SHA_1:
2144 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2145 input, input_length );
2146 break;
2147#endif
2148#if defined(MBEDTLS_SHA256_C)
2149 case PSA_ALG_SHA_224:
2150 case PSA_ALG_SHA_256:
2151 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2152 input, input_length );
2153 break;
2154#endif
2155#if defined(MBEDTLS_SHA512_C)
2156 case PSA_ALG_SHA_384:
2157 case PSA_ALG_SHA_512:
2158 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2159 input, input_length );
2160 break;
2161#endif
2162 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002163 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002164 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002165
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166 if( ret != 0 )
2167 psa_hash_abort( operation );
2168 return( mbedtls_to_psa_error( ret ) );
2169}
2170
2171psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2172 uint8_t *hash,
2173 size_t hash_size,
2174 size_t *hash_length )
2175{
itayzafrir40835d42018-08-02 13:14:17 +03002176 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002178 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002179
2180 /* Fill the output buffer with something that isn't a valid hash
2181 * (barring an attack on the hash and deliberately-crafted input),
2182 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002183 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002184 /* If hash_size is 0 then hash may be NULL and then the
2185 * call to memset would have undefined behavior. */
2186 if( hash_size != 0 )
2187 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002188
2189 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002190 {
2191 status = PSA_ERROR_BUFFER_TOO_SMALL;
2192 goto exit;
2193 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194
2195 switch( operation->alg )
2196 {
2197#if defined(MBEDTLS_MD2_C)
2198 case PSA_ALG_MD2:
2199 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2200 break;
2201#endif
2202#if defined(MBEDTLS_MD4_C)
2203 case PSA_ALG_MD4:
2204 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2205 break;
2206#endif
2207#if defined(MBEDTLS_MD5_C)
2208 case PSA_ALG_MD5:
2209 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2210 break;
2211#endif
2212#if defined(MBEDTLS_RIPEMD160_C)
2213 case PSA_ALG_RIPEMD160:
2214 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2215 break;
2216#endif
2217#if defined(MBEDTLS_SHA1_C)
2218 case PSA_ALG_SHA_1:
2219 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2220 break;
2221#endif
2222#if defined(MBEDTLS_SHA256_C)
2223 case PSA_ALG_SHA_224:
2224 case PSA_ALG_SHA_256:
2225 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2226 break;
2227#endif
2228#if defined(MBEDTLS_SHA512_C)
2229 case PSA_ALG_SHA_384:
2230 case PSA_ALG_SHA_512:
2231 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2232 break;
2233#endif
2234 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002235 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002236 }
itayzafrir40835d42018-08-02 13:14:17 +03002237 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002238
itayzafrir40835d42018-08-02 13:14:17 +03002239exit:
2240 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002241 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002242 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002243 return( psa_hash_abort( operation ) );
2244 }
2245 else
2246 {
2247 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002248 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002249 }
2250}
2251
Gilles Peskine2d277862018-06-18 15:41:12 +02002252psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2253 const uint8_t *hash,
2254 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255{
2256 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2257 size_t actual_hash_length;
2258 psa_status_t status = psa_hash_finish( operation,
2259 actual_hash, sizeof( actual_hash ),
2260 &actual_hash_length );
2261 if( status != PSA_SUCCESS )
2262 return( status );
2263 if( actual_hash_length != hash_length )
2264 return( PSA_ERROR_INVALID_SIGNATURE );
2265 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2266 return( PSA_ERROR_INVALID_SIGNATURE );
2267 return( PSA_SUCCESS );
2268}
2269
Gilles Peskineeb35d782019-01-22 17:56:16 +01002270psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2271 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002272{
2273 if( target_operation->alg != 0 )
2274 return( PSA_ERROR_BAD_STATE );
2275
2276 switch( source_operation->alg )
2277 {
2278 case 0:
2279 return( PSA_ERROR_BAD_STATE );
2280#if defined(MBEDTLS_MD2_C)
2281 case PSA_ALG_MD2:
2282 mbedtls_md2_clone( &target_operation->ctx.md2,
2283 &source_operation->ctx.md2 );
2284 break;
2285#endif
2286#if defined(MBEDTLS_MD4_C)
2287 case PSA_ALG_MD4:
2288 mbedtls_md4_clone( &target_operation->ctx.md4,
2289 &source_operation->ctx.md4 );
2290 break;
2291#endif
2292#if defined(MBEDTLS_MD5_C)
2293 case PSA_ALG_MD5:
2294 mbedtls_md5_clone( &target_operation->ctx.md5,
2295 &source_operation->ctx.md5 );
2296 break;
2297#endif
2298#if defined(MBEDTLS_RIPEMD160_C)
2299 case PSA_ALG_RIPEMD160:
2300 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2301 &source_operation->ctx.ripemd160 );
2302 break;
2303#endif
2304#if defined(MBEDTLS_SHA1_C)
2305 case PSA_ALG_SHA_1:
2306 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2307 &source_operation->ctx.sha1 );
2308 break;
2309#endif
2310#if defined(MBEDTLS_SHA256_C)
2311 case PSA_ALG_SHA_224:
2312 case PSA_ALG_SHA_256:
2313 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2314 &source_operation->ctx.sha256 );
2315 break;
2316#endif
2317#if defined(MBEDTLS_SHA512_C)
2318 case PSA_ALG_SHA_384:
2319 case PSA_ALG_SHA_512:
2320 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2321 &source_operation->ctx.sha512 );
2322 break;
2323#endif
2324 default:
2325 return( PSA_ERROR_NOT_SUPPORTED );
2326 }
2327
2328 target_operation->alg = source_operation->alg;
2329 return( PSA_SUCCESS );
2330}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002331
2332
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002333/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002334/* MAC */
2335/****************************************************************/
2336
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002337static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002338 psa_algorithm_t alg,
2339 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002340 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002341 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002342{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002343 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002344 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002345
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002346 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002347 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002348
Gilles Peskine8c9def32018-02-08 10:02:12 +01002349 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2350 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002351 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002352 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002353 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002354 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002355 mode = MBEDTLS_MODE_STREAM;
2356 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002357 case PSA_ALG_CTR:
2358 mode = MBEDTLS_MODE_CTR;
2359 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002360 case PSA_ALG_CFB:
2361 mode = MBEDTLS_MODE_CFB;
2362 break;
2363 case PSA_ALG_OFB:
2364 mode = MBEDTLS_MODE_OFB;
2365 break;
2366 case PSA_ALG_CBC_NO_PADDING:
2367 mode = MBEDTLS_MODE_CBC;
2368 break;
2369 case PSA_ALG_CBC_PKCS7:
2370 mode = MBEDTLS_MODE_CBC;
2371 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002372 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002373 mode = MBEDTLS_MODE_CCM;
2374 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002375 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002376 mode = MBEDTLS_MODE_GCM;
2377 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002378 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2379 mode = MBEDTLS_MODE_CHACHAPOLY;
2380 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002381 default:
2382 return( NULL );
2383 }
2384 }
2385 else if( alg == PSA_ALG_CMAC )
2386 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002387 else
2388 return( NULL );
2389
2390 switch( key_type )
2391 {
2392 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002393 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002394 break;
2395 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002396 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2397 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002398 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002399 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002400 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002401 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002402 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2403 * but two-key Triple-DES is functionally three-key Triple-DES
2404 * with K1=K3, so that's how we present it to mbedtls. */
2405 if( key_bits == 128 )
2406 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002407 break;
2408 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002409 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410 break;
2411 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002412 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002413 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002414 case PSA_KEY_TYPE_CHACHA20:
2415 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2416 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002417 default:
2418 return( NULL );
2419 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002420 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002421 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002422
Jaeden Amero23bbb752018-06-26 14:16:54 +01002423 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2424 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002425}
2426
Gilles Peskinea05219c2018-11-16 16:02:56 +01002427#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002428static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002429{
Gilles Peskine2d277862018-06-18 15:41:12 +02002430 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002431 {
2432 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002433 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002434 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002435 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002436 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002437 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002438 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002439 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002440 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002441 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002442 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002443 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002444 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002445 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002446 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002447 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002448 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002449 return( 128 );
2450 default:
2451 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002452 }
2453}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002454#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002455
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002456/* Initialize the MAC operation structure. Once this function has been
2457 * called, psa_mac_abort can run and will do the right thing. */
2458static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2459 psa_algorithm_t alg )
2460{
2461 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2462
2463 operation->alg = alg;
2464 operation->key_set = 0;
2465 operation->iv_set = 0;
2466 operation->iv_required = 0;
2467 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002468 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002469
2470#if defined(MBEDTLS_CMAC_C)
2471 if( alg == PSA_ALG_CMAC )
2472 {
2473 operation->iv_required = 0;
2474 mbedtls_cipher_init( &operation->ctx.cmac );
2475 status = PSA_SUCCESS;
2476 }
2477 else
2478#endif /* MBEDTLS_CMAC_C */
2479#if defined(MBEDTLS_MD_C)
2480 if( PSA_ALG_IS_HMAC( operation->alg ) )
2481 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002482 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2483 operation->ctx.hmac.hash_ctx.alg = 0;
2484 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002485 }
2486 else
2487#endif /* MBEDTLS_MD_C */
2488 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002489 if( ! PSA_ALG_IS_MAC( alg ) )
2490 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002491 }
2492
2493 if( status != PSA_SUCCESS )
2494 memset( operation, 0, sizeof( *operation ) );
2495 return( status );
2496}
2497
Gilles Peskine01126fa2018-07-12 17:04:55 +02002498#if defined(MBEDTLS_MD_C)
2499static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2500{
Gilles Peskine3f108122018-12-07 18:14:53 +01002501 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002502 return( psa_hash_abort( &hmac->hash_ctx ) );
2503}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002504
Janos Follath999f6482019-06-11 12:04:10 +01002505#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002506static void psa_hmac_init_internal( psa_hmac_internal_data *hmac )
2507{
2508 /* Instances of psa_hash_operation_s can be initialized by zeroization. */
2509 memset( hmac, 0, sizeof( *hmac ) );
2510}
Janos Follath999f6482019-06-11 12:04:10 +01002511#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002512#endif /* MBEDTLS_MD_C */
2513
Gilles Peskine8c9def32018-02-08 10:02:12 +01002514psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2515{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002516 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002517 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002518 /* The object has (apparently) been initialized but it is not
2519 * in use. It's ok to call abort on such an object, and there's
2520 * nothing to do. */
2521 return( PSA_SUCCESS );
2522 }
2523 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002524#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002525 if( operation->alg == PSA_ALG_CMAC )
2526 {
2527 mbedtls_cipher_free( &operation->ctx.cmac );
2528 }
2529 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002530#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002531#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002532 if( PSA_ALG_IS_HMAC( operation->alg ) )
2533 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002534 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002535 }
2536 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002537#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002538 {
2539 /* Sanity check (shouldn't happen: operation->alg should
2540 * always have been initialized to a valid value). */
2541 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002542 }
Moran Peker41deec42018-04-04 15:43:05 +03002543
Gilles Peskine8c9def32018-02-08 10:02:12 +01002544 operation->alg = 0;
2545 operation->key_set = 0;
2546 operation->iv_set = 0;
2547 operation->iv_required = 0;
2548 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002549 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002550
Gilles Peskine8c9def32018-02-08 10:02:12 +01002551 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002552
2553bad_state:
2554 /* If abort is called on an uninitialized object, we can't trust
2555 * anything. Wipe the object in case it contains confidential data.
2556 * This may result in a memory leak if a pointer gets overwritten,
2557 * but it's too late to do anything about this. */
2558 memset( operation, 0, sizeof( *operation ) );
2559 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002560}
2561
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002562#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002563static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002564 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002565 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002566 const mbedtls_cipher_info_t *cipher_info )
2567{
2568 int ret;
2569
2570 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002571
2572 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2573 if( ret != 0 )
2574 return( ret );
2575
2576 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2577 slot->data.raw.data,
2578 key_bits );
2579 return( ret );
2580}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002581#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002582
Gilles Peskine248051a2018-06-20 16:09:38 +02002583#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002584static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2585 const uint8_t *key,
2586 size_t key_length,
2587 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002588{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002589 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002590 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002591 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002592 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002593 psa_status_t status;
2594
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002595 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2596 * overflow below. This should never trigger if the hash algorithm
2597 * is implemented correctly. */
2598 /* The size checks against the ipad and opad buffers cannot be written
2599 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2600 * because that triggers -Wlogical-op on GCC 7.3. */
2601 if( block_size > sizeof( ipad ) )
2602 return( PSA_ERROR_NOT_SUPPORTED );
2603 if( block_size > sizeof( hmac->opad ) )
2604 return( PSA_ERROR_NOT_SUPPORTED );
2605 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002606 return( PSA_ERROR_NOT_SUPPORTED );
2607
Gilles Peskined223b522018-06-11 18:12:58 +02002608 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002609 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002610 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002611 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002612 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002613 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002614 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002615 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002616 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002617 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002618 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002619 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002620 }
Gilles Peskine96889972018-07-12 17:07:03 +02002621 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2622 * but it is permitted. It is common when HMAC is used in HKDF, for
2623 * example. Don't call `memcpy` in the 0-length because `key` could be
2624 * an invalid pointer which would make the behavior undefined. */
2625 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002626 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002627
Gilles Peskined223b522018-06-11 18:12:58 +02002628 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2629 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002630 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002631 ipad[i] ^= 0x36;
2632 memset( ipad + key_length, 0x36, block_size - key_length );
2633
2634 /* Copy the key material from ipad to opad, flipping the requisite bits,
2635 * and filling the rest of opad with the requisite constant. */
2636 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002637 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2638 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002639
Gilles Peskine01126fa2018-07-12 17:04:55 +02002640 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002641 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002642 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002643
Gilles Peskine01126fa2018-07-12 17:04:55 +02002644 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002645
2646cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002647 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002648
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002649 return( status );
2650}
Gilles Peskine248051a2018-06-20 16:09:38 +02002651#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002652
Gilles Peskine89167cb2018-07-08 20:12:23 +02002653static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002654 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002655 psa_algorithm_t alg,
2656 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002657{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002659 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002660 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002661 psa_key_usage_t usage =
2662 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002663 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002664 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002666 /* A context must be freshly initialized before it can be set up. */
2667 if( operation->alg != 0 )
2668 {
2669 return( PSA_ERROR_BAD_STATE );
2670 }
2671
Gilles Peskined911eb72018-08-14 15:18:45 +02002672 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002673 if( status != PSA_SUCCESS )
2674 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002675 if( is_sign )
2676 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002677
Gilles Peskine28f8f302019-07-24 13:30:31 +02002678 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002679 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002680 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002681 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002682
Gilles Peskine8c9def32018-02-08 10:02:12 +01002683#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002684 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002685 {
2686 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002687 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002688 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002689 int ret;
2690 if( cipher_info == NULL )
2691 {
2692 status = PSA_ERROR_NOT_SUPPORTED;
2693 goto exit;
2694 }
2695 operation->mac_size = cipher_info->block_size;
2696 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2697 status = mbedtls_to_psa_error( ret );
2698 }
2699 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002700#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002701#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002702 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002703 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002704 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002705 if( hash_alg == 0 )
2706 {
2707 status = PSA_ERROR_NOT_SUPPORTED;
2708 goto exit;
2709 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002710
2711 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2712 /* Sanity check. This shouldn't fail on a valid configuration. */
2713 if( operation->mac_size == 0 ||
2714 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2715 {
2716 status = PSA_ERROR_NOT_SUPPORTED;
2717 goto exit;
2718 }
2719
Gilles Peskine8e338702019-07-30 20:06:31 +02002720 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002721 {
2722 status = PSA_ERROR_INVALID_ARGUMENT;
2723 goto exit;
2724 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002725
Gilles Peskine01126fa2018-07-12 17:04:55 +02002726 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2727 slot->data.raw.data,
2728 slot->data.raw.bytes,
2729 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002730 }
2731 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002732#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002733 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002734 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002735 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002736 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002737
Gilles Peskined911eb72018-08-14 15:18:45 +02002738 if( truncated == 0 )
2739 {
2740 /* The "normal" case: untruncated algorithm. Nothing to do. */
2741 }
2742 else if( truncated < 4 )
2743 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002744 /* A very short MAC is too short for security since it can be
2745 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2746 * so we make this our minimum, even though 32 bits is still
2747 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002748 status = PSA_ERROR_NOT_SUPPORTED;
2749 }
2750 else if( truncated > operation->mac_size )
2751 {
2752 /* It's impossible to "truncate" to a larger length. */
2753 status = PSA_ERROR_INVALID_ARGUMENT;
2754 }
2755 else
2756 operation->mac_size = truncated;
2757
Gilles Peskinefbfac682018-07-08 20:51:54 +02002758exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002759 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002760 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002761 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002762 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002763 else
2764 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002765 operation->key_set = 1;
2766 }
2767 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002768}
2769
Gilles Peskine89167cb2018-07-08 20:12:23 +02002770psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002771 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002772 psa_algorithm_t alg )
2773{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002774 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002775}
2776
2777psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002778 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002779 psa_algorithm_t alg )
2780{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002781 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002782}
2783
Gilles Peskine8c9def32018-02-08 10:02:12 +01002784psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2785 const uint8_t *input,
2786 size_t input_length )
2787{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002788 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002789 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002790 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002791 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002792 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002793 operation->has_input = 1;
2794
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002796 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002797 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002798 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2799 input, input_length );
2800 status = mbedtls_to_psa_error( ret );
2801 }
2802 else
2803#endif /* MBEDTLS_CMAC_C */
2804#if defined(MBEDTLS_MD_C)
2805 if( PSA_ALG_IS_HMAC( operation->alg ) )
2806 {
2807 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2808 input_length );
2809 }
2810 else
2811#endif /* MBEDTLS_MD_C */
2812 {
2813 /* This shouldn't happen if `operation` was initialized by
2814 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002815 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002816 }
2817
Gilles Peskinefbfac682018-07-08 20:51:54 +02002818 if( status != PSA_SUCCESS )
2819 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002820 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002821}
2822
Gilles Peskine01126fa2018-07-12 17:04:55 +02002823#if defined(MBEDTLS_MD_C)
2824static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2825 uint8_t *mac,
2826 size_t mac_size )
2827{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002828 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002829 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2830 size_t hash_size = 0;
2831 size_t block_size = psa_get_hash_block_size( hash_alg );
2832 psa_status_t status;
2833
Gilles Peskine01126fa2018-07-12 17:04:55 +02002834 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2835 if( status != PSA_SUCCESS )
2836 return( status );
2837 /* From here on, tmp needs to be wiped. */
2838
2839 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2840 if( status != PSA_SUCCESS )
2841 goto exit;
2842
2843 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2844 if( status != PSA_SUCCESS )
2845 goto exit;
2846
2847 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2848 if( status != PSA_SUCCESS )
2849 goto exit;
2850
Gilles Peskined911eb72018-08-14 15:18:45 +02002851 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2852 if( status != PSA_SUCCESS )
2853 goto exit;
2854
2855 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002856
2857exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002858 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002859 return( status );
2860}
2861#endif /* MBEDTLS_MD_C */
2862
mohammad16036df908f2018-04-02 08:34:15 -07002863static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002864 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002865 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002866{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002867 if( ! operation->key_set )
2868 return( PSA_ERROR_BAD_STATE );
2869 if( operation->iv_required && ! operation->iv_set )
2870 return( PSA_ERROR_BAD_STATE );
2871
Gilles Peskine8c9def32018-02-08 10:02:12 +01002872 if( mac_size < operation->mac_size )
2873 return( PSA_ERROR_BUFFER_TOO_SMALL );
2874
Gilles Peskine8c9def32018-02-08 10:02:12 +01002875#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002876 if( operation->alg == PSA_ALG_CMAC )
2877 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002878 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2879 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2880 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002881 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002882 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002883 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002884 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002885 else
2886#endif /* MBEDTLS_CMAC_C */
2887#if defined(MBEDTLS_MD_C)
2888 if( PSA_ALG_IS_HMAC( operation->alg ) )
2889 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002890 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002891 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002892 }
2893 else
2894#endif /* MBEDTLS_MD_C */
2895 {
2896 /* This shouldn't happen if `operation` was initialized by
2897 * a setup function. */
2898 return( PSA_ERROR_BAD_STATE );
2899 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002900}
2901
Gilles Peskineacd4be32018-07-08 19:56:25 +02002902psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2903 uint8_t *mac,
2904 size_t mac_size,
2905 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002906{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002907 psa_status_t status;
2908
Jaeden Amero252ef282019-02-15 14:05:35 +00002909 if( operation->alg == 0 )
2910 {
2911 return( PSA_ERROR_BAD_STATE );
2912 }
2913
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002914 /* Fill the output buffer with something that isn't a valid mac
2915 * (barring an attack on the mac and deliberately-crafted input),
2916 * in case the caller doesn't check the return status properly. */
2917 *mac_length = mac_size;
2918 /* If mac_size is 0 then mac may be NULL and then the
2919 * call to memset would have undefined behavior. */
2920 if( mac_size != 0 )
2921 memset( mac, '!', mac_size );
2922
Gilles Peskine89167cb2018-07-08 20:12:23 +02002923 if( ! operation->is_sign )
2924 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002925 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002926 }
mohammad16036df908f2018-04-02 08:34:15 -07002927
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002928 status = psa_mac_finish_internal( operation, mac, mac_size );
2929
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002930 if( status == PSA_SUCCESS )
2931 {
2932 status = psa_mac_abort( operation );
2933 if( status == PSA_SUCCESS )
2934 *mac_length = operation->mac_size;
2935 else
2936 memset( mac, '!', mac_size );
2937 }
2938 else
2939 psa_mac_abort( operation );
2940 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002941}
2942
Gilles Peskineacd4be32018-07-08 19:56:25 +02002943psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2944 const uint8_t *mac,
2945 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002946{
Gilles Peskine828ed142018-06-18 23:25:51 +02002947 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002948 psa_status_t status;
2949
Jaeden Amero252ef282019-02-15 14:05:35 +00002950 if( operation->alg == 0 )
2951 {
2952 return( PSA_ERROR_BAD_STATE );
2953 }
2954
Gilles Peskine89167cb2018-07-08 20:12:23 +02002955 if( operation->is_sign )
2956 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002957 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002958 }
2959 if( operation->mac_size != mac_length )
2960 {
2961 status = PSA_ERROR_INVALID_SIGNATURE;
2962 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002963 }
mohammad16036df908f2018-04-02 08:34:15 -07002964
2965 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002966 actual_mac, sizeof( actual_mac ) );
2967
2968 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2969 status = PSA_ERROR_INVALID_SIGNATURE;
2970
2971cleanup:
2972 if( status == PSA_SUCCESS )
2973 status = psa_mac_abort( operation );
2974 else
2975 psa_mac_abort( operation );
2976
Gilles Peskine3f108122018-12-07 18:14:53 +01002977 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002978
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002979 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002980}
2981
2982
Gilles Peskine20035e32018-02-03 22:44:14 +01002983
Gilles Peskine20035e32018-02-03 22:44:14 +01002984/****************************************************************/
2985/* Asymmetric cryptography */
2986/****************************************************************/
2987
Gilles Peskine2b450e32018-06-27 15:42:46 +02002988#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002989/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002990 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002991static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
2992 size_t hash_length,
2993 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002994{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02002995 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002996 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002997 *md_alg = mbedtls_md_get_type( md_info );
2998
2999 /* The Mbed TLS RSA module uses an unsigned int for hash length
3000 * parameters. Validate that it fits so that we don't risk an
3001 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003002#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003003 if( hash_length > UINT_MAX )
3004 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003005#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003006
3007#if defined(MBEDTLS_PKCS1_V15)
3008 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3009 * must be correct. */
3010 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3011 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003012 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003013 if( md_info == NULL )
3014 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003015 if( mbedtls_md_get_size( md_info ) != hash_length )
3016 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003017 }
3018#endif /* MBEDTLS_PKCS1_V15 */
3019
3020#if defined(MBEDTLS_PKCS1_V21)
3021 /* PSS requires a hash internally. */
3022 if( PSA_ALG_IS_RSA_PSS( alg ) )
3023 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003024 if( md_info == NULL )
3025 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003026 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003027#endif /* MBEDTLS_PKCS1_V21 */
3028
Gilles Peskine61b91d42018-06-08 16:09:36 +02003029 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003030}
3031
Gilles Peskine2b450e32018-06-27 15:42:46 +02003032static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3033 psa_algorithm_t alg,
3034 const uint8_t *hash,
3035 size_t hash_length,
3036 uint8_t *signature,
3037 size_t signature_size,
3038 size_t *signature_length )
3039{
3040 psa_status_t status;
3041 int ret;
3042 mbedtls_md_type_t md_alg;
3043
3044 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3045 if( status != PSA_SUCCESS )
3046 return( status );
3047
Gilles Peskine630a18a2018-06-29 17:49:35 +02003048 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003049 return( PSA_ERROR_BUFFER_TOO_SMALL );
3050
3051#if defined(MBEDTLS_PKCS1_V15)
3052 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3053 {
3054 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3055 MBEDTLS_MD_NONE );
3056 ret = mbedtls_rsa_pkcs1_sign( rsa,
3057 mbedtls_ctr_drbg_random,
3058 &global_data.ctr_drbg,
3059 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003060 md_alg,
3061 (unsigned int) hash_length,
3062 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003063 signature );
3064 }
3065 else
3066#endif /* MBEDTLS_PKCS1_V15 */
3067#if defined(MBEDTLS_PKCS1_V21)
3068 if( PSA_ALG_IS_RSA_PSS( alg ) )
3069 {
3070 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3071 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3072 mbedtls_ctr_drbg_random,
3073 &global_data.ctr_drbg,
3074 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003075 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003076 (unsigned int) hash_length,
3077 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003078 signature );
3079 }
3080 else
3081#endif /* MBEDTLS_PKCS1_V21 */
3082 {
3083 return( PSA_ERROR_INVALID_ARGUMENT );
3084 }
3085
3086 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003087 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003088 return( mbedtls_to_psa_error( ret ) );
3089}
3090
3091static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3092 psa_algorithm_t alg,
3093 const uint8_t *hash,
3094 size_t hash_length,
3095 const uint8_t *signature,
3096 size_t signature_length )
3097{
3098 psa_status_t status;
3099 int ret;
3100 mbedtls_md_type_t md_alg;
3101
3102 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3103 if( status != PSA_SUCCESS )
3104 return( status );
3105
Gilles Peskine630a18a2018-06-29 17:49:35 +02003106 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003107 return( PSA_ERROR_BUFFER_TOO_SMALL );
3108
3109#if defined(MBEDTLS_PKCS1_V15)
3110 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3111 {
3112 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3113 MBEDTLS_MD_NONE );
3114 ret = mbedtls_rsa_pkcs1_verify( rsa,
3115 mbedtls_ctr_drbg_random,
3116 &global_data.ctr_drbg,
3117 MBEDTLS_RSA_PUBLIC,
3118 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003119 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003120 hash,
3121 signature );
3122 }
3123 else
3124#endif /* MBEDTLS_PKCS1_V15 */
3125#if defined(MBEDTLS_PKCS1_V21)
3126 if( PSA_ALG_IS_RSA_PSS( alg ) )
3127 {
3128 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3129 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3130 mbedtls_ctr_drbg_random,
3131 &global_data.ctr_drbg,
3132 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003133 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003134 (unsigned int) hash_length,
3135 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003136 signature );
3137 }
3138 else
3139#endif /* MBEDTLS_PKCS1_V21 */
3140 {
3141 return( PSA_ERROR_INVALID_ARGUMENT );
3142 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003143
3144 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3145 * the rest of the signature is invalid". This has little use in
3146 * practice and PSA doesn't report this distinction. */
3147 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3148 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003149 return( mbedtls_to_psa_error( ret ) );
3150}
3151#endif /* MBEDTLS_RSA_C */
3152
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003153#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003154/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3155 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3156 * (even though these functions don't modify it). */
3157static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3158 psa_algorithm_t alg,
3159 const uint8_t *hash,
3160 size_t hash_length,
3161 uint8_t *signature,
3162 size_t signature_size,
3163 size_t *signature_length )
3164{
3165 int ret;
3166 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003167 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003168 mbedtls_mpi_init( &r );
3169 mbedtls_mpi_init( &s );
3170
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003171 if( signature_size < 2 * curve_bytes )
3172 {
3173 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3174 goto cleanup;
3175 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003176
Gilles Peskinea05219c2018-11-16 16:02:56 +01003177#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003178 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3179 {
3180 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3181 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3182 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3183 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det( &ecp->grp, &r, &s, &ecp->d,
3184 hash, hash_length,
3185 md_alg ) );
3186 }
3187 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003188#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003189 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003190 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003191 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3192 hash, hash_length,
3193 mbedtls_ctr_drbg_random,
3194 &global_data.ctr_drbg ) );
3195 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003196
3197 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3198 signature,
3199 curve_bytes ) );
3200 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3201 signature + curve_bytes,
3202 curve_bytes ) );
3203
3204cleanup:
3205 mbedtls_mpi_free( &r );
3206 mbedtls_mpi_free( &s );
3207 if( ret == 0 )
3208 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003209 return( mbedtls_to_psa_error( ret ) );
3210}
3211
3212static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3213 const uint8_t *hash,
3214 size_t hash_length,
3215 const uint8_t *signature,
3216 size_t signature_length )
3217{
3218 int ret;
3219 mbedtls_mpi r, s;
3220 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3221 mbedtls_mpi_init( &r );
3222 mbedtls_mpi_init( &s );
3223
3224 if( signature_length != 2 * curve_bytes )
3225 return( PSA_ERROR_INVALID_SIGNATURE );
3226
3227 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3228 signature,
3229 curve_bytes ) );
3230 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3231 signature + curve_bytes,
3232 curve_bytes ) );
3233
3234 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3235 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003236
3237cleanup:
3238 mbedtls_mpi_free( &r );
3239 mbedtls_mpi_free( &s );
3240 return( mbedtls_to_psa_error( ret ) );
3241}
3242#endif /* MBEDTLS_ECDSA_C */
3243
Gilles Peskinec5487a82018-12-03 18:08:14 +01003244psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003245 psa_algorithm_t alg,
3246 const uint8_t *hash,
3247 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003248 uint8_t *signature,
3249 size_t signature_size,
3250 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003251{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003252 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003253 psa_status_t status;
3254
3255 *signature_length = signature_size;
3256
Gilles Peskine28f8f302019-07-24 13:30:31 +02003257 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003258 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003259 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003260 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003261 {
3262 status = PSA_ERROR_INVALID_ARGUMENT;
3263 goto exit;
3264 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003265
Gilles Peskine20035e32018-02-03 22:44:14 +01003266#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003267 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003268 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003269 status = psa_rsa_sign( slot->data.rsa,
3270 alg,
3271 hash, hash_length,
3272 signature, signature_size,
3273 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003274 }
3275 else
3276#endif /* defined(MBEDTLS_RSA_C) */
3277#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003278 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003279 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003280#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003281 if(
3282#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3283 PSA_ALG_IS_ECDSA( alg )
3284#else
3285 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3286#endif
3287 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003288 status = psa_ecdsa_sign( slot->data.ecp,
3289 alg,
3290 hash, hash_length,
3291 signature, signature_size,
3292 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003293 else
3294#endif /* defined(MBEDTLS_ECDSA_C) */
3295 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003296 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003297 }
itayzafrir5c753392018-05-08 11:18:38 +03003298 }
3299 else
3300#endif /* defined(MBEDTLS_ECP_C) */
3301 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003302 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003303 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003304
3305exit:
3306 /* Fill the unused part of the output buffer (the whole buffer on error,
3307 * the trailing part on success) with something that isn't a valid mac
3308 * (barring an attack on the mac and deliberately-crafted input),
3309 * in case the caller doesn't check the return status properly. */
3310 if( status == PSA_SUCCESS )
3311 memset( signature + *signature_length, '!',
3312 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003313 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003314 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003315 /* If signature_size is 0 then we have nothing to do. We must not call
3316 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003317 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003318}
3319
Gilles Peskinec5487a82018-12-03 18:08:14 +01003320psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03003321 psa_algorithm_t alg,
3322 const uint8_t *hash,
3323 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02003324 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02003325 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003326{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003327 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003328 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003329
Gilles Peskine28f8f302019-07-24 13:30:31 +02003330 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003331 if( status != PSA_SUCCESS )
3332 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003333
Gilles Peskine61b91d42018-06-08 16:09:36 +02003334#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003335 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003336 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003337 return( psa_rsa_verify( slot->data.rsa,
3338 alg,
3339 hash, hash_length,
3340 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003341 }
3342 else
3343#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003344#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003345 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003346 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003347#if defined(MBEDTLS_ECDSA_C)
3348 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003349 return( psa_ecdsa_verify( slot->data.ecp,
3350 hash, hash_length,
3351 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003352 else
3353#endif /* defined(MBEDTLS_ECDSA_C) */
3354 {
3355 return( PSA_ERROR_INVALID_ARGUMENT );
3356 }
itayzafrir5c753392018-05-08 11:18:38 +03003357 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003358 else
3359#endif /* defined(MBEDTLS_ECP_C) */
3360 {
3361 return( PSA_ERROR_NOT_SUPPORTED );
3362 }
3363}
3364
Gilles Peskine072ac562018-06-30 00:21:29 +02003365#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3366static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3367 mbedtls_rsa_context *rsa )
3368{
3369 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3370 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3371 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3372 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3373}
3374#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3375
Gilles Peskinec5487a82018-12-03 18:08:14 +01003376psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003377 psa_algorithm_t alg,
3378 const uint8_t *input,
3379 size_t input_length,
3380 const uint8_t *salt,
3381 size_t salt_length,
3382 uint8_t *output,
3383 size_t output_size,
3384 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003385{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003386 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003387 psa_status_t status;
3388
Darryl Green5cc689a2018-07-24 15:34:10 +01003389 (void) input;
3390 (void) input_length;
3391 (void) salt;
3392 (void) output;
3393 (void) output_size;
3394
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003395 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003396
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003397 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3398 return( PSA_ERROR_INVALID_ARGUMENT );
3399
Gilles Peskine28f8f302019-07-24 13:30:31 +02003400 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003401 if( status != PSA_SUCCESS )
3402 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003403 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3404 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003405 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003406
3407#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003408 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003409 {
3410 mbedtls_rsa_context *rsa = slot->data.rsa;
3411 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003412 if( output_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine61b91d42018-06-08 16:09:36 +02003413 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003414#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003415 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003416 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003417 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3418 mbedtls_ctr_drbg_random,
3419 &global_data.ctr_drbg,
3420 MBEDTLS_RSA_PUBLIC,
3421 input_length,
3422 input,
3423 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003424 }
3425 else
3426#endif /* MBEDTLS_PKCS1_V15 */
3427#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003428 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003429 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003430 psa_rsa_oaep_set_padding_mode( alg, rsa );
3431 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3432 mbedtls_ctr_drbg_random,
3433 &global_data.ctr_drbg,
3434 MBEDTLS_RSA_PUBLIC,
3435 salt, salt_length,
3436 input_length,
3437 input,
3438 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003439 }
3440 else
3441#endif /* MBEDTLS_PKCS1_V21 */
3442 {
3443 return( PSA_ERROR_INVALID_ARGUMENT );
3444 }
3445 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003446 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003447 return( mbedtls_to_psa_error( ret ) );
3448 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003449 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003450#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003451 {
3452 return( PSA_ERROR_NOT_SUPPORTED );
3453 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003454}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003455
Gilles Peskinec5487a82018-12-03 18:08:14 +01003456psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003457 psa_algorithm_t alg,
3458 const uint8_t *input,
3459 size_t input_length,
3460 const uint8_t *salt,
3461 size_t salt_length,
3462 uint8_t *output,
3463 size_t output_size,
3464 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003465{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003466 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003467 psa_status_t status;
3468
Darryl Green5cc689a2018-07-24 15:34:10 +01003469 (void) input;
3470 (void) input_length;
3471 (void) salt;
3472 (void) output;
3473 (void) output_size;
3474
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003475 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003476
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003477 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3478 return( PSA_ERROR_INVALID_ARGUMENT );
3479
Gilles Peskine28f8f302019-07-24 13:30:31 +02003480 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003481 if( status != PSA_SUCCESS )
3482 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003483 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003484 return( PSA_ERROR_INVALID_ARGUMENT );
3485
3486#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003487 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003488 {
3489 mbedtls_rsa_context *rsa = slot->data.rsa;
3490 int ret;
3491
Gilles Peskine630a18a2018-06-29 17:49:35 +02003492 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003493 return( PSA_ERROR_INVALID_ARGUMENT );
3494
3495#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003496 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003497 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003498 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3499 mbedtls_ctr_drbg_random,
3500 &global_data.ctr_drbg,
3501 MBEDTLS_RSA_PRIVATE,
3502 output_length,
3503 input,
3504 output,
3505 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003506 }
3507 else
3508#endif /* MBEDTLS_PKCS1_V15 */
3509#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003510 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003511 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003512 psa_rsa_oaep_set_padding_mode( alg, rsa );
3513 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3514 mbedtls_ctr_drbg_random,
3515 &global_data.ctr_drbg,
3516 MBEDTLS_RSA_PRIVATE,
3517 salt, salt_length,
3518 output_length,
3519 input,
3520 output,
3521 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003522 }
3523 else
3524#endif /* MBEDTLS_PKCS1_V21 */
3525 {
3526 return( PSA_ERROR_INVALID_ARGUMENT );
3527 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003528
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003529 return( mbedtls_to_psa_error( ret ) );
3530 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003531 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003532#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003533 {
3534 return( PSA_ERROR_NOT_SUPPORTED );
3535 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003536}
Gilles Peskine20035e32018-02-03 22:44:14 +01003537
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003538
3539
mohammad1603503973b2018-03-12 15:59:30 +02003540/****************************************************************/
3541/* Symmetric cryptography */
3542/****************************************************************/
3543
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003544/* Initialize the cipher operation structure. Once this function has been
3545 * called, psa_cipher_abort can run and will do the right thing. */
3546static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3547 psa_algorithm_t alg )
3548{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003549 if( ! PSA_ALG_IS_CIPHER( alg ) )
3550 {
3551 memset( operation, 0, sizeof( *operation ) );
3552 return( PSA_ERROR_INVALID_ARGUMENT );
3553 }
3554
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003555 operation->alg = alg;
3556 operation->key_set = 0;
3557 operation->iv_set = 0;
3558 operation->iv_required = 1;
3559 operation->iv_size = 0;
3560 operation->block_size = 0;
3561 mbedtls_cipher_init( &operation->ctx.cipher );
3562 return( PSA_SUCCESS );
3563}
3564
Gilles Peskinee553c652018-06-04 16:22:46 +02003565static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003566 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003567 psa_algorithm_t alg,
3568 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003569{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003570 int ret = 0;
3571 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003572 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003573 size_t key_bits;
3574 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003575 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3576 PSA_KEY_USAGE_ENCRYPT :
3577 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003578
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003579 /* A context must be freshly initialized before it can be set up. */
3580 if( operation->alg != 0 )
3581 {
3582 return( PSA_ERROR_BAD_STATE );
3583 }
3584
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003585 status = psa_cipher_init( operation, alg );
3586 if( status != PSA_SUCCESS )
3587 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003588
Gilles Peskine28f8f302019-07-24 13:30:31 +02003589 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003590 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003591 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003592 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003593
Gilles Peskine8e338702019-07-30 20:06:31 +02003594 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003595 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003596 {
3597 status = PSA_ERROR_NOT_SUPPORTED;
3598 goto exit;
3599 }
mohammad1603503973b2018-03-12 15:59:30 +02003600
mohammad1603503973b2018-03-12 15:59:30 +02003601 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003602 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003603 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003604
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003605#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003606 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003607 {
3608 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003609 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003610 memcpy( keys, slot->data.raw.data, 16 );
3611 memcpy( keys + 16, slot->data.raw.data, 8 );
3612 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3613 keys,
3614 192, cipher_operation );
3615 }
3616 else
3617#endif
3618 {
3619 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3620 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003621 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003622 }
Moran Peker41deec42018-04-04 15:43:05 +03003623 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003624 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003625
mohammad16038481e742018-03-18 13:57:31 +02003626#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003627 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003628 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003629 case PSA_ALG_CBC_NO_PADDING:
3630 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3631 MBEDTLS_PADDING_NONE );
3632 break;
3633 case PSA_ALG_CBC_PKCS7:
3634 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3635 MBEDTLS_PADDING_PKCS7 );
3636 break;
3637 default:
3638 /* The algorithm doesn't involve padding. */
3639 ret = 0;
3640 break;
3641 }
3642 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003643 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003644#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3645
mohammad1603503973b2018-03-12 15:59:30 +02003646 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003647 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003648 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003649 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003650 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003651 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003652 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003653#if defined(MBEDTLS_CHACHA20_C)
3654 else
3655 if( alg == PSA_ALG_CHACHA20 )
3656 operation->iv_size = 12;
3657#endif
mohammad1603503973b2018-03-12 15:59:30 +02003658
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003659exit:
3660 if( status == 0 )
3661 status = mbedtls_to_psa_error( ret );
3662 if( status != 0 )
3663 psa_cipher_abort( operation );
3664 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003665}
3666
Gilles Peskinefe119512018-07-08 21:39:34 +02003667psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003668 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003669 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003670{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003671 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003672}
3673
Gilles Peskinefe119512018-07-08 21:39:34 +02003674psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003675 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003676 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003677{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003678 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003679}
3680
Gilles Peskinefe119512018-07-08 21:39:34 +02003681psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003682 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003683 size_t iv_size,
3684 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003685{
itayzafrir534bd7c2018-08-02 13:56:32 +03003686 psa_status_t status;
3687 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003688 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003689 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003690 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003691 }
Moran Peker41deec42018-04-04 15:43:05 +03003692 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003693 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003694 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003695 goto exit;
3696 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003697 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3698 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003699 if( ret != 0 )
3700 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003701 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003702 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003703 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003704
mohammad16038481e742018-03-18 13:57:31 +02003705 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003706 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003707
Moran Peker395db872018-05-31 14:07:14 +03003708exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003709 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003710 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003711 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003712}
3713
Gilles Peskinefe119512018-07-08 21:39:34 +02003714psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003715 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003716 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003717{
itayzafrir534bd7c2018-08-02 13:56:32 +03003718 psa_status_t status;
3719 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003720 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003721 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003722 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003723 }
Moran Pekera28258c2018-05-29 16:25:04 +03003724 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003725 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003726 status = PSA_ERROR_INVALID_ARGUMENT;
3727 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003728 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003729 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3730 status = mbedtls_to_psa_error( ret );
3731exit:
3732 if( status == PSA_SUCCESS )
3733 operation->iv_set = 1;
3734 else
mohammad1603503973b2018-03-12 15:59:30 +02003735 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003736 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003737}
3738
Gilles Peskinee553c652018-06-04 16:22:46 +02003739psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3740 const uint8_t *input,
3741 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003742 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003743 size_t output_size,
3744 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003745{
itayzafrir534bd7c2018-08-02 13:56:32 +03003746 psa_status_t status;
3747 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003748 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003749
3750 if( operation->alg == 0 )
3751 {
3752 return( PSA_ERROR_BAD_STATE );
3753 }
3754
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003755 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003756 {
3757 /* Take the unprocessed partial block left over from previous
3758 * update calls, if any, plus the input to this call. Remove
3759 * the last partial block, if any. You get the data that will be
3760 * output in this call. */
3761 expected_output_size =
3762 ( operation->ctx.cipher.unprocessed_len + input_length )
3763 / operation->block_size * operation->block_size;
3764 }
3765 else
3766 {
3767 expected_output_size = input_length;
3768 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003769
Gilles Peskine89d789c2018-06-04 17:17:16 +02003770 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003771 {
3772 status = PSA_ERROR_BUFFER_TOO_SMALL;
3773 goto exit;
3774 }
mohammad160382759612018-03-12 18:16:40 +02003775
mohammad1603503973b2018-03-12 15:59:30 +02003776 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003777 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003778 status = mbedtls_to_psa_error( ret );
3779exit:
3780 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003781 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003782 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003783}
3784
Gilles Peskinee553c652018-06-04 16:22:46 +02003785psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3786 uint8_t *output,
3787 size_t output_size,
3788 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003789{
David Saadab4ecc272019-02-14 13:48:10 +02003790 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003791 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003792 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003793
mohammad1603503973b2018-03-12 15:59:30 +02003794 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003795 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003796 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003797 }
3798 if( operation->iv_required && ! operation->iv_set )
3799 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003800 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003801 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003802
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003803 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003804 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3805 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003806 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003807 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003808 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003809 }
3810
Janos Follath315b51c2018-07-09 16:04:51 +01003811 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3812 temp_output_buffer,
3813 output_length );
3814 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003815 {
Janos Follath315b51c2018-07-09 16:04:51 +01003816 status = mbedtls_to_psa_error( cipher_ret );
3817 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003818 }
Janos Follath315b51c2018-07-09 16:04:51 +01003819
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003820 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003821 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003822 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003823 memcpy( output, temp_output_buffer, *output_length );
3824 else
3825 {
Janos Follath315b51c2018-07-09 16:04:51 +01003826 status = PSA_ERROR_BUFFER_TOO_SMALL;
3827 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003828 }
mohammad1603503973b2018-03-12 15:59:30 +02003829
Gilles Peskine3f108122018-12-07 18:14:53 +01003830 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003831 status = psa_cipher_abort( operation );
3832
3833 return( status );
3834
3835error:
3836
3837 *output_length = 0;
3838
Gilles Peskine3f108122018-12-07 18:14:53 +01003839 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003840 (void) psa_cipher_abort( operation );
3841
3842 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003843}
3844
Gilles Peskinee553c652018-06-04 16:22:46 +02003845psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3846{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003847 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003848 {
3849 /* The object has (apparently) been initialized but it is not
3850 * in use. It's ok to call abort on such an object, and there's
3851 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003852 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003853 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003854
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003855 /* Sanity check (shouldn't happen: operation->alg should
3856 * always have been initialized to a valid value). */
3857 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3858 return( PSA_ERROR_BAD_STATE );
3859
mohammad1603503973b2018-03-12 15:59:30 +02003860 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003861
Moran Peker41deec42018-04-04 15:43:05 +03003862 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003863 operation->key_set = 0;
3864 operation->iv_set = 0;
3865 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003866 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003867 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003868
Moran Peker395db872018-05-31 14:07:14 +03003869 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003870}
3871
Gilles Peskinea0655c32018-04-30 17:06:50 +02003872
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003873
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003874
mohammad16035955c982018-04-26 00:53:03 +03003875/****************************************************************/
3876/* AEAD */
3877/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003878
Gilles Peskineedf9a652018-08-17 18:11:56 +02003879typedef struct
3880{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003881 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003882 const mbedtls_cipher_info_t *cipher_info;
3883 union
3884 {
3885#if defined(MBEDTLS_CCM_C)
3886 mbedtls_ccm_context ccm;
3887#endif /* MBEDTLS_CCM_C */
3888#if defined(MBEDTLS_GCM_C)
3889 mbedtls_gcm_context gcm;
3890#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003891#if defined(MBEDTLS_CHACHAPOLY_C)
3892 mbedtls_chachapoly_context chachapoly;
3893#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003894 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003895 psa_algorithm_t core_alg;
3896 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003897 uint8_t tag_length;
3898} aead_operation_t;
3899
Gilles Peskine30a9e412019-01-14 18:36:12 +01003900static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003901{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003902 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003903 {
3904#if defined(MBEDTLS_CCM_C)
3905 case PSA_ALG_CCM:
3906 mbedtls_ccm_free( &operation->ctx.ccm );
3907 break;
3908#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003909#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003910 case PSA_ALG_GCM:
3911 mbedtls_gcm_free( &operation->ctx.gcm );
3912 break;
3913#endif /* MBEDTLS_GCM_C */
3914 }
3915}
3916
3917static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003918 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003919 psa_key_usage_t usage,
3920 psa_algorithm_t alg )
3921{
3922 psa_status_t status;
3923 size_t key_bits;
3924 mbedtls_cipher_id_t cipher_id;
3925
Gilles Peskine28f8f302019-07-24 13:30:31 +02003926 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003927 if( status != PSA_SUCCESS )
3928 return( status );
3929
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003930 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003931
3932 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02003933 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003934 &cipher_id );
3935 if( operation->cipher_info == NULL )
3936 return( PSA_ERROR_NOT_SUPPORTED );
3937
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003938 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003939 {
3940#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003941 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
3942 operation->core_alg = PSA_ALG_CCM;
3943 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003944 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3945 * The call to mbedtls_ccm_encrypt_and_tag or
3946 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02003947 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003948 return( PSA_ERROR_INVALID_ARGUMENT );
3949 mbedtls_ccm_init( &operation->ctx.ccm );
3950 status = mbedtls_to_psa_error(
3951 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
3952 operation->slot->data.raw.data,
3953 (unsigned int) key_bits ) );
3954 if( status != 0 )
3955 goto cleanup;
3956 break;
3957#endif /* MBEDTLS_CCM_C */
3958
3959#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003960 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
3961 operation->core_alg = PSA_ALG_GCM;
3962 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003963 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3964 * The call to mbedtls_gcm_crypt_and_tag or
3965 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02003966 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003967 return( PSA_ERROR_INVALID_ARGUMENT );
3968 mbedtls_gcm_init( &operation->ctx.gcm );
3969 status = mbedtls_to_psa_error(
3970 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
3971 operation->slot->data.raw.data,
3972 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003973 if( status != 0 )
3974 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003975 break;
3976#endif /* MBEDTLS_GCM_C */
3977
Gilles Peskine26869f22019-05-06 15:25:00 +02003978#if defined(MBEDTLS_CHACHAPOLY_C)
3979 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
3980 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
3981 operation->full_tag_length = 16;
3982 /* We only support the default tag length. */
3983 if( alg != PSA_ALG_CHACHA20_POLY1305 )
3984 return( PSA_ERROR_NOT_SUPPORTED );
3985 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
3986 status = mbedtls_to_psa_error(
3987 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
3988 operation->slot->data.raw.data ) );
3989 if( status != 0 )
3990 goto cleanup;
3991 break;
3992#endif /* MBEDTLS_CHACHAPOLY_C */
3993
Gilles Peskineedf9a652018-08-17 18:11:56 +02003994 default:
3995 return( PSA_ERROR_NOT_SUPPORTED );
3996 }
3997
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003998 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
3999 {
4000 status = PSA_ERROR_INVALID_ARGUMENT;
4001 goto cleanup;
4002 }
4003 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004004
Gilles Peskineedf9a652018-08-17 18:11:56 +02004005 return( PSA_SUCCESS );
4006
4007cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004008 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004009 return( status );
4010}
4011
Gilles Peskinec5487a82018-12-03 18:08:14 +01004012psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004013 psa_algorithm_t alg,
4014 const uint8_t *nonce,
4015 size_t nonce_length,
4016 const uint8_t *additional_data,
4017 size_t additional_data_length,
4018 const uint8_t *plaintext,
4019 size_t plaintext_length,
4020 uint8_t *ciphertext,
4021 size_t ciphertext_size,
4022 size_t *ciphertext_length )
4023{
mohammad16035955c982018-04-26 00:53:03 +03004024 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004025 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004026 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004027
mohammad1603f08a5502018-06-03 15:05:47 +03004028 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004029
Gilles Peskinec5487a82018-12-03 18:08:14 +01004030 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004031 if( status != PSA_SUCCESS )
4032 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004033
Gilles Peskineedf9a652018-08-17 18:11:56 +02004034 /* For all currently supported modes, the tag is at the end of the
4035 * ciphertext. */
4036 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4037 {
4038 status = PSA_ERROR_BUFFER_TOO_SMALL;
4039 goto exit;
4040 }
4041 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004042
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004043#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004044 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004045 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004046 status = mbedtls_to_psa_error(
4047 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4048 MBEDTLS_GCM_ENCRYPT,
4049 plaintext_length,
4050 nonce, nonce_length,
4051 additional_data, additional_data_length,
4052 plaintext, ciphertext,
4053 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004054 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004055 else
4056#endif /* MBEDTLS_GCM_C */
4057#if defined(MBEDTLS_CCM_C)
4058 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004059 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004060 status = mbedtls_to_psa_error(
4061 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4062 plaintext_length,
4063 nonce, nonce_length,
4064 additional_data,
4065 additional_data_length,
4066 plaintext, ciphertext,
4067 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004068 }
mohammad16035c8845f2018-05-09 05:40:09 -07004069 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004070#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004071#if defined(MBEDTLS_CHACHAPOLY_C)
4072 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4073 {
4074 if( nonce_length != 12 || operation.tag_length != 16 )
4075 {
4076 status = PSA_ERROR_NOT_SUPPORTED;
4077 goto exit;
4078 }
4079 status = mbedtls_to_psa_error(
4080 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4081 plaintext_length,
4082 nonce,
4083 additional_data,
4084 additional_data_length,
4085 plaintext,
4086 ciphertext,
4087 tag ) );
4088 }
4089 else
4090#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004091 {
mohammad1603554faad2018-06-03 15:07:38 +03004092 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004093 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004094
Gilles Peskineedf9a652018-08-17 18:11:56 +02004095 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4096 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004097
Gilles Peskineedf9a652018-08-17 18:11:56 +02004098exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004099 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004100 if( status == PSA_SUCCESS )
4101 *ciphertext_length = plaintext_length + operation.tag_length;
4102 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004103}
4104
Gilles Peskineee652a32018-06-01 19:23:52 +02004105/* Locate the tag in a ciphertext buffer containing the encrypted data
4106 * followed by the tag. Return the length of the part preceding the tag in
4107 * *plaintext_length. This is the size of the plaintext in modes where
4108 * the encrypted data has the same size as the plaintext, such as
4109 * CCM and GCM. */
4110static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4111 const uint8_t *ciphertext,
4112 size_t ciphertext_length,
4113 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004114 const uint8_t **p_tag )
4115{
4116 size_t payload_length;
4117 if( tag_length > ciphertext_length )
4118 return( PSA_ERROR_INVALID_ARGUMENT );
4119 payload_length = ciphertext_length - tag_length;
4120 if( payload_length > plaintext_size )
4121 return( PSA_ERROR_BUFFER_TOO_SMALL );
4122 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004123 return( PSA_SUCCESS );
4124}
4125
Gilles Peskinec5487a82018-12-03 18:08:14 +01004126psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004127 psa_algorithm_t alg,
4128 const uint8_t *nonce,
4129 size_t nonce_length,
4130 const uint8_t *additional_data,
4131 size_t additional_data_length,
4132 const uint8_t *ciphertext,
4133 size_t ciphertext_length,
4134 uint8_t *plaintext,
4135 size_t plaintext_size,
4136 size_t *plaintext_length )
4137{
mohammad16035955c982018-04-26 00:53:03 +03004138 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004139 aead_operation_t operation;
4140 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004141
Gilles Peskineee652a32018-06-01 19:23:52 +02004142 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004143
Gilles Peskinec5487a82018-12-03 18:08:14 +01004144 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004145 if( status != PSA_SUCCESS )
4146 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004147
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004148 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4149 ciphertext, ciphertext_length,
4150 plaintext_size, &tag );
4151 if( status != PSA_SUCCESS )
4152 goto exit;
4153
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004154#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004155 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004156 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004157 status = mbedtls_to_psa_error(
4158 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4159 ciphertext_length - operation.tag_length,
4160 nonce, nonce_length,
4161 additional_data,
4162 additional_data_length,
4163 tag, operation.tag_length,
4164 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004165 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004166 else
4167#endif /* MBEDTLS_GCM_C */
4168#if defined(MBEDTLS_CCM_C)
4169 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004170 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004171 status = mbedtls_to_psa_error(
4172 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4173 ciphertext_length - operation.tag_length,
4174 nonce, nonce_length,
4175 additional_data,
4176 additional_data_length,
4177 ciphertext, plaintext,
4178 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004179 }
mohammad160339574652018-06-01 04:39:53 -07004180 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004181#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004182#if defined(MBEDTLS_CHACHAPOLY_C)
4183 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4184 {
4185 if( nonce_length != 12 || operation.tag_length != 16 )
4186 {
4187 status = PSA_ERROR_NOT_SUPPORTED;
4188 goto exit;
4189 }
4190 status = mbedtls_to_psa_error(
4191 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4192 ciphertext_length - operation.tag_length,
4193 nonce,
4194 additional_data,
4195 additional_data_length,
4196 tag,
4197 ciphertext,
4198 plaintext ) );
4199 }
4200 else
4201#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004202 {
mohammad1603554faad2018-06-03 15:07:38 +03004203 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004204 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004205
Gilles Peskineedf9a652018-08-17 18:11:56 +02004206 if( status != PSA_SUCCESS && plaintext_size != 0 )
4207 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004208
Gilles Peskineedf9a652018-08-17 18:11:56 +02004209exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004210 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004211 if( status == PSA_SUCCESS )
4212 *plaintext_length = ciphertext_length - operation.tag_length;
4213 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004214}
4215
Gilles Peskinea0655c32018-04-30 17:06:50 +02004216
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004217
Gilles Peskine20035e32018-02-03 22:44:14 +01004218/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004219/* Generators */
4220/****************************************************************/
4221
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004222#define HKDF_STATE_INIT 0 /* no input yet */
4223#define HKDF_STATE_STARTED 1 /* got salt */
4224#define HKDF_STATE_KEYED 2 /* got key */
4225#define HKDF_STATE_OUTPUT 3 /* output started */
4226
Gilles Peskinecbe66502019-05-16 16:59:18 +02004227static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004228 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004229{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004230 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4231 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004232 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004233 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004234}
4235
4236
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004237psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004238{
4239 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004240 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004241 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004242 {
4243 /* The object has (apparently) been initialized but it is not
4244 * in use. It's ok to call abort on such an object, and there's
4245 * nothing to do. */
4246 }
4247 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004248#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004249 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004250 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004251 mbedtls_free( operation->ctx.hkdf.info );
4252 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004253 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004254 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004255 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004256 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004257 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004258#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004259 if( operation->ctx.tls12_prf.key != NULL )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004260 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004261 mbedtls_platform_zeroize( operation->ctx.tls12_prf.key,
4262 operation->ctx.tls12_prf.key_len );
4263 mbedtls_free( operation->ctx.tls12_prf.key );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004264 }
Hanno Becker580fba12018-11-13 20:50:45 +00004265
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004266 if( operation->ctx.tls12_prf.Ai_with_seed != NULL )
Hanno Becker580fba12018-11-13 20:50:45 +00004267 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004268 mbedtls_platform_zeroize( operation->ctx.tls12_prf.Ai_with_seed,
4269 operation->ctx.tls12_prf.Ai_with_seed_len );
4270 mbedtls_free( operation->ctx.tls12_prf.Ai_with_seed );
Hanno Becker580fba12018-11-13 20:50:45 +00004271 }
Janos Follath6a1d2622019-06-11 10:37:28 +01004272#else
4273 if( operation->ctx.tls12_prf.seed != NULL )
4274 {
4275 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4276 operation->ctx.tls12_prf.seed_length );
4277 mbedtls_free( operation->ctx.tls12_prf.seed );
4278 }
4279
4280 if( operation->ctx.tls12_prf.label != NULL )
4281 {
4282 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4283 operation->ctx.tls12_prf.label_length );
4284 mbedtls_free( operation->ctx.tls12_prf.label );
4285 }
4286
4287 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4288
4289 /* We leave the fields Ai and output_block to be erased safely by the
4290 * mbedtls_platform_zeroize() in the end of this function. */
Janos Follath999f6482019-06-11 12:04:10 +01004291#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004292 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004293 else
4294#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004295 {
4296 status = PSA_ERROR_BAD_STATE;
4297 }
Janos Follath083036a2019-06-11 10:22:26 +01004298 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004299 return( status );
4300}
4301
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004302psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004303 size_t *capacity)
4304{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004305 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004306 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004307 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004308 return PSA_ERROR_BAD_STATE;
4309 }
4310
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004311 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004312 return( PSA_SUCCESS );
4313}
4314
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004315psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004316 size_t capacity )
4317{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004318 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004319 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004320 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004321 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004322 operation->capacity = capacity;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004323 return( PSA_SUCCESS );
4324}
4325
Gilles Peskinebef7f142018-07-12 17:22:21 +02004326#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004327/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004328 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004329static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004330 psa_algorithm_t hash_alg,
4331 uint8_t *output,
4332 size_t output_length )
4333{
4334 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4335 psa_status_t status;
4336
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004337 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4338 return( PSA_ERROR_BAD_STATE );
4339 hkdf->state = HKDF_STATE_OUTPUT;
4340
Gilles Peskinebef7f142018-07-12 17:22:21 +02004341 while( output_length != 0 )
4342 {
4343 /* Copy what remains of the current block */
4344 uint8_t n = hash_length - hkdf->offset_in_block;
4345 if( n > output_length )
4346 n = (uint8_t) output_length;
4347 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4348 output += n;
4349 output_length -= n;
4350 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004351 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004352 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004353 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004354 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004355 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004356 * object was corrupted or if this function is called directly
4357 * inside the library. */
4358 if( hkdf->block_number == 0xff )
4359 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004360
4361 /* We need a new block */
4362 ++hkdf->block_number;
4363 hkdf->offset_in_block = 0;
4364 status = psa_hmac_setup_internal( &hkdf->hmac,
4365 hkdf->prk, hash_length,
4366 hash_alg );
4367 if( status != PSA_SUCCESS )
4368 return( status );
4369 if( hkdf->block_number != 1 )
4370 {
4371 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4372 hkdf->output_block,
4373 hash_length );
4374 if( status != PSA_SUCCESS )
4375 return( status );
4376 }
4377 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4378 hkdf->info,
4379 hkdf->info_length );
4380 if( status != PSA_SUCCESS )
4381 return( status );
4382 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4383 &hkdf->block_number, 1 );
4384 if( status != PSA_SUCCESS )
4385 return( status );
4386 status = psa_hmac_finish_internal( &hkdf->hmac,
4387 hkdf->output_block,
4388 sizeof( hkdf->output_block ) );
4389 if( status != PSA_SUCCESS )
4390 return( status );
4391 }
4392
4393 return( PSA_SUCCESS );
4394}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004395
Janos Follath999f6482019-06-11 12:04:10 +01004396#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004397static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4398 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004399 psa_algorithm_t alg )
4400{
4401 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4402 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4403 psa_hmac_internal_data hmac;
4404 psa_status_t status, cleanup_status;
4405
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004406 uint8_t *Ai;
Hanno Becker3b339e22018-11-13 20:56:14 +00004407 size_t Ai_len;
4408
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004409 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004410 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004411 * prevented this call. It could happen only if the operation
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004412 * object was corrupted or if this function is called directly
4413 * inside the library. */
4414 if( tls12_prf->block_number == 0xff )
4415 return( PSA_ERROR_BAD_STATE );
4416
4417 /* We need a new block */
4418 ++tls12_prf->block_number;
4419 tls12_prf->offset_in_block = 0;
4420
4421 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4422 *
4423 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4424 *
4425 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4426 * HMAC_hash(secret, A(2) + seed) +
4427 * HMAC_hash(secret, A(3) + seed) + ...
4428 *
4429 * A(0) = seed
4430 * A(i) = HMAC_hash( secret, A(i-1) )
4431 *
Gilles Peskinecbe66502019-05-16 16:59:18 +02004432 * The `psa_tls12_prf_key_derivation` structures saves the block
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004433 * `HMAC_hash(secret, A(i) + seed)` from which the output
4434 * is currently extracted as `output_block`, while
4435 * `A(i) + seed` is stored in `Ai_with_seed`.
4436 *
4437 * Generating a new block means recalculating `Ai_with_seed`
4438 * from the A(i)-part of it, and afterwards recalculating
4439 * `output_block`.
4440 *
4441 * A(0) is computed at setup time.
4442 *
4443 */
4444
4445 psa_hmac_init_internal( &hmac );
4446
4447 /* We must distinguish the calculation of A(1) from those
4448 * of A(2) and higher, because A(0)=seed has a different
4449 * length than the other A(i). */
4450 if( tls12_prf->block_number == 1 )
4451 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004452 Ai = tls12_prf->Ai_with_seed + hash_length;
4453 Ai_len = tls12_prf->Ai_with_seed_len - hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004454 }
4455 else
4456 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004457 Ai = tls12_prf->Ai_with_seed;
4458 Ai_len = hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004459 }
4460
Hanno Becker3b339e22018-11-13 20:56:14 +00004461 /* Compute A(i+1) = HMAC_hash(secret, A(i)) */
4462 status = psa_hmac_setup_internal( &hmac,
4463 tls12_prf->key,
4464 tls12_prf->key_len,
4465 hash_alg );
4466 if( status != PSA_SUCCESS )
4467 goto cleanup;
4468
4469 status = psa_hash_update( &hmac.hash_ctx,
4470 Ai, Ai_len );
4471 if( status != PSA_SUCCESS )
4472 goto cleanup;
4473
4474 status = psa_hmac_finish_internal( &hmac,
4475 tls12_prf->Ai_with_seed,
4476 hash_length );
4477 if( status != PSA_SUCCESS )
4478 goto cleanup;
4479
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004480 /* Compute the next block `HMAC_hash(secret, A(i+1) + seed)`. */
4481 status = psa_hmac_setup_internal( &hmac,
4482 tls12_prf->key,
4483 tls12_prf->key_len,
4484 hash_alg );
4485 if( status != PSA_SUCCESS )
4486 goto cleanup;
4487
4488 status = psa_hash_update( &hmac.hash_ctx,
4489 tls12_prf->Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00004490 tls12_prf->Ai_with_seed_len );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004491 if( status != PSA_SUCCESS )
4492 goto cleanup;
4493
4494 status = psa_hmac_finish_internal( &hmac,
4495 tls12_prf->output_block,
4496 hash_length );
4497 if( status != PSA_SUCCESS )
4498 goto cleanup;
4499
4500cleanup:
4501
4502 cleanup_status = psa_hmac_abort_internal( &hmac );
4503 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4504 status = cleanup_status;
4505
4506 return( status );
4507}
Janos Follath7742fee2019-06-17 12:58:10 +01004508#else
4509static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4510 psa_tls12_prf_key_derivation_t *tls12_prf,
4511 psa_algorithm_t alg )
4512{
4513 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4514 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004515 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4516 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004517
Janos Follath7742fee2019-06-17 12:58:10 +01004518 /* We can't be wanting more output after block 0xff, otherwise
4519 * the capacity check in psa_key_derivation_output_bytes() would have
4520 * prevented this call. It could happen only if the operation
4521 * object was corrupted or if this function is called directly
4522 * inside the library. */
4523 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004524 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004525
4526 /* We need a new block */
4527 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004528 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004529
4530 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4531 *
4532 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4533 *
4534 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4535 * HMAC_hash(secret, A(2) + seed) +
4536 * HMAC_hash(secret, A(3) + seed) + ...
4537 *
4538 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004539 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004540 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004541 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004542 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004543 * is currently extracted as `output_block` and where i is
4544 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004545 */
4546
Janos Follathea29bfb2019-06-19 12:21:20 +01004547 /* Save the hash context before using it, to preserve the hash state with
4548 * only the inner padding in it. We need this, because inner padding depends
4549 * on the key (secret in the RFC's terminology). */
4550 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4551 if( status != PSA_SUCCESS )
4552 goto cleanup;
4553
4554 /* Calculate A(i) where i = tls12_prf->block_number. */
4555 if( tls12_prf->block_number == 1 )
4556 {
4557 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4558 * the variable seed and in this instance means it in the context of the
4559 * P_hash function, where seed = label + seed.) */
4560 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4561 tls12_prf->label, tls12_prf->label_length );
4562 if( status != PSA_SUCCESS )
4563 goto cleanup;
4564 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4565 tls12_prf->seed, tls12_prf->seed_length );
4566 if( status != PSA_SUCCESS )
4567 goto cleanup;
4568 }
4569 else
4570 {
4571 /* A(i) = HMAC_hash(secret, A(i-1)) */
4572 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4573 tls12_prf->Ai, hash_length );
4574 if( status != PSA_SUCCESS )
4575 goto cleanup;
4576 }
4577
4578 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4579 tls12_prf->Ai, hash_length );
4580 if( status != PSA_SUCCESS )
4581 goto cleanup;
4582 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4583 if( status != PSA_SUCCESS )
4584 goto cleanup;
4585
4586 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4587 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4588 tls12_prf->Ai, hash_length );
4589 if( status != PSA_SUCCESS )
4590 goto cleanup;
4591 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4592 tls12_prf->label, tls12_prf->label_length );
4593 if( status != PSA_SUCCESS )
4594 goto cleanup;
4595 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4596 tls12_prf->seed, tls12_prf->seed_length );
4597 if( status != PSA_SUCCESS )
4598 goto cleanup;
4599 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4600 tls12_prf->output_block, hash_length );
4601 if( status != PSA_SUCCESS )
4602 goto cleanup;
4603 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4604 if( status != PSA_SUCCESS )
4605 goto cleanup;
4606
Janos Follath7742fee2019-06-17 12:58:10 +01004607
4608cleanup:
4609
Janos Follathea29bfb2019-06-19 12:21:20 +01004610 cleanup_status = psa_hash_abort( &backup );
4611 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4612 status = cleanup_status;
4613
4614 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004615}
Janos Follath999f6482019-06-11 12:04:10 +01004616#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004617
Janos Follath999f6482019-06-11 12:04:10 +01004618#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004619/* Read some bytes from an TLS-1.2-PRF-based operation.
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004620 * See Section 5 of RFC 5246. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004621static psa_status_t psa_key_derivation_tls12_prf_read(
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004622 psa_tls12_prf_key_derivation_t *tls12_prf,
4623 psa_algorithm_t alg,
4624 uint8_t *output,
4625 size_t output_length )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004626{
4627 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4628 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4629 psa_status_t status;
4630
4631 while( output_length != 0 )
4632 {
4633 /* Copy what remains of the current block */
4634 uint8_t n = hash_length - tls12_prf->offset_in_block;
4635
4636 /* Check if we have fully processed the current block. */
4637 if( n == 0 )
4638 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004639 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004640 alg );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004641 if( status != PSA_SUCCESS )
4642 return( status );
4643
4644 continue;
4645 }
4646
4647 if( n > output_length )
4648 n = (uint8_t) output_length;
4649 memcpy( output, tls12_prf->output_block + tls12_prf->offset_in_block,
4650 n );
4651 output += n;
4652 output_length -= n;
4653 tls12_prf->offset_in_block += n;
4654 }
4655
4656 return( PSA_SUCCESS );
4657}
Janos Follath844eb0e2019-06-19 12:10:49 +01004658#else
4659static psa_status_t psa_key_derivation_tls12_prf_read(
4660 psa_tls12_prf_key_derivation_t *tls12_prf,
4661 psa_algorithm_t alg,
4662 uint8_t *output,
4663 size_t output_length )
4664{
4665 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4666 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4667 psa_status_t status;
4668 uint8_t offset, length;
4669
4670 while( output_length != 0 )
4671 {
4672 /* Check if we have fully processed the current block. */
4673 if( tls12_prf->left_in_block == 0 )
4674 {
4675 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4676 alg );
4677 if( status != PSA_SUCCESS )
4678 return( status );
4679
4680 continue;
4681 }
4682
4683 if( tls12_prf->left_in_block > output_length )
4684 length = (uint8_t) output_length;
4685 else
4686 length = tls12_prf->left_in_block;
4687
4688 offset = hash_length - tls12_prf->left_in_block;
4689 memcpy( output, tls12_prf->output_block + offset, length );
4690 output += length;
4691 output_length -= length;
4692 tls12_prf->left_in_block -= length;
4693 }
4694
4695 return( PSA_SUCCESS );
4696}
Janos Follath999f6482019-06-11 12:04:10 +01004697#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004698#endif /* MBEDTLS_MD_C */
4699
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004700psa_status_t psa_key_derivation_output_bytes(
4701 psa_key_derivation_operation_t *operation,
4702 uint8_t *output,
4703 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004704{
4705 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004706 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004707
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004708 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004709 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004710 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004711 return PSA_ERROR_BAD_STATE;
4712 }
4713
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004714 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004715 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004716 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004717 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004718 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004719 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004720 goto exit;
4721 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004722 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004723 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004724 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004725 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004726 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4727 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004728 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004729 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004730 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004731 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004732 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004733
Gilles Peskinebef7f142018-07-12 17:22:21 +02004734#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004735 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004736 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004737 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004738 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004739 output, output_length );
4740 }
Janos Follathadbec812019-06-14 11:05:39 +01004741 else
Janos Follathadbec812019-06-14 11:05:39 +01004742 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004743 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004744 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004745 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004746 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004747 output_length );
4748 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004749 else
4750#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004751 {
4752 return( PSA_ERROR_BAD_STATE );
4753 }
4754
4755exit:
4756 if( status != PSA_SUCCESS )
4757 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004758 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004759 * This allows us to differentiate between exhausted operations and
4760 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4761 * operations. */
4762 psa_algorithm_t alg = operation->alg;
4763 psa_key_derivation_abort( operation );
4764 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004765 memset( output, '!', output_length );
4766 }
4767 return( status );
4768}
4769
Gilles Peskine08542d82018-07-19 17:05:42 +02004770#if defined(MBEDTLS_DES_C)
4771static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4772{
4773 if( data_size >= 8 )
4774 mbedtls_des_key_set_parity( data );
4775 if( data_size >= 16 )
4776 mbedtls_des_key_set_parity( data + 8 );
4777 if( data_size >= 24 )
4778 mbedtls_des_key_set_parity( data + 16 );
4779}
4780#endif /* MBEDTLS_DES_C */
4781
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004782static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004783 psa_key_slot_t *slot,
4784 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004785 psa_key_derivation_operation_t *operation )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004786{
4787 uint8_t *data = NULL;
4788 size_t bytes = PSA_BITS_TO_BYTES( bits );
4789 psa_status_t status;
4790
Gilles Peskine8e338702019-07-30 20:06:31 +02004791 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004792 return( PSA_ERROR_INVALID_ARGUMENT );
4793 if( bits % 8 != 0 )
4794 return( PSA_ERROR_INVALID_ARGUMENT );
4795 data = mbedtls_calloc( 1, bytes );
4796 if( data == NULL )
4797 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4798
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004799 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004800 if( status != PSA_SUCCESS )
4801 goto exit;
4802#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004803 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004804 psa_des_set_key_parity( data, bytes );
4805#endif /* MBEDTLS_DES_C */
4806 status = psa_import_key_into_slot( slot, data, bytes );
4807
4808exit:
4809 mbedtls_free( data );
4810 return( status );
4811}
4812
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004813psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004814 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004815 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004816{
4817 psa_status_t status;
4818 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004819 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine011e4282019-06-26 18:34:38 +02004820 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004821#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4822 if( driver != NULL )
4823 {
4824 /* Deriving a key in a secure element is not implemented yet. */
4825 status = PSA_ERROR_NOT_SUPPORTED;
4826 }
4827#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004828 if( status == PSA_SUCCESS )
4829 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004830 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004831 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004832 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004833 }
4834 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004835 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004836 if( status != PSA_SUCCESS )
4837 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004838 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004839 *handle = 0;
4840 }
4841 return( status );
4842}
4843
Gilles Peskineeab56e42018-07-12 17:12:33 +02004844
4845
4846/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004847/* Key derivation */
4848/****************************************************************/
4849
Gilles Peskinea05219c2018-11-16 16:02:56 +01004850#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004851#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004852/* Set up an HKDF-based operation. This is exactly the extract phase
Gilles Peskine346797d2018-11-16 16:05:06 +01004853 * of the HKDF algorithm.
4854 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004855 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004856 * to potentially free embedded data structures and wipe confidential data.
4857 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004858static psa_status_t psa_key_derivation_hkdf_setup( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004859 const uint8_t *secret,
4860 size_t secret_length,
4861 psa_algorithm_t hash_alg,
4862 const uint8_t *salt,
4863 size_t salt_length,
4864 const uint8_t *label,
4865 size_t label_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004866{
4867 psa_status_t status;
4868 status = psa_hmac_setup_internal( &hkdf->hmac,
4869 salt, salt_length,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004870 hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004871 if( status != PSA_SUCCESS )
4872 return( status );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004873 status = psa_hash_update( &hkdf->hmac.hash_ctx, secret, secret_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004874 if( status != PSA_SUCCESS )
4875 return( status );
4876 status = psa_hmac_finish_internal( &hkdf->hmac,
4877 hkdf->prk,
4878 sizeof( hkdf->prk ) );
4879 if( status != PSA_SUCCESS )
4880 return( status );
4881 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4882 hkdf->block_number = 0;
4883 hkdf->info_length = label_length;
4884 if( label_length != 0 )
4885 {
4886 hkdf->info = mbedtls_calloc( 1, label_length );
4887 if( hkdf->info == NULL )
4888 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4889 memcpy( hkdf->info, label, label_length );
4890 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004891 hkdf->state = HKDF_STATE_KEYED;
4892 hkdf->info_set = 1;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004893 return( PSA_SUCCESS );
4894}
Janos Follath71a4c912019-06-11 09:14:47 +01004895#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01004896#endif /* MBEDTLS_MD_C */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004897
Gilles Peskinea05219c2018-11-16 16:02:56 +01004898#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004899#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004900/* Set up a TLS-1.2-prf-based operation (see RFC 5246, Section 5).
Gilles Peskine346797d2018-11-16 16:05:06 +01004901 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004902 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004903 * to potentially free embedded data structures and wipe confidential data.
4904 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004905static psa_status_t psa_key_derivation_tls12_prf_setup(
4906 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004907 const uint8_t *key,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004908 size_t key_len,
4909 psa_algorithm_t hash_alg,
4910 const uint8_t *salt,
4911 size_t salt_length,
4912 const uint8_t *label,
4913 size_t label_length )
4914{
4915 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Hanno Becker580fba12018-11-13 20:50:45 +00004916 size_t Ai_with_seed_len = hash_length + salt_length + label_length;
4917 int overflow;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004918
4919 tls12_prf->key = mbedtls_calloc( 1, key_len );
4920 if( tls12_prf->key == NULL )
4921 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4922 tls12_prf->key_len = key_len;
4923 memcpy( tls12_prf->key, key, key_len );
4924
Hanno Becker580fba12018-11-13 20:50:45 +00004925 overflow = ( salt_length + label_length < salt_length ) ||
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004926 ( salt_length + label_length + hash_length < hash_length );
Hanno Becker580fba12018-11-13 20:50:45 +00004927 if( overflow )
4928 return( PSA_ERROR_INVALID_ARGUMENT );
4929
4930 tls12_prf->Ai_with_seed = mbedtls_calloc( 1, Ai_with_seed_len );
4931 if( tls12_prf->Ai_with_seed == NULL )
4932 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4933 tls12_prf->Ai_with_seed_len = Ai_with_seed_len;
4934
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004935 /* Write `label + seed' at the end of the `A(i) + seed` buffer,
4936 * leaving the initial `hash_length` bytes unspecified for now. */
Hanno Becker353e4532018-11-15 09:53:57 +00004937 if( label_length != 0 )
4938 {
4939 memcpy( tls12_prf->Ai_with_seed + hash_length,
4940 label, label_length );
4941 }
4942
4943 if( salt_length != 0 )
4944 {
4945 memcpy( tls12_prf->Ai_with_seed + hash_length + label_length,
4946 salt, salt_length );
4947 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004948
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004949 /* The first block gets generated when
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004950 * psa_key_derivation_output_bytes() is called. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004951 tls12_prf->block_number = 0;
4952 tls12_prf->offset_in_block = hash_length;
4953
4954 return( PSA_SUCCESS );
4955}
Janos Follath71a4c912019-06-11 09:14:47 +01004956#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Becker1aaedc02018-11-16 11:35:34 +00004957
Janos Follath71a4c912019-06-11 09:14:47 +01004958#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004959/* Set up a TLS-1.2-PSK-to-MS-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004960static psa_status_t psa_key_derivation_tls12_psk_to_ms_setup(
4961 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004962 const uint8_t *psk,
Hanno Becker1aaedc02018-11-16 11:35:34 +00004963 size_t psk_len,
4964 psa_algorithm_t hash_alg,
4965 const uint8_t *salt,
4966 size_t salt_length,
4967 const uint8_t *label,
4968 size_t label_length )
4969{
4970 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004971 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
Hanno Becker1aaedc02018-11-16 11:35:34 +00004972
4973 if( psk_len > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4974 return( PSA_ERROR_INVALID_ARGUMENT );
4975
4976 /* Quoting RFC 4279, Section 2:
4977 *
4978 * The premaster secret is formed as follows: if the PSK is N octets
4979 * long, concatenate a uint16 with the value N, N zero octets, a second
4980 * uint16 with the value N, and the PSK itself.
4981 */
4982
4983 pms[0] = ( psk_len >> 8 ) & 0xff;
4984 pms[1] = ( psk_len >> 0 ) & 0xff;
4985 memset( pms + 2, 0, psk_len );
4986 pms[2 + psk_len + 0] = pms[0];
4987 pms[2 + psk_len + 1] = pms[1];
4988 memcpy( pms + 4 + psk_len, psk, psk_len );
4989
Gilles Peskinecbe66502019-05-16 16:59:18 +02004990 status = psa_key_derivation_tls12_prf_setup( tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004991 pms, 4 + 2 * psk_len,
4992 hash_alg,
4993 salt, salt_length,
4994 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004995
Gilles Peskine3f108122018-12-07 18:14:53 +01004996 mbedtls_platform_zeroize( pms, sizeof( pms ) );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004997 return( status );
4998}
Janos Follath71a4c912019-06-11 09:14:47 +01004999#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01005000#endif /* MBEDTLS_MD_C */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005001
Janos Follath71a4c912019-06-11 09:14:47 +01005002#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005003/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005004 * to potentially free embedded data structures and wipe confidential data.
5005 */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005006static psa_status_t psa_key_derivation_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005007 psa_key_derivation_operation_t *operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005008 const uint8_t *secret, size_t secret_length,
5009 psa_algorithm_t alg,
5010 const uint8_t *salt, size_t salt_length,
5011 const uint8_t *label, size_t label_length,
5012 size_t capacity )
5013{
5014 psa_status_t status;
5015 size_t max_capacity;
5016
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005017 /* Set operation->alg even on failure so that abort knows what to do. */
5018 operation->alg = alg;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005019
5020#if defined(MBEDTLS_MD_C)
5021 if( PSA_ALG_IS_HKDF( alg ) )
5022 {
5023 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5024 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5025 if( hash_size == 0 )
5026 return( PSA_ERROR_NOT_SUPPORTED );
5027 max_capacity = 255 * hash_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005028 status = psa_key_derivation_hkdf_setup( &operation->ctx.hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005029 secret, secret_length,
5030 hash_alg,
5031 salt, salt_length,
5032 label, label_length );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005033 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00005034 /* TLS-1.2 PRF and TLS-1.2 PSK-to-MS are very similar, so share code. */
5035 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
5036 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005037 {
5038 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5039 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5040
5041 /* TLS-1.2 PRF supports only SHA-256 and SHA-384. */
5042 if( hash_alg != PSA_ALG_SHA_256 &&
5043 hash_alg != PSA_ALG_SHA_384 )
5044 {
5045 return( PSA_ERROR_NOT_SUPPORTED );
5046 }
5047
5048 max_capacity = 255 * hash_size;
Hanno Becker1aaedc02018-11-16 11:35:34 +00005049
5050 if( PSA_ALG_IS_TLS12_PRF( alg ) )
5051 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005052 status = psa_key_derivation_tls12_prf_setup( &operation->ctx.tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005053 secret, secret_length,
5054 hash_alg, salt, salt_length,
5055 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005056 }
5057 else
5058 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02005059 status = psa_key_derivation_tls12_psk_to_ms_setup(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005060 &operation->ctx.tls12_prf,
Hanno Becker1aaedc02018-11-16 11:35:34 +00005061 secret, secret_length,
5062 hash_alg, salt, salt_length,
5063 label, label_length );
5064 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005065 }
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005066 else
5067#endif
5068 {
5069 return( PSA_ERROR_NOT_SUPPORTED );
5070 }
5071
5072 if( status != PSA_SUCCESS )
5073 return( status );
5074
5075 if( capacity <= max_capacity )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005076 operation->capacity = capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005077 else if( capacity == PSA_KEY_DERIVATION_UNLIMITED_CAPACITY )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005078 operation->capacity = max_capacity;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005079 else
5080 return( PSA_ERROR_INVALID_ARGUMENT );
5081
5082 return( PSA_SUCCESS );
5083}
Janos Follath71a4c912019-06-11 09:14:47 +01005084#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005085
Janos Follath71a4c912019-06-11 09:14:47 +01005086#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005087psa_status_t psa_key_derivation( psa_key_derivation_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01005088 psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +02005089 psa_algorithm_t alg,
5090 const uint8_t *salt,
5091 size_t salt_length,
5092 const uint8_t *label,
5093 size_t label_length,
5094 size_t capacity )
5095{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005096 psa_key_slot_t *slot;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005097 psa_status_t status;
5098
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005099 if( operation->alg != 0 )
Gilles Peskineea0fb492018-07-12 17:17:20 +02005100 return( PSA_ERROR_BAD_STATE );
5101
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005102 /* Make sure that alg is a key derivation algorithm. This prevents
5103 * key selection algorithms, which psa_key_derivation_internal
5104 * accepts for the sake of key agreement. */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005105 if( ! PSA_ALG_IS_KEY_DERIVATION( alg ) )
5106 return( PSA_ERROR_INVALID_ARGUMENT );
5107
Gilles Peskine28f8f302019-07-24 13:30:31 +02005108 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005109 if( status != PSA_SUCCESS )
5110 return( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005111
Gilles Peskine8e338702019-07-30 20:06:31 +02005112 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005113 return( PSA_ERROR_INVALID_ARGUMENT );
5114
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005115 status = psa_key_derivation_internal( operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005116 slot->data.raw.data,
5117 slot->data.raw.bytes,
5118 alg,
5119 salt, salt_length,
5120 label, label_length,
5121 capacity );
5122 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005123 psa_key_derivation_abort( operation );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005124 return( status );
5125}
Janos Follath71a4c912019-06-11 09:14:47 +01005126#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005127
Gilles Peskine969c5d62019-01-16 15:53:06 +01005128static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005129 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005130 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005131{
Janos Follath5fe19732019-06-20 15:09:30 +01005132 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5133 * initialisers for this union leave some bytes unspecified.) */
5134 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5135
Gilles Peskine969c5d62019-01-16 15:53:06 +01005136 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005137#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005138 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5139 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5140 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005141 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005142 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005143 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5144 if( hash_size == 0 )
5145 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005146 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5147 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005148 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005149 {
5150 return( PSA_ERROR_NOT_SUPPORTED );
5151 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005152 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005153 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005154 }
5155#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005156 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005157 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005158}
5159
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005160psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005161 psa_algorithm_t alg )
5162{
5163 psa_status_t status;
5164
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005165 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005166 return( PSA_ERROR_BAD_STATE );
5167
Gilles Peskine6843c292019-01-18 16:44:49 +01005168 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5169 return( PSA_ERROR_INVALID_ARGUMENT );
5170 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005171 {
5172 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005173 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005174 }
5175 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5176 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005177 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005178 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005179 else
5180 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005181
5182 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005183 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005184 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005185}
5186
5187#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005188static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005189 psa_algorithm_t hash_alg,
5190 psa_key_derivation_step_t step,
5191 const uint8_t *data,
5192 size_t data_length )
5193{
5194 psa_status_t status;
5195 switch( step )
5196 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005197 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005198 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005199 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005200 status = psa_hmac_setup_internal( &hkdf->hmac,
5201 data, data_length,
5202 hash_alg );
5203 if( status != PSA_SUCCESS )
5204 return( status );
5205 hkdf->state = HKDF_STATE_STARTED;
5206 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005207 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005208 /* If no salt was provided, use an empty salt. */
5209 if( hkdf->state == HKDF_STATE_INIT )
5210 {
5211 status = psa_hmac_setup_internal( &hkdf->hmac,
5212 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005213 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005214 if( status != PSA_SUCCESS )
5215 return( status );
5216 hkdf->state = HKDF_STATE_STARTED;
5217 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005218 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005219 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005220 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5221 data, data_length );
5222 if( status != PSA_SUCCESS )
5223 return( status );
5224 status = psa_hmac_finish_internal( &hkdf->hmac,
5225 hkdf->prk,
5226 sizeof( hkdf->prk ) );
5227 if( status != PSA_SUCCESS )
5228 return( status );
5229 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5230 hkdf->block_number = 0;
5231 hkdf->state = HKDF_STATE_KEYED;
5232 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005233 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005234 if( hkdf->state == HKDF_STATE_OUTPUT )
5235 return( PSA_ERROR_BAD_STATE );
5236 if( hkdf->info_set )
5237 return( PSA_ERROR_BAD_STATE );
5238 hkdf->info_length = data_length;
5239 if( data_length != 0 )
5240 {
5241 hkdf->info = mbedtls_calloc( 1, data_length );
5242 if( hkdf->info == NULL )
5243 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5244 memcpy( hkdf->info, data, data_length );
5245 }
5246 hkdf->info_set = 1;
5247 return( PSA_SUCCESS );
5248 default:
5249 return( PSA_ERROR_INVALID_ARGUMENT );
5250 }
5251}
Janos Follathb03233e2019-06-11 15:30:30 +01005252
5253#if defined(PSA_PRE_1_0_KEY_DERIVATION)
5254static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5255 psa_algorithm_t hash_alg,
5256 psa_key_derivation_step_t step,
5257 const uint8_t *data,
5258 size_t data_length )
5259{
5260 (void) prf;
5261 (void) hash_alg;
5262 (void) step;
5263 (void) data;
5264 (void) data_length;
5265
5266 return( PSA_ERROR_INVALID_ARGUMENT );
5267}
Janos Follath6660f0e2019-06-17 08:44:03 +01005268
5269static psa_status_t psa_tls12_prf_psk_to_ms_input(
5270 psa_tls12_prf_key_derivation_t *prf,
5271 psa_algorithm_t hash_alg,
5272 psa_key_derivation_step_t step,
5273 const uint8_t *data,
5274 size_t data_length )
5275{
5276 (void) prf;
5277 (void) hash_alg;
5278 (void) step;
5279 (void) data;
5280 (void) data_length;
5281
5282 return( PSA_ERROR_INVALID_ARGUMENT );
5283}
Janos Follathb03233e2019-06-11 15:30:30 +01005284#else
Janos Follathf08e2652019-06-13 09:05:41 +01005285static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5286 const uint8_t *data,
5287 size_t data_length )
5288{
5289 if( prf->state != TLS12_PRF_STATE_INIT )
5290 return( PSA_ERROR_BAD_STATE );
5291
Janos Follathd6dce9f2019-07-04 09:11:38 +01005292 if( data_length != 0 )
5293 {
5294 prf->seed = mbedtls_calloc( 1, data_length );
5295 if( prf->seed == NULL )
5296 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005297
Janos Follathd6dce9f2019-07-04 09:11:38 +01005298 memcpy( prf->seed, data, data_length );
5299 prf->seed_length = data_length;
5300 }
Janos Follathf08e2652019-06-13 09:05:41 +01005301
5302 prf->state = TLS12_PRF_STATE_SEED_SET;
5303
5304 return( PSA_SUCCESS );
5305}
5306
Janos Follath81550542019-06-13 14:26:34 +01005307static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5308 psa_algorithm_t hash_alg,
5309 const uint8_t *data,
5310 size_t data_length )
5311{
5312 psa_status_t status;
5313 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5314 return( PSA_ERROR_BAD_STATE );
5315
5316 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5317 if( status != PSA_SUCCESS )
5318 return( status );
5319
5320 prf->state = TLS12_PRF_STATE_KEY_SET;
5321
5322 return( PSA_SUCCESS );
5323}
5324
Janos Follath6660f0e2019-06-17 08:44:03 +01005325static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5326 psa_tls12_prf_key_derivation_t *prf,
5327 psa_algorithm_t hash_alg,
5328 const uint8_t *data,
5329 size_t data_length )
5330{
5331 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005332 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5333 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005334
5335 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5336 return( PSA_ERROR_INVALID_ARGUMENT );
5337
5338 /* Quoting RFC 4279, Section 2:
5339 *
5340 * The premaster secret is formed as follows: if the PSK is N octets
5341 * long, concatenate a uint16 with the value N, N zero octets, a second
5342 * uint16 with the value N, and the PSK itself.
5343 */
5344
Janos Follath40e13932019-06-26 13:22:29 +01005345 *cur++ = ( data_length >> 8 ) & 0xff;
5346 *cur++ = ( data_length >> 0 ) & 0xff;
5347 memset( cur, 0, data_length );
5348 cur += data_length;
5349 *cur++ = pms[0];
5350 *cur++ = pms[1];
5351 memcpy( cur, data, data_length );
5352 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005353
Janos Follath40e13932019-06-26 13:22:29 +01005354 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005355
5356 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5357 return( status );
5358}
5359
Janos Follath63028dd2019-06-13 09:15:47 +01005360static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5361 const uint8_t *data,
5362 size_t data_length )
5363{
5364 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5365 return( PSA_ERROR_BAD_STATE );
5366
Janos Follathd6dce9f2019-07-04 09:11:38 +01005367 if( data_length != 0 )
5368 {
5369 prf->label = mbedtls_calloc( 1, data_length );
5370 if( prf->label == NULL )
5371 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005372
Janos Follathd6dce9f2019-07-04 09:11:38 +01005373 memcpy( prf->label, data, data_length );
5374 prf->label_length = data_length;
5375 }
Janos Follath63028dd2019-06-13 09:15:47 +01005376
5377 prf->state = TLS12_PRF_STATE_LABEL_SET;
5378
5379 return( PSA_SUCCESS );
5380}
5381
Janos Follathb03233e2019-06-11 15:30:30 +01005382static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5383 psa_algorithm_t hash_alg,
5384 psa_key_derivation_step_t step,
5385 const uint8_t *data,
5386 size_t data_length )
5387{
Janos Follathb03233e2019-06-11 15:30:30 +01005388 switch( step )
5389 {
Janos Follathf08e2652019-06-13 09:05:41 +01005390 case PSA_KEY_DERIVATION_INPUT_SEED:
5391 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005392 case PSA_KEY_DERIVATION_INPUT_SECRET:
5393 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005394 case PSA_KEY_DERIVATION_INPUT_LABEL:
5395 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005396 default:
5397 return( PSA_ERROR_INVALID_ARGUMENT );
5398 }
5399}
Janos Follath6660f0e2019-06-17 08:44:03 +01005400
5401static psa_status_t psa_tls12_prf_psk_to_ms_input(
5402 psa_tls12_prf_key_derivation_t *prf,
5403 psa_algorithm_t hash_alg,
5404 psa_key_derivation_step_t step,
5405 const uint8_t *data,
5406 size_t data_length )
5407{
5408 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005409 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005410 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5411 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005412 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005413
5414 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5415}
Janos Follathb03233e2019-06-11 15:30:30 +01005416#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005417#endif /* MBEDTLS_MD_C */
5418
Janos Follathb80a94e2019-06-12 15:54:46 +01005419static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005420 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005421 psa_key_derivation_step_t step,
5422 const uint8_t *data,
5423 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005424{
5425 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005426 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005427
5428#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005429 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005430 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005431 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005432 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005433 step, data, data_length );
5434 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005435 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005436#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005437#if defined(MBEDTLS_MD_C)
Janos Follath6660f0e2019-06-17 08:44:03 +01005438 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005439 {
Janos Follathb03233e2019-06-11 15:30:30 +01005440 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5441 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5442 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005443 }
5444 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5445 {
5446 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5447 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5448 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005449 }
5450 else
5451#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005452 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005453 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005454 return( PSA_ERROR_BAD_STATE );
5455 }
5456
5457 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005458 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005459 return( status );
5460}
5461
Janos Follath51f4a0f2019-06-14 11:35:55 +01005462psa_status_t psa_key_derivation_input_bytes(
5463 psa_key_derivation_operation_t *operation,
5464 psa_key_derivation_step_t step,
5465 const uint8_t *data,
5466 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005467{
Janos Follathc5621512019-06-14 11:27:57 +01005468 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5469 return( PSA_ERROR_INVALID_ARGUMENT );
5470
5471 return( psa_key_derivation_input_internal( operation, step,
5472 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005473}
5474
Janos Follath51f4a0f2019-06-14 11:35:55 +01005475psa_status_t psa_key_derivation_input_key(
5476 psa_key_derivation_operation_t *operation,
5477 psa_key_derivation_step_t step,
5478 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005479{
5480 psa_key_slot_t *slot;
5481 psa_status_t status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02005482 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005483 PSA_KEY_USAGE_DERIVE,
5484 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005485 if( status != PSA_SUCCESS )
5486 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02005487 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005488 return( PSA_ERROR_INVALID_ARGUMENT );
5489 /* Don't allow a key to be used as an input that is usually public.
5490 * This is debatable. It's ok from a cryptographic perspective to
5491 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005492 * the material should be dedicated to a particular input step,
5493 * otherwise this may allow the key to be used in an unintended way
5494 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005495 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005496 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005497 return( psa_key_derivation_input_internal( operation,
5498 step,
5499 slot->data.raw.data,
5500 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005501}
5502
Gilles Peskineea0fb492018-07-12 17:17:20 +02005503
5504
5505/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005506/* Key agreement */
5507/****************************************************************/
5508
Gilles Peskinea05219c2018-11-16 16:02:56 +01005509#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005510static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5511 size_t peer_key_length,
5512 const mbedtls_ecp_keypair *our_key,
5513 uint8_t *shared_secret,
5514 size_t shared_secret_size,
5515 size_t *shared_secret_length )
5516{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005517 mbedtls_ecp_keypair *their_key = NULL;
5518 mbedtls_ecdh_context ecdh;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005519 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005520 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005521
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005522 status = psa_import_ec_public_key(
5523 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5524 peer_key, peer_key_length,
5525 &their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005526 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005527 goto exit;
Gilles Peskineb4086612018-11-14 20:51:23 +01005528
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005529 status = mbedtls_to_psa_error(
5530 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5531 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005532 goto exit;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005533 status = mbedtls_to_psa_error(
5534 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5535 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005536 goto exit;
5537
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005538 status = mbedtls_to_psa_error(
5539 mbedtls_ecdh_calc_secret( &ecdh,
5540 shared_secret_length,
5541 shared_secret, shared_secret_size,
5542 mbedtls_ctr_drbg_random,
5543 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005544
5545exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005546 mbedtls_ecdh_free( &ecdh );
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005547 mbedtls_ecp_keypair_free( their_key );
5548 mbedtls_free( their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005549 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005550}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005551#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005552
Gilles Peskine01d718c2018-09-18 12:01:02 +02005553#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5554
Gilles Peskine0216fe12019-04-11 21:23:21 +02005555static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5556 psa_key_slot_t *private_key,
5557 const uint8_t *peer_key,
5558 size_t peer_key_length,
5559 uint8_t *shared_secret,
5560 size_t shared_secret_size,
5561 size_t *shared_secret_length )
5562{
5563 switch( alg )
5564 {
5565#if defined(MBEDTLS_ECDH_C)
5566 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005567 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005568 return( PSA_ERROR_INVALID_ARGUMENT );
5569 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5570 private_key->data.ecp,
5571 shared_secret, shared_secret_size,
5572 shared_secret_length ) );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005573#endif /* MBEDTLS_ECDH_C */
5574 default:
5575 (void) private_key;
5576 (void) peer_key;
5577 (void) peer_key_length;
5578 (void) shared_secret;
5579 (void) shared_secret_size;
5580 (void) shared_secret_length;
5581 return( PSA_ERROR_NOT_SUPPORTED );
5582 }
5583}
5584
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005585/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005586 * to potentially free embedded data structures and wipe confidential data.
5587 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005588static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005589 psa_key_derivation_step_t step,
Gilles Peskine2f060a82018-12-04 17:12:32 +01005590 psa_key_slot_t *private_key,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005591 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005592 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005593{
5594 psa_status_t status;
5595 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5596 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005597 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005598
5599 /* Step 1: run the secret agreement algorithm to generate the shared
5600 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005601 status = psa_key_agreement_raw_internal( ka_alg,
5602 private_key,
5603 peer_key, peer_key_length,
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005604 shared_secret,
5605 sizeof( shared_secret ),
5606 &shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005607 if( status != PSA_SUCCESS )
5608 goto exit;
5609
5610 /* Step 2: set up the key derivation to generate key material from
5611 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005612 status = psa_key_derivation_input_internal( operation, step,
5613 shared_secret,
5614 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005615
Gilles Peskine01d718c2018-09-18 12:01:02 +02005616exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005617 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005618 return( status );
5619}
5620
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005621psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005622 psa_key_derivation_step_t step,
5623 psa_key_handle_t private_key,
5624 const uint8_t *peer_key,
5625 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005626{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005627 psa_key_slot_t *slot;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005628 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005629 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005630 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005631 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005632 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005633 if( status != PSA_SUCCESS )
5634 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005635 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005636 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005637 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005638 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005639 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005640 return( status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005641}
5642
Gilles Peskinebe697d82019-05-16 18:00:41 +02005643psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5644 psa_key_handle_t private_key,
5645 const uint8_t *peer_key,
5646 size_t peer_key_length,
5647 uint8_t *output,
5648 size_t output_size,
5649 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005650{
5651 psa_key_slot_t *slot;
5652 psa_status_t status;
5653
5654 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5655 {
5656 status = PSA_ERROR_INVALID_ARGUMENT;
5657 goto exit;
5658 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005659 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005660 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005661 if( status != PSA_SUCCESS )
5662 goto exit;
5663
5664 status = psa_key_agreement_raw_internal( alg, slot,
5665 peer_key, peer_key_length,
5666 output, output_size,
5667 output_length );
5668
5669exit:
5670 if( status != PSA_SUCCESS )
5671 {
5672 /* If an error happens and is not handled properly, the output
5673 * may be used as a key to protect sensitive data. Arrange for such
5674 * a key to be random, which is likely to result in decryption or
5675 * verification errors. This is better than filling the buffer with
5676 * some constant data such as zeros, which would result in the data
5677 * being protected with a reproducible, easily knowable key.
5678 */
5679 psa_generate_random( output, output_size );
5680 *output_length = output_size;
5681 }
5682 return( status );
5683}
Gilles Peskine01d718c2018-09-18 12:01:02 +02005684
5685
5686/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005687/* Random generation */
Gilles Peskine05d69892018-06-19 22:00:52 +02005688/****************************************************************/
5689
5690psa_status_t psa_generate_random( uint8_t *output,
5691 size_t output_size )
5692{
itayzafrir0adf0fc2018-09-06 16:24:41 +03005693 int ret;
5694 GUARD_MODULE_INITIALIZED;
5695
Gilles Peskinef181eca2019-08-07 13:49:00 +02005696 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5697 {
5698 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5699 output,
5700 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5701 if( ret != 0 )
5702 return( mbedtls_to_psa_error( ret ) );
5703 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5704 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5705 }
5706
itayzafrir0adf0fc2018-09-06 16:24:41 +03005707 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
Gilles Peskine05d69892018-06-19 22:00:52 +02005708 return( mbedtls_to_psa_error( ret ) );
5709}
5710
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005711#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5712#include "mbedtls/entropy_poll.h"
avolinski13beb102018-11-20 16:51:49 +02005713
Gilles Peskine7228da22019-07-15 11:06:15 +02005714psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005715 size_t seed_size )
5716{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005717 if( global_data.initialized )
5718 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005719
5720 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5721 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5722 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5723 return( PSA_ERROR_INVALID_ARGUMENT );
5724
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005725 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005726}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005727#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005728
Gilles Peskinee56e8782019-04-26 17:34:02 +02005729#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5730static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5731 size_t domain_parameters_size,
5732 int *exponent )
5733{
5734 size_t i;
5735 uint32_t acc = 0;
5736
5737 if( domain_parameters_size == 0 )
5738 {
5739 *exponent = 65537;
5740 return( PSA_SUCCESS );
5741 }
5742
5743 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5744 * support values that fit in a 32-bit integer, which is larger than
5745 * int on just about every platform anyway. */
5746 if( domain_parameters_size > sizeof( acc ) )
5747 return( PSA_ERROR_NOT_SUPPORTED );
5748 for( i = 0; i < domain_parameters_size; i++ )
5749 acc = ( acc << 8 ) | domain_parameters[i];
5750 if( acc > INT_MAX )
5751 return( PSA_ERROR_NOT_SUPPORTED );
5752 *exponent = acc;
5753 return( PSA_SUCCESS );
5754}
5755#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5756
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005757static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005758 psa_key_slot_t *slot, size_t bits,
5759 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskine05d69892018-06-19 22:00:52 +02005760{
Gilles Peskine8e338702019-07-30 20:06:31 +02005761 psa_key_type_t type = slot->attr.type;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005762
Gilles Peskinee56e8782019-04-26 17:34:02 +02005763 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005764 return( PSA_ERROR_INVALID_ARGUMENT );
5765
Gilles Peskine48c0ea12018-06-21 14:15:31 +02005766 if( key_type_is_raw_bytes( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005767 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005768 psa_status_t status;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005769 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005770 if( status != PSA_SUCCESS )
5771 return( status );
5772 status = psa_generate_random( slot->data.raw.data,
5773 slot->data.raw.bytes );
5774 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005775 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005776#if defined(MBEDTLS_DES_C)
5777 if( type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005778 psa_des_set_key_parity( slot->data.raw.data,
5779 slot->data.raw.bytes );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005780#endif /* MBEDTLS_DES_C */
5781 }
5782 else
5783
5784#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005785 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005786 {
5787 mbedtls_rsa_context *rsa;
5788 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005789 int exponent;
5790 psa_status_t status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005791 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5792 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine86a440b2018-11-12 18:39:40 +01005793 /* Accept only byte-aligned keys, for the same reasons as
5794 * in psa_import_rsa_key(). */
5795 if( bits % 8 != 0 )
5796 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005797 status = psa_read_rsa_exponent( domain_parameters,
5798 domain_parameters_size,
5799 &exponent );
5800 if( status != PSA_SUCCESS )
5801 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005802 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5803 if( rsa == NULL )
5804 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5805 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5806 ret = mbedtls_rsa_gen_key( rsa,
5807 mbedtls_ctr_drbg_random,
5808 &global_data.ctr_drbg,
Jaeden Amero23bbb752018-06-26 14:16:54 +01005809 (unsigned int) bits,
Gilles Peskine12313cd2018-06-20 00:20:32 +02005810 exponent );
5811 if( ret != 0 )
5812 {
5813 mbedtls_rsa_free( rsa );
5814 mbedtls_free( rsa );
5815 return( mbedtls_to_psa_error( ret ) );
5816 }
5817 slot->data.rsa = rsa;
5818 }
5819 else
5820#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5821
5822#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005823 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005824 {
5825 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5826 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5827 const mbedtls_ecp_curve_info *curve_info =
5828 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5829 mbedtls_ecp_keypair *ecp;
5830 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005831 if( domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005832 return( PSA_ERROR_NOT_SUPPORTED );
5833 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5834 return( PSA_ERROR_NOT_SUPPORTED );
5835 if( curve_info->bit_size != bits )
5836 return( PSA_ERROR_INVALID_ARGUMENT );
5837 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5838 if( ecp == NULL )
5839 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5840 mbedtls_ecp_keypair_init( ecp );
5841 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5842 mbedtls_ctr_drbg_random,
5843 &global_data.ctr_drbg );
5844 if( ret != 0 )
5845 {
5846 mbedtls_ecp_keypair_free( ecp );
5847 mbedtls_free( ecp );
5848 return( mbedtls_to_psa_error( ret ) );
5849 }
5850 slot->data.ecp = ecp;
5851 }
5852 else
5853#endif /* MBEDTLS_ECP_C */
5854
5855 return( PSA_ERROR_NOT_SUPPORTED );
5856
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005857 return( PSA_SUCCESS );
5858}
5859
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005860psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005861 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005862{
5863 psa_status_t status;
5864 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005865 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine011e4282019-06-26 18:34:38 +02005866 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005867#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5868 if( driver != NULL )
5869 {
5870 /* Generating a key in a secure element is not implemented yet. */
5871 status = PSA_ERROR_NOT_SUPPORTED;
5872 }
5873#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005874 if( status == PSA_SUCCESS )
5875 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005876 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005877 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005878 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005879 }
5880 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005881 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005882 if( status != PSA_SUCCESS )
5883 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005884 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005885 *handle = 0;
5886 }
5887 return( status );
5888}
5889
5890
Gilles Peskine05d69892018-06-19 22:00:52 +02005891
5892/****************************************************************/
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01005893/* Module setup */
5894/****************************************************************/
5895
Gilles Peskine5e769522018-11-20 21:59:56 +01005896psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5897 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5898 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5899{
5900 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5901 return( PSA_ERROR_BAD_STATE );
5902 global_data.entropy_init = entropy_init;
5903 global_data.entropy_free = entropy_free;
5904 return( PSA_SUCCESS );
5905}
5906
Gilles Peskinee59236f2018-01-27 23:32:46 +01005907void mbedtls_psa_crypto_free( void )
5908{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005909 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005910 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5911 {
5912 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005913 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005914 }
5915 /* Wipe all remaining data, including configuration.
5916 * In particular, this sets all state indicator to the value
5917 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005918 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005919#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005920 /* Unregister all secure element drivers, so that we restart from
5921 * a pristine state. */
5922 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005923#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005924}
5925
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005926#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5927/** Recover a transaction that was interrupted by a power failure.
5928 *
5929 * This function is called during initialization, before psa_crypto_init()
5930 * returns. If this function returns a failure status, the initialization
5931 * fails.
5932 */
5933static psa_status_t psa_crypto_recover_transaction(
5934 const psa_crypto_transaction_t *transaction )
5935{
5936 switch( transaction->unknown.type )
5937 {
5938 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5939 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
5940 /* TOnogrepDO - fall through to the failure case until this
5941 * is implemented */
5942 default:
5943 /* We found an unsupported transaction in the storage.
5944 * We don't know what state the storage is in. Give up. */
5945 return( PSA_ERROR_STORAGE_FAILURE );
5946 }
5947}
5948#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5949
Gilles Peskinee59236f2018-01-27 23:32:46 +01005950psa_status_t psa_crypto_init( void )
5951{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005952 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005953 const unsigned char drbg_seed[] = "PSA";
5954
Gilles Peskinec6b69072018-11-20 21:42:52 +01005955 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005956 if( global_data.initialized != 0 )
5957 return( PSA_SUCCESS );
5958
Gilles Peskine5e769522018-11-20 21:59:56 +01005959 /* Set default configuration if
5960 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5961 if( global_data.entropy_init == NULL )
5962 global_data.entropy_init = mbedtls_entropy_init;
5963 if( global_data.entropy_free == NULL )
5964 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005965
Gilles Peskinec6b69072018-11-20 21:42:52 +01005966 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005967 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01005968#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5969 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5970 /* The PSA entropy injection feature depends on using NV seed as an entropy
5971 * source. Add NV seed as an entropy source for PSA entropy injection. */
5972 mbedtls_entropy_add_source( &global_data.entropy,
5973 mbedtls_nv_seed_poll, NULL,
5974 MBEDTLS_ENTROPY_BLOCK_SIZE,
5975 MBEDTLS_ENTROPY_SOURCE_STRONG );
5976#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01005977 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005978 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005979 status = mbedtls_to_psa_error(
5980 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5981 mbedtls_entropy_func,
5982 &global_data.entropy,
5983 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5984 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005985 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005986 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005987
Gilles Peskine66fb1262018-12-10 16:29:04 +01005988 status = psa_initialize_key_slots( );
5989 if( status != PSA_SUCCESS )
5990 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005991
Gilles Peskine4b734222019-07-24 15:56:31 +02005992#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005993 status = psa_crypto_load_transaction( );
5994 if( status == PSA_SUCCESS )
5995 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005996 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5997 if( status != PSA_SUCCESS )
5998 goto exit;
5999 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006000 }
6001 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6002 {
6003 /* There's no transaction to complete. It's all good. */
6004 status = PSA_SUCCESS;
6005 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006006#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006007
Gilles Peskinec6b69072018-11-20 21:42:52 +01006008 /* All done. */
Gilles Peskinee4ebc122018-03-07 14:16:44 +01006009 global_data.initialized = 1;
6010
Gilles Peskinee59236f2018-01-27 23:32:46 +01006011exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006012 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006013 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006014 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006015}
6016
6017#endif /* MBEDTLS_PSA_CRYPTO_C */