blob: 9f7b5cbc0cd7867addbbf192f3c04052e6457735 [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 Peskine91e8c332019-08-02 19:19:39 +02001437 "One or more key attribute flag is listed as both external-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 Peskine267c6562019-05-27 19:01:54 +02001549 status = psa_internal_allocate_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
1563 * external-only flags, query `attributes`. */
1564 slot->attr.flags |= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
1565
Gilles Peskinecbaff462019-07-12 23:46:04 +02001566#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine60450a42019-07-25 11:32:45 +02001567 /* For a key in a secure element, we need to do three things:
1568 * create the key file in internal storage, create the
1569 * key inside the secure element, and update the driver's
1570 * persistent data. Start a transaction that will encompass these
1571 * three actions. */
1572 /* The first thing to do is to find a slot number for the new key.
1573 * We save the slot number in persistent storage as part of the
1574 * transaction data. It will be needed to recover if the power
1575 * fails during the key creation process, to clean up on the secure
1576 * element side after restarting. Obtaining a slot number from the
1577 * secure element driver updates its persistent state, but we do not yet
1578 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001579 * we can roll back to a state where the key doesn't exist. */
Gilles Peskinecbaff462019-07-12 23:46:04 +02001580 if( *p_drv != NULL )
1581 {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001582 /* Choosing a slot number is not supported yet. */
1583 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1584 return( PSA_ERROR_NOT_SUPPORTED );
1585
Gilles Peskinecbaff462019-07-12 23:46:04 +02001586 status = psa_find_se_slot_for_key( attributes, *p_drv,
1587 &slot->data.se.slot_number );
1588 if( status != PSA_SUCCESS )
1589 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001590 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001591 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001592 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001593 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001594 status = psa_crypto_save_transaction( );
1595 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001596 {
1597 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001598 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001599 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001600 }
1601#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1602
Gilles Peskine4747d192019-04-17 15:05:45 +02001603 return( status );
1604}
1605
1606/** Finalize the creation of a key once its key material has been set.
1607 *
1608 * This entails writing the key to persistent storage.
1609 *
1610 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001611 * See the documentation of psa_start_key_creation() for the intended use
1612 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001613 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001614 * \param[in,out] slot Pointer to the slot with key material.
1615 * \param[in] driver The secure element driver for the key,
1616 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001617 *
1618 * \retval #PSA_SUCCESS
1619 * The key was successfully created. The handle is now valid.
1620 * \return If this function fails, the key slot is an invalid state.
1621 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001622 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001623static psa_status_t psa_finish_key_creation(
1624 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001625 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001626{
1627 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001628 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001629 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001630
1631#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001632 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001633 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001634#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1635 if( driver != NULL )
1636 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001637 psa_se_key_data_storage_t data;
1638#if defined(static_assert)
1639 static_assert( sizeof( slot->data.se.slot_number ) ==
1640 sizeof( data.slot_number ),
1641 "Slot number size does not match psa_se_key_data_storage_t" );
1642 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1643 "Bit-size size does not match psa_se_key_data_storage_t" );
1644#endif
1645 memcpy( &data.slot_number, &slot->data.se.slot_number,
1646 sizeof( slot->data.se.slot_number ) );
1647 memcpy( &data.bits, &slot->attr.bits,
1648 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001649 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001650 (uint8_t*) &data,
1651 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001652 }
1653 else
1654#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1655 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001656 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001657 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001658 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001659 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1660 size_t length = 0;
Gilles Peskine1df83d42019-07-23 16:13:14 +02001661 if( buffer == NULL && buffer_size != 0 )
1662 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1663 status = psa_internal_export_key( slot,
1664 buffer, buffer_size, &length,
1665 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001666 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001667 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001668 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001669
Gilles Peskine1df83d42019-07-23 16:13:14 +02001670 if( buffer_size != 0 )
1671 mbedtls_platform_zeroize( buffer, buffer_size );
1672 mbedtls_free( buffer );
1673 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001674 }
1675#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1676
Gilles Peskinecbaff462019-07-12 23:46:04 +02001677#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1678 if( driver != NULL )
1679 {
1680 status = psa_save_se_persistent_data( driver );
1681 if( status != PSA_SUCCESS )
1682 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001683 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001684 return( status );
1685 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001686 status = psa_crypto_stop_transaction( );
1687 if( status != PSA_SUCCESS )
1688 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001689 }
1690#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1691
Gilles Peskine4747d192019-04-17 15:05:45 +02001692 return( status );
1693}
1694
1695/** Abort the creation of a key.
1696 *
1697 * You may call this function after calling psa_start_key_creation(),
1698 * or after psa_finish_key_creation() fails. In other circumstances, this
1699 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001700 * See the documentation of psa_start_key_creation() for the intended use
1701 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001703 * \param[in,out] slot Pointer to the slot with key material.
1704 * \param[in] driver The secure element driver for the key,
1705 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001706 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001707static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001708 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001709{
Gilles Peskine011e4282019-06-26 18:34:38 +02001710 (void) driver;
1711
Gilles Peskine4747d192019-04-17 15:05:45 +02001712 if( slot == NULL )
1713 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001714
1715#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1716 /* TOnogrepDO: If the key has already been created in the secure
1717 * element, and the failure happened later (when saving metadata
1718 * to internal storage), we need to destroy the key in the secure
1719 * element. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001720
1721 /* Abort the ongoing transaction if any. We already did what it
1722 * takes to undo any partial creation. All that's left is to update
1723 * the transaction data itself. */
1724 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001725#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1726
Gilles Peskine4747d192019-04-17 15:05:45 +02001727 psa_wipe_key_slot( slot );
1728}
1729
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001730/** Validate optional attributes during key creation.
1731 *
1732 * Some key attributes are optional during key creation. If they are
1733 * specified in the attributes structure, check that they are consistent
1734 * with the data in the slot.
1735 *
1736 * This function should be called near the end of key creation, after
1737 * the slot in memory is fully populated but before saving persistent data.
1738 */
1739static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001740 const psa_key_slot_t *slot,
1741 const psa_key_attributes_t *attributes )
1742{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001743 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001744 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001745 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001746 return( PSA_ERROR_INVALID_ARGUMENT );
1747 }
1748
1749 if( attributes->domain_parameters_size != 0 )
1750 {
1751#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001752 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001753 {
1754 mbedtls_mpi actual, required;
1755 int ret;
1756 mbedtls_mpi_init( &actual );
1757 mbedtls_mpi_init( &required );
1758 ret = mbedtls_rsa_export( slot->data.rsa,
1759 NULL, NULL, NULL, NULL, &actual );
1760 if( ret != 0 )
1761 goto rsa_exit;
1762 ret = mbedtls_mpi_read_binary( &required,
1763 attributes->domain_parameters,
1764 attributes->domain_parameters_size );
1765 if( ret != 0 )
1766 goto rsa_exit;
1767 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1768 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1769 rsa_exit:
1770 mbedtls_mpi_free( &actual );
1771 mbedtls_mpi_free( &required );
1772 if( ret != 0)
1773 return( mbedtls_to_psa_error( ret ) );
1774 }
1775 else
1776#endif
1777 {
1778 return( PSA_ERROR_INVALID_ARGUMENT );
1779 }
1780 }
1781
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001782 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001783 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001784 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001785 return( PSA_ERROR_INVALID_ARGUMENT );
1786 }
1787
1788 return( PSA_SUCCESS );
1789}
1790
Gilles Peskine4747d192019-04-17 15:05:45 +02001791psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001793 size_t data_length,
1794 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001795{
1796 psa_status_t status;
1797 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001798 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001799
Gilles Peskine011e4282019-06-26 18:34:38 +02001800 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001801 if( status != PSA_SUCCESS )
1802 goto exit;
1803
Gilles Peskine5d309672019-07-12 23:47:28 +02001804#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1805 if( driver != NULL )
1806 {
1807 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001808 size_t bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001809 if( drv->key_management == NULL ||
1810 drv->key_management->p_import == NULL )
1811 {
1812 status = PSA_ERROR_NOT_SUPPORTED;
1813 goto exit;
1814 }
1815 status = drv->key_management->p_import(
1816 psa_get_se_driver_context( driver ),
1817 slot->data.se.slot_number,
Gilles Peskine8e338702019-07-30 20:06:31 +02001818 slot->attr.lifetime, slot->attr.type,
1819 slot->attr.policy.alg, slot->attr.policy.usage,
Gilles Peskine18017402019-07-24 20:25:59 +02001820 data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001821 &bits );
1822 if( status != PSA_SUCCESS )
1823 goto exit;
1824 if( bits > PSA_MAX_KEY_BITS )
1825 {
1826 status = PSA_ERROR_NOT_SUPPORTED;
1827 goto exit;
1828 }
1829 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001830 }
1831 else
1832#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1833 {
1834 status = psa_import_key_into_slot( slot, data, data_length );
1835 if( status != PSA_SUCCESS )
1836 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001837 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001838 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001839 if( status != PSA_SUCCESS )
1840 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841
Gilles Peskine011e4282019-06-26 18:34:38 +02001842 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001843exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001844 if( status != PSA_SUCCESS )
1845 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001846 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001847 *handle = 0;
1848 }
1849 return( status );
1850}
1851
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001852static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001853 psa_key_slot_t *target )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001854{
1855 psa_status_t status;
1856 uint8_t *buffer = NULL;
1857 size_t buffer_size = 0;
1858 size_t length;
1859
Gilles Peskine8e338702019-07-30 20:06:31 +02001860 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001861 psa_get_key_slot_bits( source ) );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001862 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001863 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001864 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001865 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1866 if( status != PSA_SUCCESS )
1867 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001868 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001869 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001870
1871exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001872 if( buffer_size != 0 )
1873 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001874 mbedtls_free( buffer );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001875 return( status );
1876}
1877
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001878psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1879 const psa_key_attributes_t *specified_attributes,
1880 psa_key_handle_t *target_handle )
1881{
1882 psa_status_t status;
1883 psa_key_slot_t *source_slot = NULL;
1884 psa_key_slot_t *target_slot = NULL;
1885 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001886 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001887
Gilles Peskine28f8f302019-07-24 13:30:31 +02001888 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001889 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001890 if( status != PSA_SUCCESS )
1891 goto exit;
1892
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001893 status = psa_validate_optional_attributes( source_slot,
1894 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 if( status != PSA_SUCCESS )
1896 goto exit;
1897
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001898 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001899 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001900 if( status != PSA_SUCCESS )
1901 goto exit;
1902
1903 status = psa_start_key_creation( &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001904 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001905 if( status != PSA_SUCCESS )
1906 goto exit;
1907
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001908#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1909 if( driver != NULL )
1910 {
1911 /* Copying to a secure element is not implemented yet. */
1912 status = PSA_ERROR_NOT_SUPPORTED;
1913 goto exit;
1914 }
1915#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1916
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001917 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001918 if( status != PSA_SUCCESS )
1919 goto exit;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001920
Gilles Peskine011e4282019-06-26 18:34:38 +02001921 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001922exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001923 if( status != PSA_SUCCESS )
1924 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001925 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001926 *target_handle = 0;
1927 }
1928 return( status );
1929}
1930
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001931
1932
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001933/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001934/* Message digests */
1935/****************************************************************/
1936
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001937static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001938{
1939 switch( alg )
1940 {
1941#if defined(MBEDTLS_MD2_C)
1942 case PSA_ALG_MD2:
1943 return( &mbedtls_md2_info );
1944#endif
1945#if defined(MBEDTLS_MD4_C)
1946 case PSA_ALG_MD4:
1947 return( &mbedtls_md4_info );
1948#endif
1949#if defined(MBEDTLS_MD5_C)
1950 case PSA_ALG_MD5:
1951 return( &mbedtls_md5_info );
1952#endif
1953#if defined(MBEDTLS_RIPEMD160_C)
1954 case PSA_ALG_RIPEMD160:
1955 return( &mbedtls_ripemd160_info );
1956#endif
1957#if defined(MBEDTLS_SHA1_C)
1958 case PSA_ALG_SHA_1:
1959 return( &mbedtls_sha1_info );
1960#endif
1961#if defined(MBEDTLS_SHA256_C)
1962 case PSA_ALG_SHA_224:
1963 return( &mbedtls_sha224_info );
1964 case PSA_ALG_SHA_256:
1965 return( &mbedtls_sha256_info );
1966#endif
1967#if defined(MBEDTLS_SHA512_C)
1968 case PSA_ALG_SHA_384:
1969 return( &mbedtls_sha384_info );
1970 case PSA_ALG_SHA_512:
1971 return( &mbedtls_sha512_info );
1972#endif
1973 default:
1974 return( NULL );
1975 }
1976}
1977
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001978psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
1979{
1980 switch( operation->alg )
1981 {
Gilles Peskine81736312018-06-26 15:04:31 +02001982 case 0:
1983 /* The object has (apparently) been initialized but it is not
1984 * in use. It's ok to call abort on such an object, and there's
1985 * nothing to do. */
1986 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001987#if defined(MBEDTLS_MD2_C)
1988 case PSA_ALG_MD2:
1989 mbedtls_md2_free( &operation->ctx.md2 );
1990 break;
1991#endif
1992#if defined(MBEDTLS_MD4_C)
1993 case PSA_ALG_MD4:
1994 mbedtls_md4_free( &operation->ctx.md4 );
1995 break;
1996#endif
1997#if defined(MBEDTLS_MD5_C)
1998 case PSA_ALG_MD5:
1999 mbedtls_md5_free( &operation->ctx.md5 );
2000 break;
2001#endif
2002#if defined(MBEDTLS_RIPEMD160_C)
2003 case PSA_ALG_RIPEMD160:
2004 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2005 break;
2006#endif
2007#if defined(MBEDTLS_SHA1_C)
2008 case PSA_ALG_SHA_1:
2009 mbedtls_sha1_free( &operation->ctx.sha1 );
2010 break;
2011#endif
2012#if defined(MBEDTLS_SHA256_C)
2013 case PSA_ALG_SHA_224:
2014 case PSA_ALG_SHA_256:
2015 mbedtls_sha256_free( &operation->ctx.sha256 );
2016 break;
2017#endif
2018#if defined(MBEDTLS_SHA512_C)
2019 case PSA_ALG_SHA_384:
2020 case PSA_ALG_SHA_512:
2021 mbedtls_sha512_free( &operation->ctx.sha512 );
2022 break;
2023#endif
2024 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002025 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002026 }
2027 operation->alg = 0;
2028 return( PSA_SUCCESS );
2029}
2030
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002031psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002032 psa_algorithm_t alg )
2033{
2034 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002035
2036 /* A context must be freshly initialized before it can be set up. */
2037 if( operation->alg != 0 )
2038 {
2039 return( PSA_ERROR_BAD_STATE );
2040 }
2041
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002042 switch( alg )
2043 {
2044#if defined(MBEDTLS_MD2_C)
2045 case PSA_ALG_MD2:
2046 mbedtls_md2_init( &operation->ctx.md2 );
2047 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2048 break;
2049#endif
2050#if defined(MBEDTLS_MD4_C)
2051 case PSA_ALG_MD4:
2052 mbedtls_md4_init( &operation->ctx.md4 );
2053 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2054 break;
2055#endif
2056#if defined(MBEDTLS_MD5_C)
2057 case PSA_ALG_MD5:
2058 mbedtls_md5_init( &operation->ctx.md5 );
2059 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2060 break;
2061#endif
2062#if defined(MBEDTLS_RIPEMD160_C)
2063 case PSA_ALG_RIPEMD160:
2064 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2065 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2066 break;
2067#endif
2068#if defined(MBEDTLS_SHA1_C)
2069 case PSA_ALG_SHA_1:
2070 mbedtls_sha1_init( &operation->ctx.sha1 );
2071 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2072 break;
2073#endif
2074#if defined(MBEDTLS_SHA256_C)
2075 case PSA_ALG_SHA_224:
2076 mbedtls_sha256_init( &operation->ctx.sha256 );
2077 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2078 break;
2079 case PSA_ALG_SHA_256:
2080 mbedtls_sha256_init( &operation->ctx.sha256 );
2081 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2082 break;
2083#endif
2084#if defined(MBEDTLS_SHA512_C)
2085 case PSA_ALG_SHA_384:
2086 mbedtls_sha512_init( &operation->ctx.sha512 );
2087 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2088 break;
2089 case PSA_ALG_SHA_512:
2090 mbedtls_sha512_init( &operation->ctx.sha512 );
2091 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2092 break;
2093#endif
2094 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002095 return( PSA_ALG_IS_HASH( alg ) ?
2096 PSA_ERROR_NOT_SUPPORTED :
2097 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002098 }
2099 if( ret == 0 )
2100 operation->alg = alg;
2101 else
2102 psa_hash_abort( operation );
2103 return( mbedtls_to_psa_error( ret ) );
2104}
2105
2106psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2107 const uint8_t *input,
2108 size_t input_length )
2109{
2110 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002111
2112 /* Don't require hash implementations to behave correctly on a
2113 * zero-length input, which may have an invalid pointer. */
2114 if( input_length == 0 )
2115 return( PSA_SUCCESS );
2116
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002117 switch( operation->alg )
2118 {
2119#if defined(MBEDTLS_MD2_C)
2120 case PSA_ALG_MD2:
2121 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2122 input, input_length );
2123 break;
2124#endif
2125#if defined(MBEDTLS_MD4_C)
2126 case PSA_ALG_MD4:
2127 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2128 input, input_length );
2129 break;
2130#endif
2131#if defined(MBEDTLS_MD5_C)
2132 case PSA_ALG_MD5:
2133 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2134 input, input_length );
2135 break;
2136#endif
2137#if defined(MBEDTLS_RIPEMD160_C)
2138 case PSA_ALG_RIPEMD160:
2139 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2140 input, input_length );
2141 break;
2142#endif
2143#if defined(MBEDTLS_SHA1_C)
2144 case PSA_ALG_SHA_1:
2145 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2146 input, input_length );
2147 break;
2148#endif
2149#if defined(MBEDTLS_SHA256_C)
2150 case PSA_ALG_SHA_224:
2151 case PSA_ALG_SHA_256:
2152 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2153 input, input_length );
2154 break;
2155#endif
2156#if defined(MBEDTLS_SHA512_C)
2157 case PSA_ALG_SHA_384:
2158 case PSA_ALG_SHA_512:
2159 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2160 input, input_length );
2161 break;
2162#endif
2163 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002164 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002165 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002166
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167 if( ret != 0 )
2168 psa_hash_abort( operation );
2169 return( mbedtls_to_psa_error( ret ) );
2170}
2171
2172psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2173 uint8_t *hash,
2174 size_t hash_size,
2175 size_t *hash_length )
2176{
itayzafrir40835d42018-08-02 13:14:17 +03002177 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002178 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002179 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002180
2181 /* Fill the output buffer with something that isn't a valid hash
2182 * (barring an attack on the hash and deliberately-crafted input),
2183 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002184 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002185 /* If hash_size is 0 then hash may be NULL and then the
2186 * call to memset would have undefined behavior. */
2187 if( hash_size != 0 )
2188 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002189
2190 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002191 {
2192 status = PSA_ERROR_BUFFER_TOO_SMALL;
2193 goto exit;
2194 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002195
2196 switch( operation->alg )
2197 {
2198#if defined(MBEDTLS_MD2_C)
2199 case PSA_ALG_MD2:
2200 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2201 break;
2202#endif
2203#if defined(MBEDTLS_MD4_C)
2204 case PSA_ALG_MD4:
2205 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2206 break;
2207#endif
2208#if defined(MBEDTLS_MD5_C)
2209 case PSA_ALG_MD5:
2210 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2211 break;
2212#endif
2213#if defined(MBEDTLS_RIPEMD160_C)
2214 case PSA_ALG_RIPEMD160:
2215 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2216 break;
2217#endif
2218#if defined(MBEDTLS_SHA1_C)
2219 case PSA_ALG_SHA_1:
2220 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2221 break;
2222#endif
2223#if defined(MBEDTLS_SHA256_C)
2224 case PSA_ALG_SHA_224:
2225 case PSA_ALG_SHA_256:
2226 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2227 break;
2228#endif
2229#if defined(MBEDTLS_SHA512_C)
2230 case PSA_ALG_SHA_384:
2231 case PSA_ALG_SHA_512:
2232 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2233 break;
2234#endif
2235 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002236 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002237 }
itayzafrir40835d42018-08-02 13:14:17 +03002238 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002239
itayzafrir40835d42018-08-02 13:14:17 +03002240exit:
2241 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002242 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002243 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244 return( psa_hash_abort( operation ) );
2245 }
2246 else
2247 {
2248 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002249 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250 }
2251}
2252
Gilles Peskine2d277862018-06-18 15:41:12 +02002253psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2254 const uint8_t *hash,
2255 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002256{
2257 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2258 size_t actual_hash_length;
2259 psa_status_t status = psa_hash_finish( operation,
2260 actual_hash, sizeof( actual_hash ),
2261 &actual_hash_length );
2262 if( status != PSA_SUCCESS )
2263 return( status );
2264 if( actual_hash_length != hash_length )
2265 return( PSA_ERROR_INVALID_SIGNATURE );
2266 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2267 return( PSA_ERROR_INVALID_SIGNATURE );
2268 return( PSA_SUCCESS );
2269}
2270
Gilles Peskineeb35d782019-01-22 17:56:16 +01002271psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2272 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002273{
2274 if( target_operation->alg != 0 )
2275 return( PSA_ERROR_BAD_STATE );
2276
2277 switch( source_operation->alg )
2278 {
2279 case 0:
2280 return( PSA_ERROR_BAD_STATE );
2281#if defined(MBEDTLS_MD2_C)
2282 case PSA_ALG_MD2:
2283 mbedtls_md2_clone( &target_operation->ctx.md2,
2284 &source_operation->ctx.md2 );
2285 break;
2286#endif
2287#if defined(MBEDTLS_MD4_C)
2288 case PSA_ALG_MD4:
2289 mbedtls_md4_clone( &target_operation->ctx.md4,
2290 &source_operation->ctx.md4 );
2291 break;
2292#endif
2293#if defined(MBEDTLS_MD5_C)
2294 case PSA_ALG_MD5:
2295 mbedtls_md5_clone( &target_operation->ctx.md5,
2296 &source_operation->ctx.md5 );
2297 break;
2298#endif
2299#if defined(MBEDTLS_RIPEMD160_C)
2300 case PSA_ALG_RIPEMD160:
2301 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2302 &source_operation->ctx.ripemd160 );
2303 break;
2304#endif
2305#if defined(MBEDTLS_SHA1_C)
2306 case PSA_ALG_SHA_1:
2307 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2308 &source_operation->ctx.sha1 );
2309 break;
2310#endif
2311#if defined(MBEDTLS_SHA256_C)
2312 case PSA_ALG_SHA_224:
2313 case PSA_ALG_SHA_256:
2314 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2315 &source_operation->ctx.sha256 );
2316 break;
2317#endif
2318#if defined(MBEDTLS_SHA512_C)
2319 case PSA_ALG_SHA_384:
2320 case PSA_ALG_SHA_512:
2321 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2322 &source_operation->ctx.sha512 );
2323 break;
2324#endif
2325 default:
2326 return( PSA_ERROR_NOT_SUPPORTED );
2327 }
2328
2329 target_operation->alg = source_operation->alg;
2330 return( PSA_SUCCESS );
2331}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002332
2333
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002334/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002335/* MAC */
2336/****************************************************************/
2337
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002338static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002339 psa_algorithm_t alg,
2340 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002341 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002342 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002343{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002344 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002345 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002346
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002347 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002348 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002349
Gilles Peskine8c9def32018-02-08 10:02:12 +01002350 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2351 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002352 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002353 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002354 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002355 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002356 mode = MBEDTLS_MODE_STREAM;
2357 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002358 case PSA_ALG_CTR:
2359 mode = MBEDTLS_MODE_CTR;
2360 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002361 case PSA_ALG_CFB:
2362 mode = MBEDTLS_MODE_CFB;
2363 break;
2364 case PSA_ALG_OFB:
2365 mode = MBEDTLS_MODE_OFB;
2366 break;
2367 case PSA_ALG_CBC_NO_PADDING:
2368 mode = MBEDTLS_MODE_CBC;
2369 break;
2370 case PSA_ALG_CBC_PKCS7:
2371 mode = MBEDTLS_MODE_CBC;
2372 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002373 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002374 mode = MBEDTLS_MODE_CCM;
2375 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002376 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002377 mode = MBEDTLS_MODE_GCM;
2378 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002379 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2380 mode = MBEDTLS_MODE_CHACHAPOLY;
2381 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002382 default:
2383 return( NULL );
2384 }
2385 }
2386 else if( alg == PSA_ALG_CMAC )
2387 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002388 else
2389 return( NULL );
2390
2391 switch( key_type )
2392 {
2393 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002394 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002395 break;
2396 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002397 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2398 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002399 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002400 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002401 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002402 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002403 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2404 * but two-key Triple-DES is functionally three-key Triple-DES
2405 * with K1=K3, so that's how we present it to mbedtls. */
2406 if( key_bits == 128 )
2407 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002408 break;
2409 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002410 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002411 break;
2412 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002413 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002415 case PSA_KEY_TYPE_CHACHA20:
2416 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2417 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002418 default:
2419 return( NULL );
2420 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002421 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002422 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002423
Jaeden Amero23bbb752018-06-26 14:16:54 +01002424 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2425 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002426}
2427
Gilles Peskinea05219c2018-11-16 16:02:56 +01002428#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002429static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002430{
Gilles Peskine2d277862018-06-18 15:41:12 +02002431 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002432 {
2433 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002434 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002435 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002436 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002437 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002438 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002439 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002440 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002441 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002442 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002443 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002444 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002445 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002446 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002447 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002448 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002449 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002450 return( 128 );
2451 default:
2452 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002453 }
2454}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002455#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002456
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002457/* Initialize the MAC operation structure. Once this function has been
2458 * called, psa_mac_abort can run and will do the right thing. */
2459static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2460 psa_algorithm_t alg )
2461{
2462 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2463
2464 operation->alg = alg;
2465 operation->key_set = 0;
2466 operation->iv_set = 0;
2467 operation->iv_required = 0;
2468 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002469 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002470
2471#if defined(MBEDTLS_CMAC_C)
2472 if( alg == PSA_ALG_CMAC )
2473 {
2474 operation->iv_required = 0;
2475 mbedtls_cipher_init( &operation->ctx.cmac );
2476 status = PSA_SUCCESS;
2477 }
2478 else
2479#endif /* MBEDTLS_CMAC_C */
2480#if defined(MBEDTLS_MD_C)
2481 if( PSA_ALG_IS_HMAC( operation->alg ) )
2482 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002483 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2484 operation->ctx.hmac.hash_ctx.alg = 0;
2485 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002486 }
2487 else
2488#endif /* MBEDTLS_MD_C */
2489 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002490 if( ! PSA_ALG_IS_MAC( alg ) )
2491 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002492 }
2493
2494 if( status != PSA_SUCCESS )
2495 memset( operation, 0, sizeof( *operation ) );
2496 return( status );
2497}
2498
Gilles Peskine01126fa2018-07-12 17:04:55 +02002499#if defined(MBEDTLS_MD_C)
2500static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2501{
Gilles Peskine3f108122018-12-07 18:14:53 +01002502 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002503 return( psa_hash_abort( &hmac->hash_ctx ) );
2504}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002505
Janos Follath999f6482019-06-11 12:04:10 +01002506#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002507static void psa_hmac_init_internal( psa_hmac_internal_data *hmac )
2508{
2509 /* Instances of psa_hash_operation_s can be initialized by zeroization. */
2510 memset( hmac, 0, sizeof( *hmac ) );
2511}
Janos Follath999f6482019-06-11 12:04:10 +01002512#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002513#endif /* MBEDTLS_MD_C */
2514
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2516{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002517 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002518 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002519 /* The object has (apparently) been initialized but it is not
2520 * in use. It's ok to call abort on such an object, and there's
2521 * nothing to do. */
2522 return( PSA_SUCCESS );
2523 }
2524 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002525#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002526 if( operation->alg == PSA_ALG_CMAC )
2527 {
2528 mbedtls_cipher_free( &operation->ctx.cmac );
2529 }
2530 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002531#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002532#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002533 if( PSA_ALG_IS_HMAC( operation->alg ) )
2534 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002535 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002536 }
2537 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002538#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002539 {
2540 /* Sanity check (shouldn't happen: operation->alg should
2541 * always have been initialized to a valid value). */
2542 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002543 }
Moran Peker41deec42018-04-04 15:43:05 +03002544
Gilles Peskine8c9def32018-02-08 10:02:12 +01002545 operation->alg = 0;
2546 operation->key_set = 0;
2547 operation->iv_set = 0;
2548 operation->iv_required = 0;
2549 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002550 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002551
Gilles Peskine8c9def32018-02-08 10:02:12 +01002552 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002553
2554bad_state:
2555 /* If abort is called on an uninitialized object, we can't trust
2556 * anything. Wipe the object in case it contains confidential data.
2557 * This may result in a memory leak if a pointer gets overwritten,
2558 * but it's too late to do anything about this. */
2559 memset( operation, 0, sizeof( *operation ) );
2560 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561}
2562
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002563#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002564static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002565 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002566 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002567 const mbedtls_cipher_info_t *cipher_info )
2568{
2569 int ret;
2570
2571 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002572
2573 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2574 if( ret != 0 )
2575 return( ret );
2576
2577 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2578 slot->data.raw.data,
2579 key_bits );
2580 return( ret );
2581}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002582#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002583
Gilles Peskine248051a2018-06-20 16:09:38 +02002584#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002585static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2586 const uint8_t *key,
2587 size_t key_length,
2588 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002589{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002590 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002591 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002592 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002593 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002594 psa_status_t status;
2595
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002596 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2597 * overflow below. This should never trigger if the hash algorithm
2598 * is implemented correctly. */
2599 /* The size checks against the ipad and opad buffers cannot be written
2600 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2601 * because that triggers -Wlogical-op on GCC 7.3. */
2602 if( block_size > sizeof( ipad ) )
2603 return( PSA_ERROR_NOT_SUPPORTED );
2604 if( block_size > sizeof( hmac->opad ) )
2605 return( PSA_ERROR_NOT_SUPPORTED );
2606 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002607 return( PSA_ERROR_NOT_SUPPORTED );
2608
Gilles Peskined223b522018-06-11 18:12:58 +02002609 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002610 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002611 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002612 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002613 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002614 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002615 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002616 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002617 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002618 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002619 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002620 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002621 }
Gilles Peskine96889972018-07-12 17:07:03 +02002622 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2623 * but it is permitted. It is common when HMAC is used in HKDF, for
2624 * example. Don't call `memcpy` in the 0-length because `key` could be
2625 * an invalid pointer which would make the behavior undefined. */
2626 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002627 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002628
Gilles Peskined223b522018-06-11 18:12:58 +02002629 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2630 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002631 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002632 ipad[i] ^= 0x36;
2633 memset( ipad + key_length, 0x36, block_size - key_length );
2634
2635 /* Copy the key material from ipad to opad, flipping the requisite bits,
2636 * and filling the rest of opad with the requisite constant. */
2637 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002638 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2639 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002640
Gilles Peskine01126fa2018-07-12 17:04:55 +02002641 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002642 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002643 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002644
Gilles Peskine01126fa2018-07-12 17:04:55 +02002645 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002646
2647cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002648 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002649
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002650 return( status );
2651}
Gilles Peskine248051a2018-06-20 16:09:38 +02002652#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002653
Gilles Peskine89167cb2018-07-08 20:12:23 +02002654static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002655 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002656 psa_algorithm_t alg,
2657 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002659 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002660 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002661 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002662 psa_key_usage_t usage =
2663 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002664 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002665 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002666
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002667 /* A context must be freshly initialized before it can be set up. */
2668 if( operation->alg != 0 )
2669 {
2670 return( PSA_ERROR_BAD_STATE );
2671 }
2672
Gilles Peskined911eb72018-08-14 15:18:45 +02002673 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002674 if( status != PSA_SUCCESS )
2675 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002676 if( is_sign )
2677 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002678
Gilles Peskine28f8f302019-07-24 13:30:31 +02002679 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002680 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002681 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002682 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002683
Gilles Peskine8c9def32018-02-08 10:02:12 +01002684#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002685 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002686 {
2687 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002688 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002689 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002690 int ret;
2691 if( cipher_info == NULL )
2692 {
2693 status = PSA_ERROR_NOT_SUPPORTED;
2694 goto exit;
2695 }
2696 operation->mac_size = cipher_info->block_size;
2697 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2698 status = mbedtls_to_psa_error( ret );
2699 }
2700 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002701#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002702#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002703 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002704 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002705 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002706 if( hash_alg == 0 )
2707 {
2708 status = PSA_ERROR_NOT_SUPPORTED;
2709 goto exit;
2710 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002711
2712 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2713 /* Sanity check. This shouldn't fail on a valid configuration. */
2714 if( operation->mac_size == 0 ||
2715 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2716 {
2717 status = PSA_ERROR_NOT_SUPPORTED;
2718 goto exit;
2719 }
2720
Gilles Peskine8e338702019-07-30 20:06:31 +02002721 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002722 {
2723 status = PSA_ERROR_INVALID_ARGUMENT;
2724 goto exit;
2725 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002726
Gilles Peskine01126fa2018-07-12 17:04:55 +02002727 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2728 slot->data.raw.data,
2729 slot->data.raw.bytes,
2730 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002731 }
2732 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002734 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002735 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002736 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002737 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002738
Gilles Peskined911eb72018-08-14 15:18:45 +02002739 if( truncated == 0 )
2740 {
2741 /* The "normal" case: untruncated algorithm. Nothing to do. */
2742 }
2743 else if( truncated < 4 )
2744 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002745 /* A very short MAC is too short for security since it can be
2746 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2747 * so we make this our minimum, even though 32 bits is still
2748 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002749 status = PSA_ERROR_NOT_SUPPORTED;
2750 }
2751 else if( truncated > operation->mac_size )
2752 {
2753 /* It's impossible to "truncate" to a larger length. */
2754 status = PSA_ERROR_INVALID_ARGUMENT;
2755 }
2756 else
2757 operation->mac_size = truncated;
2758
Gilles Peskinefbfac682018-07-08 20:51:54 +02002759exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002760 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002761 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002762 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002763 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002764 else
2765 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002766 operation->key_set = 1;
2767 }
2768 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002769}
2770
Gilles Peskine89167cb2018-07-08 20:12:23 +02002771psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002772 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002773 psa_algorithm_t alg )
2774{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002775 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002776}
2777
2778psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002779 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002780 psa_algorithm_t alg )
2781{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002782 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002783}
2784
Gilles Peskine8c9def32018-02-08 10:02:12 +01002785psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2786 const uint8_t *input,
2787 size_t input_length )
2788{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002789 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002790 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002791 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002792 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002793 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002794 operation->has_input = 1;
2795
Gilles Peskine8c9def32018-02-08 10:02:12 +01002796#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002797 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002798 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002799 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2800 input, input_length );
2801 status = mbedtls_to_psa_error( ret );
2802 }
2803 else
2804#endif /* MBEDTLS_CMAC_C */
2805#if defined(MBEDTLS_MD_C)
2806 if( PSA_ALG_IS_HMAC( operation->alg ) )
2807 {
2808 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2809 input_length );
2810 }
2811 else
2812#endif /* MBEDTLS_MD_C */
2813 {
2814 /* This shouldn't happen if `operation` was initialized by
2815 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002816 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002817 }
2818
Gilles Peskinefbfac682018-07-08 20:51:54 +02002819 if( status != PSA_SUCCESS )
2820 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002821 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002822}
2823
Gilles Peskine01126fa2018-07-12 17:04:55 +02002824#if defined(MBEDTLS_MD_C)
2825static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2826 uint8_t *mac,
2827 size_t mac_size )
2828{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002829 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002830 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2831 size_t hash_size = 0;
2832 size_t block_size = psa_get_hash_block_size( hash_alg );
2833 psa_status_t status;
2834
Gilles Peskine01126fa2018-07-12 17:04:55 +02002835 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2836 if( status != PSA_SUCCESS )
2837 return( status );
2838 /* From here on, tmp needs to be wiped. */
2839
2840 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2841 if( status != PSA_SUCCESS )
2842 goto exit;
2843
2844 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2845 if( status != PSA_SUCCESS )
2846 goto exit;
2847
2848 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2849 if( status != PSA_SUCCESS )
2850 goto exit;
2851
Gilles Peskined911eb72018-08-14 15:18:45 +02002852 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2853 if( status != PSA_SUCCESS )
2854 goto exit;
2855
2856 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002857
2858exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002859 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002860 return( status );
2861}
2862#endif /* MBEDTLS_MD_C */
2863
mohammad16036df908f2018-04-02 08:34:15 -07002864static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002865 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002866 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002867{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002868 if( ! operation->key_set )
2869 return( PSA_ERROR_BAD_STATE );
2870 if( operation->iv_required && ! operation->iv_set )
2871 return( PSA_ERROR_BAD_STATE );
2872
Gilles Peskine8c9def32018-02-08 10:02:12 +01002873 if( mac_size < operation->mac_size )
2874 return( PSA_ERROR_BUFFER_TOO_SMALL );
2875
Gilles Peskine8c9def32018-02-08 10:02:12 +01002876#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002877 if( operation->alg == PSA_ALG_CMAC )
2878 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002879 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2880 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2881 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002882 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002883 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002884 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002885 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002886 else
2887#endif /* MBEDTLS_CMAC_C */
2888#if defined(MBEDTLS_MD_C)
2889 if( PSA_ALG_IS_HMAC( operation->alg ) )
2890 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002891 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002892 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002893 }
2894 else
2895#endif /* MBEDTLS_MD_C */
2896 {
2897 /* This shouldn't happen if `operation` was initialized by
2898 * a setup function. */
2899 return( PSA_ERROR_BAD_STATE );
2900 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002901}
2902
Gilles Peskineacd4be32018-07-08 19:56:25 +02002903psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2904 uint8_t *mac,
2905 size_t mac_size,
2906 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002907{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002908 psa_status_t status;
2909
Jaeden Amero252ef282019-02-15 14:05:35 +00002910 if( operation->alg == 0 )
2911 {
2912 return( PSA_ERROR_BAD_STATE );
2913 }
2914
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002915 /* Fill the output buffer with something that isn't a valid mac
2916 * (barring an attack on the mac and deliberately-crafted input),
2917 * in case the caller doesn't check the return status properly. */
2918 *mac_length = mac_size;
2919 /* If mac_size is 0 then mac may be NULL and then the
2920 * call to memset would have undefined behavior. */
2921 if( mac_size != 0 )
2922 memset( mac, '!', mac_size );
2923
Gilles Peskine89167cb2018-07-08 20:12:23 +02002924 if( ! operation->is_sign )
2925 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002926 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002927 }
mohammad16036df908f2018-04-02 08:34:15 -07002928
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002929 status = psa_mac_finish_internal( operation, mac, mac_size );
2930
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002931 if( status == PSA_SUCCESS )
2932 {
2933 status = psa_mac_abort( operation );
2934 if( status == PSA_SUCCESS )
2935 *mac_length = operation->mac_size;
2936 else
2937 memset( mac, '!', mac_size );
2938 }
2939 else
2940 psa_mac_abort( operation );
2941 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002942}
2943
Gilles Peskineacd4be32018-07-08 19:56:25 +02002944psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2945 const uint8_t *mac,
2946 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002947{
Gilles Peskine828ed142018-06-18 23:25:51 +02002948 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002949 psa_status_t status;
2950
Jaeden Amero252ef282019-02-15 14:05:35 +00002951 if( operation->alg == 0 )
2952 {
2953 return( PSA_ERROR_BAD_STATE );
2954 }
2955
Gilles Peskine89167cb2018-07-08 20:12:23 +02002956 if( operation->is_sign )
2957 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002958 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002959 }
2960 if( operation->mac_size != mac_length )
2961 {
2962 status = PSA_ERROR_INVALID_SIGNATURE;
2963 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002964 }
mohammad16036df908f2018-04-02 08:34:15 -07002965
2966 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002967 actual_mac, sizeof( actual_mac ) );
2968
2969 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2970 status = PSA_ERROR_INVALID_SIGNATURE;
2971
2972cleanup:
2973 if( status == PSA_SUCCESS )
2974 status = psa_mac_abort( operation );
2975 else
2976 psa_mac_abort( operation );
2977
Gilles Peskine3f108122018-12-07 18:14:53 +01002978 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002979
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002980 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002981}
2982
2983
Gilles Peskine20035e32018-02-03 22:44:14 +01002984
Gilles Peskine20035e32018-02-03 22:44:14 +01002985/****************************************************************/
2986/* Asymmetric cryptography */
2987/****************************************************************/
2988
Gilles Peskine2b450e32018-06-27 15:42:46 +02002989#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002990/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002991 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002992static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
2993 size_t hash_length,
2994 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002995{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02002996 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002997 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002998 *md_alg = mbedtls_md_get_type( md_info );
2999
3000 /* The Mbed TLS RSA module uses an unsigned int for hash length
3001 * parameters. Validate that it fits so that we don't risk an
3002 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003003#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003004 if( hash_length > UINT_MAX )
3005 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003006#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003007
3008#if defined(MBEDTLS_PKCS1_V15)
3009 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3010 * must be correct. */
3011 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3012 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003013 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003014 if( md_info == NULL )
3015 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003016 if( mbedtls_md_get_size( md_info ) != hash_length )
3017 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003018 }
3019#endif /* MBEDTLS_PKCS1_V15 */
3020
3021#if defined(MBEDTLS_PKCS1_V21)
3022 /* PSS requires a hash internally. */
3023 if( PSA_ALG_IS_RSA_PSS( alg ) )
3024 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003025 if( md_info == NULL )
3026 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003027 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003028#endif /* MBEDTLS_PKCS1_V21 */
3029
Gilles Peskine61b91d42018-06-08 16:09:36 +02003030 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003031}
3032
Gilles Peskine2b450e32018-06-27 15:42:46 +02003033static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3034 psa_algorithm_t alg,
3035 const uint8_t *hash,
3036 size_t hash_length,
3037 uint8_t *signature,
3038 size_t signature_size,
3039 size_t *signature_length )
3040{
3041 psa_status_t status;
3042 int ret;
3043 mbedtls_md_type_t md_alg;
3044
3045 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3046 if( status != PSA_SUCCESS )
3047 return( status );
3048
Gilles Peskine630a18a2018-06-29 17:49:35 +02003049 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003050 return( PSA_ERROR_BUFFER_TOO_SMALL );
3051
3052#if defined(MBEDTLS_PKCS1_V15)
3053 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3054 {
3055 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3056 MBEDTLS_MD_NONE );
3057 ret = mbedtls_rsa_pkcs1_sign( rsa,
3058 mbedtls_ctr_drbg_random,
3059 &global_data.ctr_drbg,
3060 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003061 md_alg,
3062 (unsigned int) hash_length,
3063 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003064 signature );
3065 }
3066 else
3067#endif /* MBEDTLS_PKCS1_V15 */
3068#if defined(MBEDTLS_PKCS1_V21)
3069 if( PSA_ALG_IS_RSA_PSS( alg ) )
3070 {
3071 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3072 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3073 mbedtls_ctr_drbg_random,
3074 &global_data.ctr_drbg,
3075 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003076 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003077 (unsigned int) hash_length,
3078 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003079 signature );
3080 }
3081 else
3082#endif /* MBEDTLS_PKCS1_V21 */
3083 {
3084 return( PSA_ERROR_INVALID_ARGUMENT );
3085 }
3086
3087 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003088 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003089 return( mbedtls_to_psa_error( ret ) );
3090}
3091
3092static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3093 psa_algorithm_t alg,
3094 const uint8_t *hash,
3095 size_t hash_length,
3096 const uint8_t *signature,
3097 size_t signature_length )
3098{
3099 psa_status_t status;
3100 int ret;
3101 mbedtls_md_type_t md_alg;
3102
3103 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3104 if( status != PSA_SUCCESS )
3105 return( status );
3106
Gilles Peskine630a18a2018-06-29 17:49:35 +02003107 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003108 return( PSA_ERROR_BUFFER_TOO_SMALL );
3109
3110#if defined(MBEDTLS_PKCS1_V15)
3111 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3112 {
3113 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3114 MBEDTLS_MD_NONE );
3115 ret = mbedtls_rsa_pkcs1_verify( rsa,
3116 mbedtls_ctr_drbg_random,
3117 &global_data.ctr_drbg,
3118 MBEDTLS_RSA_PUBLIC,
3119 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003120 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003121 hash,
3122 signature );
3123 }
3124 else
3125#endif /* MBEDTLS_PKCS1_V15 */
3126#if defined(MBEDTLS_PKCS1_V21)
3127 if( PSA_ALG_IS_RSA_PSS( alg ) )
3128 {
3129 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3130 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3131 mbedtls_ctr_drbg_random,
3132 &global_data.ctr_drbg,
3133 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003134 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003135 (unsigned int) hash_length,
3136 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003137 signature );
3138 }
3139 else
3140#endif /* MBEDTLS_PKCS1_V21 */
3141 {
3142 return( PSA_ERROR_INVALID_ARGUMENT );
3143 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003144
3145 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3146 * the rest of the signature is invalid". This has little use in
3147 * practice and PSA doesn't report this distinction. */
3148 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3149 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003150 return( mbedtls_to_psa_error( ret ) );
3151}
3152#endif /* MBEDTLS_RSA_C */
3153
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003154#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003155/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3156 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3157 * (even though these functions don't modify it). */
3158static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3159 psa_algorithm_t alg,
3160 const uint8_t *hash,
3161 size_t hash_length,
3162 uint8_t *signature,
3163 size_t signature_size,
3164 size_t *signature_length )
3165{
3166 int ret;
3167 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003168 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003169 mbedtls_mpi_init( &r );
3170 mbedtls_mpi_init( &s );
3171
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003172 if( signature_size < 2 * curve_bytes )
3173 {
3174 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3175 goto cleanup;
3176 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003177
Gilles Peskinea05219c2018-11-16 16:02:56 +01003178#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003179 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3180 {
3181 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3182 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3183 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3184 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det( &ecp->grp, &r, &s, &ecp->d,
3185 hash, hash_length,
3186 md_alg ) );
3187 }
3188 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003189#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003190 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003191 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003192 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3193 hash, hash_length,
3194 mbedtls_ctr_drbg_random,
3195 &global_data.ctr_drbg ) );
3196 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003197
3198 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3199 signature,
3200 curve_bytes ) );
3201 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3202 signature + curve_bytes,
3203 curve_bytes ) );
3204
3205cleanup:
3206 mbedtls_mpi_free( &r );
3207 mbedtls_mpi_free( &s );
3208 if( ret == 0 )
3209 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003210 return( mbedtls_to_psa_error( ret ) );
3211}
3212
3213static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3214 const uint8_t *hash,
3215 size_t hash_length,
3216 const uint8_t *signature,
3217 size_t signature_length )
3218{
3219 int ret;
3220 mbedtls_mpi r, s;
3221 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3222 mbedtls_mpi_init( &r );
3223 mbedtls_mpi_init( &s );
3224
3225 if( signature_length != 2 * curve_bytes )
3226 return( PSA_ERROR_INVALID_SIGNATURE );
3227
3228 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3229 signature,
3230 curve_bytes ) );
3231 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3232 signature + curve_bytes,
3233 curve_bytes ) );
3234
3235 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3236 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003237
3238cleanup:
3239 mbedtls_mpi_free( &r );
3240 mbedtls_mpi_free( &s );
3241 return( mbedtls_to_psa_error( ret ) );
3242}
3243#endif /* MBEDTLS_ECDSA_C */
3244
Gilles Peskinec5487a82018-12-03 18:08:14 +01003245psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003246 psa_algorithm_t alg,
3247 const uint8_t *hash,
3248 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003249 uint8_t *signature,
3250 size_t signature_size,
3251 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003252{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003253 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003254 psa_status_t status;
3255
3256 *signature_length = signature_size;
3257
Gilles Peskine28f8f302019-07-24 13:30:31 +02003258 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003259 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003260 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003261 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003262 {
3263 status = PSA_ERROR_INVALID_ARGUMENT;
3264 goto exit;
3265 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003266
Gilles Peskine20035e32018-02-03 22:44:14 +01003267#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003268 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003269 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003270 status = psa_rsa_sign( slot->data.rsa,
3271 alg,
3272 hash, hash_length,
3273 signature, signature_size,
3274 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003275 }
3276 else
3277#endif /* defined(MBEDTLS_RSA_C) */
3278#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003279 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003280 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003281#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003282 if(
3283#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3284 PSA_ALG_IS_ECDSA( alg )
3285#else
3286 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3287#endif
3288 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003289 status = psa_ecdsa_sign( slot->data.ecp,
3290 alg,
3291 hash, hash_length,
3292 signature, signature_size,
3293 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003294 else
3295#endif /* defined(MBEDTLS_ECDSA_C) */
3296 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003297 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003298 }
itayzafrir5c753392018-05-08 11:18:38 +03003299 }
3300 else
3301#endif /* defined(MBEDTLS_ECP_C) */
3302 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003303 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003304 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003305
3306exit:
3307 /* Fill the unused part of the output buffer (the whole buffer on error,
3308 * the trailing part on success) with something that isn't a valid mac
3309 * (barring an attack on the mac and deliberately-crafted input),
3310 * in case the caller doesn't check the return status properly. */
3311 if( status == PSA_SUCCESS )
3312 memset( signature + *signature_length, '!',
3313 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003314 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003315 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003316 /* If signature_size is 0 then we have nothing to do. We must not call
3317 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003318 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003319}
3320
Gilles Peskinec5487a82018-12-03 18:08:14 +01003321psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03003322 psa_algorithm_t alg,
3323 const uint8_t *hash,
3324 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02003325 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02003326 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003327{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003328 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003329 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003330
Gilles Peskine28f8f302019-07-24 13:30:31 +02003331 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003332 if( status != PSA_SUCCESS )
3333 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003334
Gilles Peskine61b91d42018-06-08 16:09:36 +02003335#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003336 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003337 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003338 return( psa_rsa_verify( slot->data.rsa,
3339 alg,
3340 hash, hash_length,
3341 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003342 }
3343 else
3344#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003345#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003346 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003347 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003348#if defined(MBEDTLS_ECDSA_C)
3349 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003350 return( psa_ecdsa_verify( slot->data.ecp,
3351 hash, hash_length,
3352 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003353 else
3354#endif /* defined(MBEDTLS_ECDSA_C) */
3355 {
3356 return( PSA_ERROR_INVALID_ARGUMENT );
3357 }
itayzafrir5c753392018-05-08 11:18:38 +03003358 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003359 else
3360#endif /* defined(MBEDTLS_ECP_C) */
3361 {
3362 return( PSA_ERROR_NOT_SUPPORTED );
3363 }
3364}
3365
Gilles Peskine072ac562018-06-30 00:21:29 +02003366#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3367static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3368 mbedtls_rsa_context *rsa )
3369{
3370 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3371 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3372 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3373 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3374}
3375#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3376
Gilles Peskinec5487a82018-12-03 18:08:14 +01003377psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003378 psa_algorithm_t alg,
3379 const uint8_t *input,
3380 size_t input_length,
3381 const uint8_t *salt,
3382 size_t salt_length,
3383 uint8_t *output,
3384 size_t output_size,
3385 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003386{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003387 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003388 psa_status_t status;
3389
Darryl Green5cc689a2018-07-24 15:34:10 +01003390 (void) input;
3391 (void) input_length;
3392 (void) salt;
3393 (void) output;
3394 (void) output_size;
3395
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003396 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003397
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003398 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3399 return( PSA_ERROR_INVALID_ARGUMENT );
3400
Gilles Peskine28f8f302019-07-24 13:30:31 +02003401 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003402 if( status != PSA_SUCCESS )
3403 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003404 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3405 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003406 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003407
3408#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003409 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003410 {
3411 mbedtls_rsa_context *rsa = slot->data.rsa;
3412 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003413 if( output_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine61b91d42018-06-08 16:09:36 +02003414 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003415#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003416 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003417 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003418 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3419 mbedtls_ctr_drbg_random,
3420 &global_data.ctr_drbg,
3421 MBEDTLS_RSA_PUBLIC,
3422 input_length,
3423 input,
3424 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003425 }
3426 else
3427#endif /* MBEDTLS_PKCS1_V15 */
3428#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003429 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003430 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003431 psa_rsa_oaep_set_padding_mode( alg, rsa );
3432 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3433 mbedtls_ctr_drbg_random,
3434 &global_data.ctr_drbg,
3435 MBEDTLS_RSA_PUBLIC,
3436 salt, salt_length,
3437 input_length,
3438 input,
3439 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003440 }
3441 else
3442#endif /* MBEDTLS_PKCS1_V21 */
3443 {
3444 return( PSA_ERROR_INVALID_ARGUMENT );
3445 }
3446 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003447 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003448 return( mbedtls_to_psa_error( ret ) );
3449 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003450 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003451#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003452 {
3453 return( PSA_ERROR_NOT_SUPPORTED );
3454 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003455}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003456
Gilles Peskinec5487a82018-12-03 18:08:14 +01003457psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003458 psa_algorithm_t alg,
3459 const uint8_t *input,
3460 size_t input_length,
3461 const uint8_t *salt,
3462 size_t salt_length,
3463 uint8_t *output,
3464 size_t output_size,
3465 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003466{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003467 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003468 psa_status_t status;
3469
Darryl Green5cc689a2018-07-24 15:34:10 +01003470 (void) input;
3471 (void) input_length;
3472 (void) salt;
3473 (void) output;
3474 (void) output_size;
3475
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003476 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003477
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003478 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3479 return( PSA_ERROR_INVALID_ARGUMENT );
3480
Gilles Peskine28f8f302019-07-24 13:30:31 +02003481 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003482 if( status != PSA_SUCCESS )
3483 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003484 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003485 return( PSA_ERROR_INVALID_ARGUMENT );
3486
3487#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003488 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003489 {
3490 mbedtls_rsa_context *rsa = slot->data.rsa;
3491 int ret;
3492
Gilles Peskine630a18a2018-06-29 17:49:35 +02003493 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003494 return( PSA_ERROR_INVALID_ARGUMENT );
3495
3496#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003497 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003498 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003499 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3500 mbedtls_ctr_drbg_random,
3501 &global_data.ctr_drbg,
3502 MBEDTLS_RSA_PRIVATE,
3503 output_length,
3504 input,
3505 output,
3506 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003507 }
3508 else
3509#endif /* MBEDTLS_PKCS1_V15 */
3510#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003511 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003512 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003513 psa_rsa_oaep_set_padding_mode( alg, rsa );
3514 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3515 mbedtls_ctr_drbg_random,
3516 &global_data.ctr_drbg,
3517 MBEDTLS_RSA_PRIVATE,
3518 salt, salt_length,
3519 output_length,
3520 input,
3521 output,
3522 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003523 }
3524 else
3525#endif /* MBEDTLS_PKCS1_V21 */
3526 {
3527 return( PSA_ERROR_INVALID_ARGUMENT );
3528 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003529
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003530 return( mbedtls_to_psa_error( ret ) );
3531 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003532 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003533#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003534 {
3535 return( PSA_ERROR_NOT_SUPPORTED );
3536 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003537}
Gilles Peskine20035e32018-02-03 22:44:14 +01003538
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003539
3540
mohammad1603503973b2018-03-12 15:59:30 +02003541/****************************************************************/
3542/* Symmetric cryptography */
3543/****************************************************************/
3544
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003545/* Initialize the cipher operation structure. Once this function has been
3546 * called, psa_cipher_abort can run and will do the right thing. */
3547static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3548 psa_algorithm_t alg )
3549{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003550 if( ! PSA_ALG_IS_CIPHER( alg ) )
3551 {
3552 memset( operation, 0, sizeof( *operation ) );
3553 return( PSA_ERROR_INVALID_ARGUMENT );
3554 }
3555
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003556 operation->alg = alg;
3557 operation->key_set = 0;
3558 operation->iv_set = 0;
3559 operation->iv_required = 1;
3560 operation->iv_size = 0;
3561 operation->block_size = 0;
3562 mbedtls_cipher_init( &operation->ctx.cipher );
3563 return( PSA_SUCCESS );
3564}
3565
Gilles Peskinee553c652018-06-04 16:22:46 +02003566static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003567 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003568 psa_algorithm_t alg,
3569 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003570{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003571 int ret = 0;
3572 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003573 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003574 size_t key_bits;
3575 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003576 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3577 PSA_KEY_USAGE_ENCRYPT :
3578 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003579
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003580 /* A context must be freshly initialized before it can be set up. */
3581 if( operation->alg != 0 )
3582 {
3583 return( PSA_ERROR_BAD_STATE );
3584 }
3585
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003586 status = psa_cipher_init( operation, alg );
3587 if( status != PSA_SUCCESS )
3588 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003589
Gilles Peskine28f8f302019-07-24 13:30:31 +02003590 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003591 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003592 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003593 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003594
Gilles Peskine8e338702019-07-30 20:06:31 +02003595 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003596 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003597 {
3598 status = PSA_ERROR_NOT_SUPPORTED;
3599 goto exit;
3600 }
mohammad1603503973b2018-03-12 15:59:30 +02003601
mohammad1603503973b2018-03-12 15:59:30 +02003602 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003603 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003604 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003605
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003606#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003607 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003608 {
3609 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003610 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003611 memcpy( keys, slot->data.raw.data, 16 );
3612 memcpy( keys + 16, slot->data.raw.data, 8 );
3613 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3614 keys,
3615 192, cipher_operation );
3616 }
3617 else
3618#endif
3619 {
3620 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3621 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003622 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003623 }
Moran Peker41deec42018-04-04 15:43:05 +03003624 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003625 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003626
mohammad16038481e742018-03-18 13:57:31 +02003627#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003628 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003629 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003630 case PSA_ALG_CBC_NO_PADDING:
3631 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3632 MBEDTLS_PADDING_NONE );
3633 break;
3634 case PSA_ALG_CBC_PKCS7:
3635 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3636 MBEDTLS_PADDING_PKCS7 );
3637 break;
3638 default:
3639 /* The algorithm doesn't involve padding. */
3640 ret = 0;
3641 break;
3642 }
3643 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003644 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003645#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3646
mohammad1603503973b2018-03-12 15:59:30 +02003647 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003648 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003649 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003650 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003651 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003652 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003653 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003654#if defined(MBEDTLS_CHACHA20_C)
3655 else
3656 if( alg == PSA_ALG_CHACHA20 )
3657 operation->iv_size = 12;
3658#endif
mohammad1603503973b2018-03-12 15:59:30 +02003659
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003660exit:
3661 if( status == 0 )
3662 status = mbedtls_to_psa_error( ret );
3663 if( status != 0 )
3664 psa_cipher_abort( operation );
3665 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003666}
3667
Gilles Peskinefe119512018-07-08 21:39:34 +02003668psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003669 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003670 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003671{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003672 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003673}
3674
Gilles Peskinefe119512018-07-08 21:39:34 +02003675psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003676 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003677 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003678{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003679 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003680}
3681
Gilles Peskinefe119512018-07-08 21:39:34 +02003682psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003683 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003684 size_t iv_size,
3685 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003686{
itayzafrir534bd7c2018-08-02 13:56:32 +03003687 psa_status_t status;
3688 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003689 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003690 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003691 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003692 }
Moran Peker41deec42018-04-04 15:43:05 +03003693 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003694 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003695 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003696 goto exit;
3697 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003698 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3699 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003700 if( ret != 0 )
3701 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003702 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003703 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003704 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003705
mohammad16038481e742018-03-18 13:57:31 +02003706 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003707 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003708
Moran Peker395db872018-05-31 14:07:14 +03003709exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003710 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003711 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003712 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003713}
3714
Gilles Peskinefe119512018-07-08 21:39:34 +02003715psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003716 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003717 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003718{
itayzafrir534bd7c2018-08-02 13:56:32 +03003719 psa_status_t status;
3720 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003721 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003722 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003723 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003724 }
Moran Pekera28258c2018-05-29 16:25:04 +03003725 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003726 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003727 status = PSA_ERROR_INVALID_ARGUMENT;
3728 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003729 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003730 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3731 status = mbedtls_to_psa_error( ret );
3732exit:
3733 if( status == PSA_SUCCESS )
3734 operation->iv_set = 1;
3735 else
mohammad1603503973b2018-03-12 15:59:30 +02003736 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003737 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003738}
3739
Gilles Peskinee553c652018-06-04 16:22:46 +02003740psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3741 const uint8_t *input,
3742 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003743 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003744 size_t output_size,
3745 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003746{
itayzafrir534bd7c2018-08-02 13:56:32 +03003747 psa_status_t status;
3748 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003749 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003750
3751 if( operation->alg == 0 )
3752 {
3753 return( PSA_ERROR_BAD_STATE );
3754 }
3755
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003756 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003757 {
3758 /* Take the unprocessed partial block left over from previous
3759 * update calls, if any, plus the input to this call. Remove
3760 * the last partial block, if any. You get the data that will be
3761 * output in this call. */
3762 expected_output_size =
3763 ( operation->ctx.cipher.unprocessed_len + input_length )
3764 / operation->block_size * operation->block_size;
3765 }
3766 else
3767 {
3768 expected_output_size = input_length;
3769 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003770
Gilles Peskine89d789c2018-06-04 17:17:16 +02003771 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003772 {
3773 status = PSA_ERROR_BUFFER_TOO_SMALL;
3774 goto exit;
3775 }
mohammad160382759612018-03-12 18:16:40 +02003776
mohammad1603503973b2018-03-12 15:59:30 +02003777 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003778 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003779 status = mbedtls_to_psa_error( ret );
3780exit:
3781 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003782 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003783 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003784}
3785
Gilles Peskinee553c652018-06-04 16:22:46 +02003786psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3787 uint8_t *output,
3788 size_t output_size,
3789 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003790{
David Saadab4ecc272019-02-14 13:48:10 +02003791 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003792 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003793 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003794
mohammad1603503973b2018-03-12 15:59:30 +02003795 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003796 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003797 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003798 }
3799 if( operation->iv_required && ! operation->iv_set )
3800 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003801 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003802 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003803
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003804 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003805 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3806 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003807 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003808 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003809 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003810 }
3811
Janos Follath315b51c2018-07-09 16:04:51 +01003812 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3813 temp_output_buffer,
3814 output_length );
3815 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003816 {
Janos Follath315b51c2018-07-09 16:04:51 +01003817 status = mbedtls_to_psa_error( cipher_ret );
3818 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003819 }
Janos Follath315b51c2018-07-09 16:04:51 +01003820
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003821 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003822 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003823 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003824 memcpy( output, temp_output_buffer, *output_length );
3825 else
3826 {
Janos Follath315b51c2018-07-09 16:04:51 +01003827 status = PSA_ERROR_BUFFER_TOO_SMALL;
3828 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003829 }
mohammad1603503973b2018-03-12 15:59:30 +02003830
Gilles Peskine3f108122018-12-07 18:14:53 +01003831 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003832 status = psa_cipher_abort( operation );
3833
3834 return( status );
3835
3836error:
3837
3838 *output_length = 0;
3839
Gilles Peskine3f108122018-12-07 18:14:53 +01003840 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003841 (void) psa_cipher_abort( operation );
3842
3843 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003844}
3845
Gilles Peskinee553c652018-06-04 16:22:46 +02003846psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3847{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003848 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003849 {
3850 /* The object has (apparently) been initialized but it is not
3851 * in use. It's ok to call abort on such an object, and there's
3852 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003853 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003854 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003855
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003856 /* Sanity check (shouldn't happen: operation->alg should
3857 * always have been initialized to a valid value). */
3858 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3859 return( PSA_ERROR_BAD_STATE );
3860
mohammad1603503973b2018-03-12 15:59:30 +02003861 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003862
Moran Peker41deec42018-04-04 15:43:05 +03003863 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003864 operation->key_set = 0;
3865 operation->iv_set = 0;
3866 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003867 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003868 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003869
Moran Peker395db872018-05-31 14:07:14 +03003870 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003871}
3872
Gilles Peskinea0655c32018-04-30 17:06:50 +02003873
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003874
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003875
mohammad16035955c982018-04-26 00:53:03 +03003876/****************************************************************/
3877/* AEAD */
3878/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003879
Gilles Peskineedf9a652018-08-17 18:11:56 +02003880typedef struct
3881{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003882 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003883 const mbedtls_cipher_info_t *cipher_info;
3884 union
3885 {
3886#if defined(MBEDTLS_CCM_C)
3887 mbedtls_ccm_context ccm;
3888#endif /* MBEDTLS_CCM_C */
3889#if defined(MBEDTLS_GCM_C)
3890 mbedtls_gcm_context gcm;
3891#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003892#if defined(MBEDTLS_CHACHAPOLY_C)
3893 mbedtls_chachapoly_context chachapoly;
3894#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003895 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003896 psa_algorithm_t core_alg;
3897 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003898 uint8_t tag_length;
3899} aead_operation_t;
3900
Gilles Peskine30a9e412019-01-14 18:36:12 +01003901static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003902{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003903 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003904 {
3905#if defined(MBEDTLS_CCM_C)
3906 case PSA_ALG_CCM:
3907 mbedtls_ccm_free( &operation->ctx.ccm );
3908 break;
3909#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003910#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003911 case PSA_ALG_GCM:
3912 mbedtls_gcm_free( &operation->ctx.gcm );
3913 break;
3914#endif /* MBEDTLS_GCM_C */
3915 }
3916}
3917
3918static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003919 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003920 psa_key_usage_t usage,
3921 psa_algorithm_t alg )
3922{
3923 psa_status_t status;
3924 size_t key_bits;
3925 mbedtls_cipher_id_t cipher_id;
3926
Gilles Peskine28f8f302019-07-24 13:30:31 +02003927 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003928 if( status != PSA_SUCCESS )
3929 return( status );
3930
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003931 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003932
3933 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02003934 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003935 &cipher_id );
3936 if( operation->cipher_info == NULL )
3937 return( PSA_ERROR_NOT_SUPPORTED );
3938
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003939 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003940 {
3941#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003942 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
3943 operation->core_alg = PSA_ALG_CCM;
3944 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003945 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3946 * The call to mbedtls_ccm_encrypt_and_tag or
3947 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02003948 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003949 return( PSA_ERROR_INVALID_ARGUMENT );
3950 mbedtls_ccm_init( &operation->ctx.ccm );
3951 status = mbedtls_to_psa_error(
3952 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
3953 operation->slot->data.raw.data,
3954 (unsigned int) key_bits ) );
3955 if( status != 0 )
3956 goto cleanup;
3957 break;
3958#endif /* MBEDTLS_CCM_C */
3959
3960#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003961 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
3962 operation->core_alg = PSA_ALG_GCM;
3963 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003964 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3965 * The call to mbedtls_gcm_crypt_and_tag or
3966 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02003967 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003968 return( PSA_ERROR_INVALID_ARGUMENT );
3969 mbedtls_gcm_init( &operation->ctx.gcm );
3970 status = mbedtls_to_psa_error(
3971 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
3972 operation->slot->data.raw.data,
3973 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003974 if( status != 0 )
3975 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003976 break;
3977#endif /* MBEDTLS_GCM_C */
3978
Gilles Peskine26869f22019-05-06 15:25:00 +02003979#if defined(MBEDTLS_CHACHAPOLY_C)
3980 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
3981 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
3982 operation->full_tag_length = 16;
3983 /* We only support the default tag length. */
3984 if( alg != PSA_ALG_CHACHA20_POLY1305 )
3985 return( PSA_ERROR_NOT_SUPPORTED );
3986 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
3987 status = mbedtls_to_psa_error(
3988 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
3989 operation->slot->data.raw.data ) );
3990 if( status != 0 )
3991 goto cleanup;
3992 break;
3993#endif /* MBEDTLS_CHACHAPOLY_C */
3994
Gilles Peskineedf9a652018-08-17 18:11:56 +02003995 default:
3996 return( PSA_ERROR_NOT_SUPPORTED );
3997 }
3998
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003999 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4000 {
4001 status = PSA_ERROR_INVALID_ARGUMENT;
4002 goto cleanup;
4003 }
4004 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004005
Gilles Peskineedf9a652018-08-17 18:11:56 +02004006 return( PSA_SUCCESS );
4007
4008cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004009 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004010 return( status );
4011}
4012
Gilles Peskinec5487a82018-12-03 18:08:14 +01004013psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004014 psa_algorithm_t alg,
4015 const uint8_t *nonce,
4016 size_t nonce_length,
4017 const uint8_t *additional_data,
4018 size_t additional_data_length,
4019 const uint8_t *plaintext,
4020 size_t plaintext_length,
4021 uint8_t *ciphertext,
4022 size_t ciphertext_size,
4023 size_t *ciphertext_length )
4024{
mohammad16035955c982018-04-26 00:53:03 +03004025 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004026 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004027 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004028
mohammad1603f08a5502018-06-03 15:05:47 +03004029 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004030
Gilles Peskinec5487a82018-12-03 18:08:14 +01004031 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004032 if( status != PSA_SUCCESS )
4033 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004034
Gilles Peskineedf9a652018-08-17 18:11:56 +02004035 /* For all currently supported modes, the tag is at the end of the
4036 * ciphertext. */
4037 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4038 {
4039 status = PSA_ERROR_BUFFER_TOO_SMALL;
4040 goto exit;
4041 }
4042 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004043
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004044#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004045 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004046 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004047 status = mbedtls_to_psa_error(
4048 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4049 MBEDTLS_GCM_ENCRYPT,
4050 plaintext_length,
4051 nonce, nonce_length,
4052 additional_data, additional_data_length,
4053 plaintext, ciphertext,
4054 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004055 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004056 else
4057#endif /* MBEDTLS_GCM_C */
4058#if defined(MBEDTLS_CCM_C)
4059 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004060 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004061 status = mbedtls_to_psa_error(
4062 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4063 plaintext_length,
4064 nonce, nonce_length,
4065 additional_data,
4066 additional_data_length,
4067 plaintext, ciphertext,
4068 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004069 }
mohammad16035c8845f2018-05-09 05:40:09 -07004070 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004071#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004072#if defined(MBEDTLS_CHACHAPOLY_C)
4073 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4074 {
4075 if( nonce_length != 12 || operation.tag_length != 16 )
4076 {
4077 status = PSA_ERROR_NOT_SUPPORTED;
4078 goto exit;
4079 }
4080 status = mbedtls_to_psa_error(
4081 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4082 plaintext_length,
4083 nonce,
4084 additional_data,
4085 additional_data_length,
4086 plaintext,
4087 ciphertext,
4088 tag ) );
4089 }
4090 else
4091#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004092 {
mohammad1603554faad2018-06-03 15:07:38 +03004093 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004094 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004095
Gilles Peskineedf9a652018-08-17 18:11:56 +02004096 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4097 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004098
Gilles Peskineedf9a652018-08-17 18:11:56 +02004099exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004100 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004101 if( status == PSA_SUCCESS )
4102 *ciphertext_length = plaintext_length + operation.tag_length;
4103 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004104}
4105
Gilles Peskineee652a32018-06-01 19:23:52 +02004106/* Locate the tag in a ciphertext buffer containing the encrypted data
4107 * followed by the tag. Return the length of the part preceding the tag in
4108 * *plaintext_length. This is the size of the plaintext in modes where
4109 * the encrypted data has the same size as the plaintext, such as
4110 * CCM and GCM. */
4111static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4112 const uint8_t *ciphertext,
4113 size_t ciphertext_length,
4114 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004115 const uint8_t **p_tag )
4116{
4117 size_t payload_length;
4118 if( tag_length > ciphertext_length )
4119 return( PSA_ERROR_INVALID_ARGUMENT );
4120 payload_length = ciphertext_length - tag_length;
4121 if( payload_length > plaintext_size )
4122 return( PSA_ERROR_BUFFER_TOO_SMALL );
4123 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004124 return( PSA_SUCCESS );
4125}
4126
Gilles Peskinec5487a82018-12-03 18:08:14 +01004127psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004128 psa_algorithm_t alg,
4129 const uint8_t *nonce,
4130 size_t nonce_length,
4131 const uint8_t *additional_data,
4132 size_t additional_data_length,
4133 const uint8_t *ciphertext,
4134 size_t ciphertext_length,
4135 uint8_t *plaintext,
4136 size_t plaintext_size,
4137 size_t *plaintext_length )
4138{
mohammad16035955c982018-04-26 00:53:03 +03004139 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004140 aead_operation_t operation;
4141 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004142
Gilles Peskineee652a32018-06-01 19:23:52 +02004143 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004144
Gilles Peskinec5487a82018-12-03 18:08:14 +01004145 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004146 if( status != PSA_SUCCESS )
4147 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004148
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004149 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4150 ciphertext, ciphertext_length,
4151 plaintext_size, &tag );
4152 if( status != PSA_SUCCESS )
4153 goto exit;
4154
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004155#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004156 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004157 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004158 status = mbedtls_to_psa_error(
4159 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4160 ciphertext_length - operation.tag_length,
4161 nonce, nonce_length,
4162 additional_data,
4163 additional_data_length,
4164 tag, operation.tag_length,
4165 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004166 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004167 else
4168#endif /* MBEDTLS_GCM_C */
4169#if defined(MBEDTLS_CCM_C)
4170 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004171 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004172 status = mbedtls_to_psa_error(
4173 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4174 ciphertext_length - operation.tag_length,
4175 nonce, nonce_length,
4176 additional_data,
4177 additional_data_length,
4178 ciphertext, plaintext,
4179 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004180 }
mohammad160339574652018-06-01 04:39:53 -07004181 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004182#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004183#if defined(MBEDTLS_CHACHAPOLY_C)
4184 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4185 {
4186 if( nonce_length != 12 || operation.tag_length != 16 )
4187 {
4188 status = PSA_ERROR_NOT_SUPPORTED;
4189 goto exit;
4190 }
4191 status = mbedtls_to_psa_error(
4192 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4193 ciphertext_length - operation.tag_length,
4194 nonce,
4195 additional_data,
4196 additional_data_length,
4197 tag,
4198 ciphertext,
4199 plaintext ) );
4200 }
4201 else
4202#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004203 {
mohammad1603554faad2018-06-03 15:07:38 +03004204 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004205 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004206
Gilles Peskineedf9a652018-08-17 18:11:56 +02004207 if( status != PSA_SUCCESS && plaintext_size != 0 )
4208 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004209
Gilles Peskineedf9a652018-08-17 18:11:56 +02004210exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004211 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004212 if( status == PSA_SUCCESS )
4213 *plaintext_length = ciphertext_length - operation.tag_length;
4214 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004215}
4216
Gilles Peskinea0655c32018-04-30 17:06:50 +02004217
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004218
Gilles Peskine20035e32018-02-03 22:44:14 +01004219/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004220/* Generators */
4221/****************************************************************/
4222
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004223#define HKDF_STATE_INIT 0 /* no input yet */
4224#define HKDF_STATE_STARTED 1 /* got salt */
4225#define HKDF_STATE_KEYED 2 /* got key */
4226#define HKDF_STATE_OUTPUT 3 /* output started */
4227
Gilles Peskinecbe66502019-05-16 16:59:18 +02004228static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004229 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004230{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004231 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4232 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004233 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004234 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004235}
4236
4237
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004238psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004239{
4240 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004241 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004242 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004243 {
4244 /* The object has (apparently) been initialized but it is not
4245 * in use. It's ok to call abort on such an object, and there's
4246 * nothing to do. */
4247 }
4248 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004249#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004250 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004251 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004252 mbedtls_free( operation->ctx.hkdf.info );
4253 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004254 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004255 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004256 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004257 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004258 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004259#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004260 if( operation->ctx.tls12_prf.key != NULL )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004261 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004262 mbedtls_platform_zeroize( operation->ctx.tls12_prf.key,
4263 operation->ctx.tls12_prf.key_len );
4264 mbedtls_free( operation->ctx.tls12_prf.key );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004265 }
Hanno Becker580fba12018-11-13 20:50:45 +00004266
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004267 if( operation->ctx.tls12_prf.Ai_with_seed != NULL )
Hanno Becker580fba12018-11-13 20:50:45 +00004268 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004269 mbedtls_platform_zeroize( operation->ctx.tls12_prf.Ai_with_seed,
4270 operation->ctx.tls12_prf.Ai_with_seed_len );
4271 mbedtls_free( operation->ctx.tls12_prf.Ai_with_seed );
Hanno Becker580fba12018-11-13 20:50:45 +00004272 }
Janos Follath6a1d2622019-06-11 10:37:28 +01004273#else
4274 if( operation->ctx.tls12_prf.seed != NULL )
4275 {
4276 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4277 operation->ctx.tls12_prf.seed_length );
4278 mbedtls_free( operation->ctx.tls12_prf.seed );
4279 }
4280
4281 if( operation->ctx.tls12_prf.label != NULL )
4282 {
4283 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4284 operation->ctx.tls12_prf.label_length );
4285 mbedtls_free( operation->ctx.tls12_prf.label );
4286 }
4287
4288 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4289
4290 /* We leave the fields Ai and output_block to be erased safely by the
4291 * mbedtls_platform_zeroize() in the end of this function. */
Janos Follath999f6482019-06-11 12:04:10 +01004292#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004293 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004294 else
4295#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004296 {
4297 status = PSA_ERROR_BAD_STATE;
4298 }
Janos Follath083036a2019-06-11 10:22:26 +01004299 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004300 return( status );
4301}
4302
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004303psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004304 size_t *capacity)
4305{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004306 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004307 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004308 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004309 return PSA_ERROR_BAD_STATE;
4310 }
4311
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004312 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004313 return( PSA_SUCCESS );
4314}
4315
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004316psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004317 size_t capacity )
4318{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004319 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004320 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004321 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004322 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004323 operation->capacity = capacity;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004324 return( PSA_SUCCESS );
4325}
4326
Gilles Peskinebef7f142018-07-12 17:22:21 +02004327#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004328/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004329 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004330static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004331 psa_algorithm_t hash_alg,
4332 uint8_t *output,
4333 size_t output_length )
4334{
4335 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4336 psa_status_t status;
4337
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004338 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4339 return( PSA_ERROR_BAD_STATE );
4340 hkdf->state = HKDF_STATE_OUTPUT;
4341
Gilles Peskinebef7f142018-07-12 17:22:21 +02004342 while( output_length != 0 )
4343 {
4344 /* Copy what remains of the current block */
4345 uint8_t n = hash_length - hkdf->offset_in_block;
4346 if( n > output_length )
4347 n = (uint8_t) output_length;
4348 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4349 output += n;
4350 output_length -= n;
4351 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004352 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004353 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004354 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004355 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004356 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004357 * object was corrupted or if this function is called directly
4358 * inside the library. */
4359 if( hkdf->block_number == 0xff )
4360 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004361
4362 /* We need a new block */
4363 ++hkdf->block_number;
4364 hkdf->offset_in_block = 0;
4365 status = psa_hmac_setup_internal( &hkdf->hmac,
4366 hkdf->prk, hash_length,
4367 hash_alg );
4368 if( status != PSA_SUCCESS )
4369 return( status );
4370 if( hkdf->block_number != 1 )
4371 {
4372 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4373 hkdf->output_block,
4374 hash_length );
4375 if( status != PSA_SUCCESS )
4376 return( status );
4377 }
4378 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4379 hkdf->info,
4380 hkdf->info_length );
4381 if( status != PSA_SUCCESS )
4382 return( status );
4383 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4384 &hkdf->block_number, 1 );
4385 if( status != PSA_SUCCESS )
4386 return( status );
4387 status = psa_hmac_finish_internal( &hkdf->hmac,
4388 hkdf->output_block,
4389 sizeof( hkdf->output_block ) );
4390 if( status != PSA_SUCCESS )
4391 return( status );
4392 }
4393
4394 return( PSA_SUCCESS );
4395}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004396
Janos Follath999f6482019-06-11 12:04:10 +01004397#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004398static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4399 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004400 psa_algorithm_t alg )
4401{
4402 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4403 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4404 psa_hmac_internal_data hmac;
4405 psa_status_t status, cleanup_status;
4406
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004407 uint8_t *Ai;
Hanno Becker3b339e22018-11-13 20:56:14 +00004408 size_t Ai_len;
4409
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004410 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004411 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004412 * prevented this call. It could happen only if the operation
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004413 * object was corrupted or if this function is called directly
4414 * inside the library. */
4415 if( tls12_prf->block_number == 0xff )
4416 return( PSA_ERROR_BAD_STATE );
4417
4418 /* We need a new block */
4419 ++tls12_prf->block_number;
4420 tls12_prf->offset_in_block = 0;
4421
4422 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4423 *
4424 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4425 *
4426 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4427 * HMAC_hash(secret, A(2) + seed) +
4428 * HMAC_hash(secret, A(3) + seed) + ...
4429 *
4430 * A(0) = seed
4431 * A(i) = HMAC_hash( secret, A(i-1) )
4432 *
Gilles Peskinecbe66502019-05-16 16:59:18 +02004433 * The `psa_tls12_prf_key_derivation` structures saves the block
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004434 * `HMAC_hash(secret, A(i) + seed)` from which the output
4435 * is currently extracted as `output_block`, while
4436 * `A(i) + seed` is stored in `Ai_with_seed`.
4437 *
4438 * Generating a new block means recalculating `Ai_with_seed`
4439 * from the A(i)-part of it, and afterwards recalculating
4440 * `output_block`.
4441 *
4442 * A(0) is computed at setup time.
4443 *
4444 */
4445
4446 psa_hmac_init_internal( &hmac );
4447
4448 /* We must distinguish the calculation of A(1) from those
4449 * of A(2) and higher, because A(0)=seed has a different
4450 * length than the other A(i). */
4451 if( tls12_prf->block_number == 1 )
4452 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004453 Ai = tls12_prf->Ai_with_seed + hash_length;
4454 Ai_len = tls12_prf->Ai_with_seed_len - hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004455 }
4456 else
4457 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004458 Ai = tls12_prf->Ai_with_seed;
4459 Ai_len = hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004460 }
4461
Hanno Becker3b339e22018-11-13 20:56:14 +00004462 /* Compute A(i+1) = HMAC_hash(secret, A(i)) */
4463 status = psa_hmac_setup_internal( &hmac,
4464 tls12_prf->key,
4465 tls12_prf->key_len,
4466 hash_alg );
4467 if( status != PSA_SUCCESS )
4468 goto cleanup;
4469
4470 status = psa_hash_update( &hmac.hash_ctx,
4471 Ai, Ai_len );
4472 if( status != PSA_SUCCESS )
4473 goto cleanup;
4474
4475 status = psa_hmac_finish_internal( &hmac,
4476 tls12_prf->Ai_with_seed,
4477 hash_length );
4478 if( status != PSA_SUCCESS )
4479 goto cleanup;
4480
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004481 /* Compute the next block `HMAC_hash(secret, A(i+1) + seed)`. */
4482 status = psa_hmac_setup_internal( &hmac,
4483 tls12_prf->key,
4484 tls12_prf->key_len,
4485 hash_alg );
4486 if( status != PSA_SUCCESS )
4487 goto cleanup;
4488
4489 status = psa_hash_update( &hmac.hash_ctx,
4490 tls12_prf->Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00004491 tls12_prf->Ai_with_seed_len );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004492 if( status != PSA_SUCCESS )
4493 goto cleanup;
4494
4495 status = psa_hmac_finish_internal( &hmac,
4496 tls12_prf->output_block,
4497 hash_length );
4498 if( status != PSA_SUCCESS )
4499 goto cleanup;
4500
4501cleanup:
4502
4503 cleanup_status = psa_hmac_abort_internal( &hmac );
4504 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4505 status = cleanup_status;
4506
4507 return( status );
4508}
Janos Follath7742fee2019-06-17 12:58:10 +01004509#else
4510static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4511 psa_tls12_prf_key_derivation_t *tls12_prf,
4512 psa_algorithm_t alg )
4513{
4514 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4515 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004516 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4517 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004518
Janos Follath7742fee2019-06-17 12:58:10 +01004519 /* We can't be wanting more output after block 0xff, otherwise
4520 * the capacity check in psa_key_derivation_output_bytes() would have
4521 * prevented this call. It could happen only if the operation
4522 * object was corrupted or if this function is called directly
4523 * inside the library. */
4524 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004525 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004526
4527 /* We need a new block */
4528 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004529 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004530
4531 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4532 *
4533 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4534 *
4535 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4536 * HMAC_hash(secret, A(2) + seed) +
4537 * HMAC_hash(secret, A(3) + seed) + ...
4538 *
4539 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004540 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004541 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004542 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004543 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004544 * is currently extracted as `output_block` and where i is
4545 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004546 */
4547
Janos Follathea29bfb2019-06-19 12:21:20 +01004548 /* Save the hash context before using it, to preserve the hash state with
4549 * only the inner padding in it. We need this, because inner padding depends
4550 * on the key (secret in the RFC's terminology). */
4551 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4552 if( status != PSA_SUCCESS )
4553 goto cleanup;
4554
4555 /* Calculate A(i) where i = tls12_prf->block_number. */
4556 if( tls12_prf->block_number == 1 )
4557 {
4558 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4559 * the variable seed and in this instance means it in the context of the
4560 * P_hash function, where seed = label + seed.) */
4561 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4562 tls12_prf->label, tls12_prf->label_length );
4563 if( status != PSA_SUCCESS )
4564 goto cleanup;
4565 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4566 tls12_prf->seed, tls12_prf->seed_length );
4567 if( status != PSA_SUCCESS )
4568 goto cleanup;
4569 }
4570 else
4571 {
4572 /* A(i) = HMAC_hash(secret, A(i-1)) */
4573 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4574 tls12_prf->Ai, hash_length );
4575 if( status != PSA_SUCCESS )
4576 goto cleanup;
4577 }
4578
4579 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4580 tls12_prf->Ai, hash_length );
4581 if( status != PSA_SUCCESS )
4582 goto cleanup;
4583 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4584 if( status != PSA_SUCCESS )
4585 goto cleanup;
4586
4587 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4588 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4589 tls12_prf->Ai, hash_length );
4590 if( status != PSA_SUCCESS )
4591 goto cleanup;
4592 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4593 tls12_prf->label, tls12_prf->label_length );
4594 if( status != PSA_SUCCESS )
4595 goto cleanup;
4596 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4597 tls12_prf->seed, tls12_prf->seed_length );
4598 if( status != PSA_SUCCESS )
4599 goto cleanup;
4600 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4601 tls12_prf->output_block, hash_length );
4602 if( status != PSA_SUCCESS )
4603 goto cleanup;
4604 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4605 if( status != PSA_SUCCESS )
4606 goto cleanup;
4607
Janos Follath7742fee2019-06-17 12:58:10 +01004608
4609cleanup:
4610
Janos Follathea29bfb2019-06-19 12:21:20 +01004611 cleanup_status = psa_hash_abort( &backup );
4612 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4613 status = cleanup_status;
4614
4615 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004616}
Janos Follath999f6482019-06-11 12:04:10 +01004617#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004618
Janos Follath999f6482019-06-11 12:04:10 +01004619#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004620/* Read some bytes from an TLS-1.2-PRF-based operation.
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004621 * See Section 5 of RFC 5246. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004622static psa_status_t psa_key_derivation_tls12_prf_read(
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004623 psa_tls12_prf_key_derivation_t *tls12_prf,
4624 psa_algorithm_t alg,
4625 uint8_t *output,
4626 size_t output_length )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004627{
4628 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4629 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4630 psa_status_t status;
4631
4632 while( output_length != 0 )
4633 {
4634 /* Copy what remains of the current block */
4635 uint8_t n = hash_length - tls12_prf->offset_in_block;
4636
4637 /* Check if we have fully processed the current block. */
4638 if( n == 0 )
4639 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004640 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004641 alg );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004642 if( status != PSA_SUCCESS )
4643 return( status );
4644
4645 continue;
4646 }
4647
4648 if( n > output_length )
4649 n = (uint8_t) output_length;
4650 memcpy( output, tls12_prf->output_block + tls12_prf->offset_in_block,
4651 n );
4652 output += n;
4653 output_length -= n;
4654 tls12_prf->offset_in_block += n;
4655 }
4656
4657 return( PSA_SUCCESS );
4658}
Janos Follath844eb0e2019-06-19 12:10:49 +01004659#else
4660static psa_status_t psa_key_derivation_tls12_prf_read(
4661 psa_tls12_prf_key_derivation_t *tls12_prf,
4662 psa_algorithm_t alg,
4663 uint8_t *output,
4664 size_t output_length )
4665{
4666 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4667 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4668 psa_status_t status;
4669 uint8_t offset, length;
4670
4671 while( output_length != 0 )
4672 {
4673 /* Check if we have fully processed the current block. */
4674 if( tls12_prf->left_in_block == 0 )
4675 {
4676 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4677 alg );
4678 if( status != PSA_SUCCESS )
4679 return( status );
4680
4681 continue;
4682 }
4683
4684 if( tls12_prf->left_in_block > output_length )
4685 length = (uint8_t) output_length;
4686 else
4687 length = tls12_prf->left_in_block;
4688
4689 offset = hash_length - tls12_prf->left_in_block;
4690 memcpy( output, tls12_prf->output_block + offset, length );
4691 output += length;
4692 output_length -= length;
4693 tls12_prf->left_in_block -= length;
4694 }
4695
4696 return( PSA_SUCCESS );
4697}
Janos Follath999f6482019-06-11 12:04:10 +01004698#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004699#endif /* MBEDTLS_MD_C */
4700
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004701psa_status_t psa_key_derivation_output_bytes(
4702 psa_key_derivation_operation_t *operation,
4703 uint8_t *output,
4704 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004705{
4706 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004707 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004708
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004709 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004710 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004711 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004712 return PSA_ERROR_BAD_STATE;
4713 }
4714
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004715 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004716 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004717 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004718 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004719 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004720 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004721 goto exit;
4722 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004723 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004724 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004725 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004726 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004727 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4728 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004729 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004730 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004731 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004732 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004733 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004734
Gilles Peskinebef7f142018-07-12 17:22:21 +02004735#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004736 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004737 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004738 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004739 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004740 output, output_length );
4741 }
Janos Follathadbec812019-06-14 11:05:39 +01004742 else
Janos Follathadbec812019-06-14 11:05:39 +01004743 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004744 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004745 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004746 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004747 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004748 output_length );
4749 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004750 else
4751#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004752 {
4753 return( PSA_ERROR_BAD_STATE );
4754 }
4755
4756exit:
4757 if( status != PSA_SUCCESS )
4758 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004759 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004760 * This allows us to differentiate between exhausted operations and
4761 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4762 * operations. */
4763 psa_algorithm_t alg = operation->alg;
4764 psa_key_derivation_abort( operation );
4765 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004766 memset( output, '!', output_length );
4767 }
4768 return( status );
4769}
4770
Gilles Peskine08542d82018-07-19 17:05:42 +02004771#if defined(MBEDTLS_DES_C)
4772static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4773{
4774 if( data_size >= 8 )
4775 mbedtls_des_key_set_parity( data );
4776 if( data_size >= 16 )
4777 mbedtls_des_key_set_parity( data + 8 );
4778 if( data_size >= 24 )
4779 mbedtls_des_key_set_parity( data + 16 );
4780}
4781#endif /* MBEDTLS_DES_C */
4782
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004783static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004784 psa_key_slot_t *slot,
4785 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004786 psa_key_derivation_operation_t *operation )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004787{
4788 uint8_t *data = NULL;
4789 size_t bytes = PSA_BITS_TO_BYTES( bits );
4790 psa_status_t status;
4791
Gilles Peskine8e338702019-07-30 20:06:31 +02004792 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004793 return( PSA_ERROR_INVALID_ARGUMENT );
4794 if( bits % 8 != 0 )
4795 return( PSA_ERROR_INVALID_ARGUMENT );
4796 data = mbedtls_calloc( 1, bytes );
4797 if( data == NULL )
4798 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4799
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004800 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004801 if( status != PSA_SUCCESS )
4802 goto exit;
4803#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004804 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004805 psa_des_set_key_parity( data, bytes );
4806#endif /* MBEDTLS_DES_C */
4807 status = psa_import_key_into_slot( slot, data, bytes );
4808
4809exit:
4810 mbedtls_free( data );
4811 return( status );
4812}
4813
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004814psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004815 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004816 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004817{
4818 psa_status_t status;
4819 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004820 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine011e4282019-06-26 18:34:38 +02004821 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004822#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4823 if( driver != NULL )
4824 {
4825 /* Deriving a key in a secure element is not implemented yet. */
4826 status = PSA_ERROR_NOT_SUPPORTED;
4827 }
4828#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004829 if( status == PSA_SUCCESS )
4830 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004831 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004832 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004833 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004834 }
4835 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004836 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004837 if( status != PSA_SUCCESS )
4838 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004839 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004840 *handle = 0;
4841 }
4842 return( status );
4843}
4844
Gilles Peskineeab56e42018-07-12 17:12:33 +02004845
4846
4847/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004848/* Key derivation */
4849/****************************************************************/
4850
Gilles Peskinea05219c2018-11-16 16:02:56 +01004851#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004852#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004853/* Set up an HKDF-based operation. This is exactly the extract phase
Gilles Peskine346797d2018-11-16 16:05:06 +01004854 * of the HKDF algorithm.
4855 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004856 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004857 * to potentially free embedded data structures and wipe confidential data.
4858 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004859static psa_status_t psa_key_derivation_hkdf_setup( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004860 const uint8_t *secret,
4861 size_t secret_length,
4862 psa_algorithm_t hash_alg,
4863 const uint8_t *salt,
4864 size_t salt_length,
4865 const uint8_t *label,
4866 size_t label_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004867{
4868 psa_status_t status;
4869 status = psa_hmac_setup_internal( &hkdf->hmac,
4870 salt, salt_length,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004871 hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004872 if( status != PSA_SUCCESS )
4873 return( status );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004874 status = psa_hash_update( &hkdf->hmac.hash_ctx, secret, secret_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004875 if( status != PSA_SUCCESS )
4876 return( status );
4877 status = psa_hmac_finish_internal( &hkdf->hmac,
4878 hkdf->prk,
4879 sizeof( hkdf->prk ) );
4880 if( status != PSA_SUCCESS )
4881 return( status );
4882 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4883 hkdf->block_number = 0;
4884 hkdf->info_length = label_length;
4885 if( label_length != 0 )
4886 {
4887 hkdf->info = mbedtls_calloc( 1, label_length );
4888 if( hkdf->info == NULL )
4889 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4890 memcpy( hkdf->info, label, label_length );
4891 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004892 hkdf->state = HKDF_STATE_KEYED;
4893 hkdf->info_set = 1;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004894 return( PSA_SUCCESS );
4895}
Janos Follath71a4c912019-06-11 09:14:47 +01004896#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01004897#endif /* MBEDTLS_MD_C */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004898
Gilles Peskinea05219c2018-11-16 16:02:56 +01004899#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004900#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004901/* Set up a TLS-1.2-prf-based operation (see RFC 5246, Section 5).
Gilles Peskine346797d2018-11-16 16:05:06 +01004902 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004903 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004904 * to potentially free embedded data structures and wipe confidential data.
4905 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004906static psa_status_t psa_key_derivation_tls12_prf_setup(
4907 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004908 const uint8_t *key,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004909 size_t key_len,
4910 psa_algorithm_t hash_alg,
4911 const uint8_t *salt,
4912 size_t salt_length,
4913 const uint8_t *label,
4914 size_t label_length )
4915{
4916 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Hanno Becker580fba12018-11-13 20:50:45 +00004917 size_t Ai_with_seed_len = hash_length + salt_length + label_length;
4918 int overflow;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004919
4920 tls12_prf->key = mbedtls_calloc( 1, key_len );
4921 if( tls12_prf->key == NULL )
4922 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4923 tls12_prf->key_len = key_len;
4924 memcpy( tls12_prf->key, key, key_len );
4925
Hanno Becker580fba12018-11-13 20:50:45 +00004926 overflow = ( salt_length + label_length < salt_length ) ||
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004927 ( salt_length + label_length + hash_length < hash_length );
Hanno Becker580fba12018-11-13 20:50:45 +00004928 if( overflow )
4929 return( PSA_ERROR_INVALID_ARGUMENT );
4930
4931 tls12_prf->Ai_with_seed = mbedtls_calloc( 1, Ai_with_seed_len );
4932 if( tls12_prf->Ai_with_seed == NULL )
4933 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4934 tls12_prf->Ai_with_seed_len = Ai_with_seed_len;
4935
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004936 /* Write `label + seed' at the end of the `A(i) + seed` buffer,
4937 * leaving the initial `hash_length` bytes unspecified for now. */
Hanno Becker353e4532018-11-15 09:53:57 +00004938 if( label_length != 0 )
4939 {
4940 memcpy( tls12_prf->Ai_with_seed + hash_length,
4941 label, label_length );
4942 }
4943
4944 if( salt_length != 0 )
4945 {
4946 memcpy( tls12_prf->Ai_with_seed + hash_length + label_length,
4947 salt, salt_length );
4948 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004949
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004950 /* The first block gets generated when
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004951 * psa_key_derivation_output_bytes() is called. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004952 tls12_prf->block_number = 0;
4953 tls12_prf->offset_in_block = hash_length;
4954
4955 return( PSA_SUCCESS );
4956}
Janos Follath71a4c912019-06-11 09:14:47 +01004957#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Becker1aaedc02018-11-16 11:35:34 +00004958
Janos Follath71a4c912019-06-11 09:14:47 +01004959#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004960/* Set up a TLS-1.2-PSK-to-MS-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004961static psa_status_t psa_key_derivation_tls12_psk_to_ms_setup(
4962 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004963 const uint8_t *psk,
Hanno Becker1aaedc02018-11-16 11:35:34 +00004964 size_t psk_len,
4965 psa_algorithm_t hash_alg,
4966 const uint8_t *salt,
4967 size_t salt_length,
4968 const uint8_t *label,
4969 size_t label_length )
4970{
4971 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004972 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
Hanno Becker1aaedc02018-11-16 11:35:34 +00004973
4974 if( psk_len > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4975 return( PSA_ERROR_INVALID_ARGUMENT );
4976
4977 /* Quoting RFC 4279, Section 2:
4978 *
4979 * The premaster secret is formed as follows: if the PSK is N octets
4980 * long, concatenate a uint16 with the value N, N zero octets, a second
4981 * uint16 with the value N, and the PSK itself.
4982 */
4983
4984 pms[0] = ( psk_len >> 8 ) & 0xff;
4985 pms[1] = ( psk_len >> 0 ) & 0xff;
4986 memset( pms + 2, 0, psk_len );
4987 pms[2 + psk_len + 0] = pms[0];
4988 pms[2 + psk_len + 1] = pms[1];
4989 memcpy( pms + 4 + psk_len, psk, psk_len );
4990
Gilles Peskinecbe66502019-05-16 16:59:18 +02004991 status = psa_key_derivation_tls12_prf_setup( tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004992 pms, 4 + 2 * psk_len,
4993 hash_alg,
4994 salt, salt_length,
4995 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004996
Gilles Peskine3f108122018-12-07 18:14:53 +01004997 mbedtls_platform_zeroize( pms, sizeof( pms ) );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004998 return( status );
4999}
Janos Follath71a4c912019-06-11 09:14:47 +01005000#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01005001#endif /* MBEDTLS_MD_C */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005002
Janos Follath71a4c912019-06-11 09:14:47 +01005003#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005004/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005005 * to potentially free embedded data structures and wipe confidential data.
5006 */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005007static psa_status_t psa_key_derivation_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005008 psa_key_derivation_operation_t *operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005009 const uint8_t *secret, size_t secret_length,
5010 psa_algorithm_t alg,
5011 const uint8_t *salt, size_t salt_length,
5012 const uint8_t *label, size_t label_length,
5013 size_t capacity )
5014{
5015 psa_status_t status;
5016 size_t max_capacity;
5017
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005018 /* Set operation->alg even on failure so that abort knows what to do. */
5019 operation->alg = alg;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005020
5021#if defined(MBEDTLS_MD_C)
5022 if( PSA_ALG_IS_HKDF( alg ) )
5023 {
5024 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5025 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5026 if( hash_size == 0 )
5027 return( PSA_ERROR_NOT_SUPPORTED );
5028 max_capacity = 255 * hash_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005029 status = psa_key_derivation_hkdf_setup( &operation->ctx.hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005030 secret, secret_length,
5031 hash_alg,
5032 salt, salt_length,
5033 label, label_length );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005034 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00005035 /* TLS-1.2 PRF and TLS-1.2 PSK-to-MS are very similar, so share code. */
5036 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
5037 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005038 {
5039 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5040 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5041
5042 /* TLS-1.2 PRF supports only SHA-256 and SHA-384. */
5043 if( hash_alg != PSA_ALG_SHA_256 &&
5044 hash_alg != PSA_ALG_SHA_384 )
5045 {
5046 return( PSA_ERROR_NOT_SUPPORTED );
5047 }
5048
5049 max_capacity = 255 * hash_size;
Hanno Becker1aaedc02018-11-16 11:35:34 +00005050
5051 if( PSA_ALG_IS_TLS12_PRF( alg ) )
5052 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005053 status = psa_key_derivation_tls12_prf_setup( &operation->ctx.tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005054 secret, secret_length,
5055 hash_alg, salt, salt_length,
5056 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00005057 }
5058 else
5059 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02005060 status = psa_key_derivation_tls12_psk_to_ms_setup(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005061 &operation->ctx.tls12_prf,
Hanno Becker1aaedc02018-11-16 11:35:34 +00005062 secret, secret_length,
5063 hash_alg, salt, salt_length,
5064 label, label_length );
5065 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005066 }
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005067 else
5068#endif
5069 {
5070 return( PSA_ERROR_NOT_SUPPORTED );
5071 }
5072
5073 if( status != PSA_SUCCESS )
5074 return( status );
5075
5076 if( capacity <= max_capacity )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005077 operation->capacity = capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005078 else if( capacity == PSA_KEY_DERIVATION_UNLIMITED_CAPACITY )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005079 operation->capacity = max_capacity;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005080 else
5081 return( PSA_ERROR_INVALID_ARGUMENT );
5082
5083 return( PSA_SUCCESS );
5084}
Janos Follath71a4c912019-06-11 09:14:47 +01005085#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005086
Janos Follath71a4c912019-06-11 09:14:47 +01005087#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005088psa_status_t psa_key_derivation( psa_key_derivation_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01005089 psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +02005090 psa_algorithm_t alg,
5091 const uint8_t *salt,
5092 size_t salt_length,
5093 const uint8_t *label,
5094 size_t label_length,
5095 size_t capacity )
5096{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005097 psa_key_slot_t *slot;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005098 psa_status_t status;
5099
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005100 if( operation->alg != 0 )
Gilles Peskineea0fb492018-07-12 17:17:20 +02005101 return( PSA_ERROR_BAD_STATE );
5102
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005103 /* Make sure that alg is a key derivation algorithm. This prevents
5104 * key selection algorithms, which psa_key_derivation_internal
5105 * accepts for the sake of key agreement. */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005106 if( ! PSA_ALG_IS_KEY_DERIVATION( alg ) )
5107 return( PSA_ERROR_INVALID_ARGUMENT );
5108
Gilles Peskine28f8f302019-07-24 13:30:31 +02005109 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005110 if( status != PSA_SUCCESS )
5111 return( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005112
Gilles Peskine8e338702019-07-30 20:06:31 +02005113 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005114 return( PSA_ERROR_INVALID_ARGUMENT );
5115
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005116 status = psa_key_derivation_internal( operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02005117 slot->data.raw.data,
5118 slot->data.raw.bytes,
5119 alg,
5120 salt, salt_length,
5121 label, label_length,
5122 capacity );
5123 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005124 psa_key_derivation_abort( operation );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005125 return( status );
5126}
Janos Follath71a4c912019-06-11 09:14:47 +01005127#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineea0fb492018-07-12 17:17:20 +02005128
Gilles Peskine969c5d62019-01-16 15:53:06 +01005129static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005130 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005131 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005132{
Janos Follath5fe19732019-06-20 15:09:30 +01005133 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5134 * initialisers for this union leave some bytes unspecified.) */
5135 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5136
Gilles Peskine969c5d62019-01-16 15:53:06 +01005137 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005138#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005139 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5140 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5141 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005142 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005143 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005144 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5145 if( hash_size == 0 )
5146 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005147 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5148 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005149 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005150 {
5151 return( PSA_ERROR_NOT_SUPPORTED );
5152 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005153 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005154 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005155 }
5156#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005157 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005158 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005159}
5160
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005161psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005162 psa_algorithm_t alg )
5163{
5164 psa_status_t status;
5165
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005166 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005167 return( PSA_ERROR_BAD_STATE );
5168
Gilles Peskine6843c292019-01-18 16:44:49 +01005169 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5170 return( PSA_ERROR_INVALID_ARGUMENT );
5171 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005172 {
5173 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005174 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005175 }
5176 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5177 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005178 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005179 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005180 else
5181 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005182
5183 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005184 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005185 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005186}
5187
5188#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005189static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005190 psa_algorithm_t hash_alg,
5191 psa_key_derivation_step_t step,
5192 const uint8_t *data,
5193 size_t data_length )
5194{
5195 psa_status_t status;
5196 switch( step )
5197 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005198 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005199 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005200 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005201 status = psa_hmac_setup_internal( &hkdf->hmac,
5202 data, data_length,
5203 hash_alg );
5204 if( status != PSA_SUCCESS )
5205 return( status );
5206 hkdf->state = HKDF_STATE_STARTED;
5207 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005208 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005209 /* If no salt was provided, use an empty salt. */
5210 if( hkdf->state == HKDF_STATE_INIT )
5211 {
5212 status = psa_hmac_setup_internal( &hkdf->hmac,
5213 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005214 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005215 if( status != PSA_SUCCESS )
5216 return( status );
5217 hkdf->state = HKDF_STATE_STARTED;
5218 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005219 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005220 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005221 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5222 data, data_length );
5223 if( status != PSA_SUCCESS )
5224 return( status );
5225 status = psa_hmac_finish_internal( &hkdf->hmac,
5226 hkdf->prk,
5227 sizeof( hkdf->prk ) );
5228 if( status != PSA_SUCCESS )
5229 return( status );
5230 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5231 hkdf->block_number = 0;
5232 hkdf->state = HKDF_STATE_KEYED;
5233 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005234 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005235 if( hkdf->state == HKDF_STATE_OUTPUT )
5236 return( PSA_ERROR_BAD_STATE );
5237 if( hkdf->info_set )
5238 return( PSA_ERROR_BAD_STATE );
5239 hkdf->info_length = data_length;
5240 if( data_length != 0 )
5241 {
5242 hkdf->info = mbedtls_calloc( 1, data_length );
5243 if( hkdf->info == NULL )
5244 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5245 memcpy( hkdf->info, data, data_length );
5246 }
5247 hkdf->info_set = 1;
5248 return( PSA_SUCCESS );
5249 default:
5250 return( PSA_ERROR_INVALID_ARGUMENT );
5251 }
5252}
Janos Follathb03233e2019-06-11 15:30:30 +01005253
5254#if defined(PSA_PRE_1_0_KEY_DERIVATION)
5255static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5256 psa_algorithm_t hash_alg,
5257 psa_key_derivation_step_t step,
5258 const uint8_t *data,
5259 size_t data_length )
5260{
5261 (void) prf;
5262 (void) hash_alg;
5263 (void) step;
5264 (void) data;
5265 (void) data_length;
5266
5267 return( PSA_ERROR_INVALID_ARGUMENT );
5268}
Janos Follath6660f0e2019-06-17 08:44:03 +01005269
5270static psa_status_t psa_tls12_prf_psk_to_ms_input(
5271 psa_tls12_prf_key_derivation_t *prf,
5272 psa_algorithm_t hash_alg,
5273 psa_key_derivation_step_t step,
5274 const uint8_t *data,
5275 size_t data_length )
5276{
5277 (void) prf;
5278 (void) hash_alg;
5279 (void) step;
5280 (void) data;
5281 (void) data_length;
5282
5283 return( PSA_ERROR_INVALID_ARGUMENT );
5284}
Janos Follathb03233e2019-06-11 15:30:30 +01005285#else
Janos Follathf08e2652019-06-13 09:05:41 +01005286static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5287 const uint8_t *data,
5288 size_t data_length )
5289{
5290 if( prf->state != TLS12_PRF_STATE_INIT )
5291 return( PSA_ERROR_BAD_STATE );
5292
Janos Follathd6dce9f2019-07-04 09:11:38 +01005293 if( data_length != 0 )
5294 {
5295 prf->seed = mbedtls_calloc( 1, data_length );
5296 if( prf->seed == NULL )
5297 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005298
Janos Follathd6dce9f2019-07-04 09:11:38 +01005299 memcpy( prf->seed, data, data_length );
5300 prf->seed_length = data_length;
5301 }
Janos Follathf08e2652019-06-13 09:05:41 +01005302
5303 prf->state = TLS12_PRF_STATE_SEED_SET;
5304
5305 return( PSA_SUCCESS );
5306}
5307
Janos Follath81550542019-06-13 14:26:34 +01005308static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5309 psa_algorithm_t hash_alg,
5310 const uint8_t *data,
5311 size_t data_length )
5312{
5313 psa_status_t status;
5314 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5315 return( PSA_ERROR_BAD_STATE );
5316
5317 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5318 if( status != PSA_SUCCESS )
5319 return( status );
5320
5321 prf->state = TLS12_PRF_STATE_KEY_SET;
5322
5323 return( PSA_SUCCESS );
5324}
5325
Janos Follath6660f0e2019-06-17 08:44:03 +01005326static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5327 psa_tls12_prf_key_derivation_t *prf,
5328 psa_algorithm_t hash_alg,
5329 const uint8_t *data,
5330 size_t data_length )
5331{
5332 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005333 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5334 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005335
5336 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5337 return( PSA_ERROR_INVALID_ARGUMENT );
5338
5339 /* Quoting RFC 4279, Section 2:
5340 *
5341 * The premaster secret is formed as follows: if the PSK is N octets
5342 * long, concatenate a uint16 with the value N, N zero octets, a second
5343 * uint16 with the value N, and the PSK itself.
5344 */
5345
Janos Follath40e13932019-06-26 13:22:29 +01005346 *cur++ = ( data_length >> 8 ) & 0xff;
5347 *cur++ = ( data_length >> 0 ) & 0xff;
5348 memset( cur, 0, data_length );
5349 cur += data_length;
5350 *cur++ = pms[0];
5351 *cur++ = pms[1];
5352 memcpy( cur, data, data_length );
5353 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005354
Janos Follath40e13932019-06-26 13:22:29 +01005355 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005356
5357 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5358 return( status );
5359}
5360
Janos Follath63028dd2019-06-13 09:15:47 +01005361static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5362 const uint8_t *data,
5363 size_t data_length )
5364{
5365 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5366 return( PSA_ERROR_BAD_STATE );
5367
Janos Follathd6dce9f2019-07-04 09:11:38 +01005368 if( data_length != 0 )
5369 {
5370 prf->label = mbedtls_calloc( 1, data_length );
5371 if( prf->label == NULL )
5372 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005373
Janos Follathd6dce9f2019-07-04 09:11:38 +01005374 memcpy( prf->label, data, data_length );
5375 prf->label_length = data_length;
5376 }
Janos Follath63028dd2019-06-13 09:15:47 +01005377
5378 prf->state = TLS12_PRF_STATE_LABEL_SET;
5379
5380 return( PSA_SUCCESS );
5381}
5382
Janos Follathb03233e2019-06-11 15:30:30 +01005383static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5384 psa_algorithm_t hash_alg,
5385 psa_key_derivation_step_t step,
5386 const uint8_t *data,
5387 size_t data_length )
5388{
Janos Follathb03233e2019-06-11 15:30:30 +01005389 switch( step )
5390 {
Janos Follathf08e2652019-06-13 09:05:41 +01005391 case PSA_KEY_DERIVATION_INPUT_SEED:
5392 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005393 case PSA_KEY_DERIVATION_INPUT_SECRET:
5394 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005395 case PSA_KEY_DERIVATION_INPUT_LABEL:
5396 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005397 default:
5398 return( PSA_ERROR_INVALID_ARGUMENT );
5399 }
5400}
Janos Follath6660f0e2019-06-17 08:44:03 +01005401
5402static psa_status_t psa_tls12_prf_psk_to_ms_input(
5403 psa_tls12_prf_key_derivation_t *prf,
5404 psa_algorithm_t hash_alg,
5405 psa_key_derivation_step_t step,
5406 const uint8_t *data,
5407 size_t data_length )
5408{
5409 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005410 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005411 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5412 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005413 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005414
5415 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5416}
Janos Follathb03233e2019-06-11 15:30:30 +01005417#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005418#endif /* MBEDTLS_MD_C */
5419
Janos Follathb80a94e2019-06-12 15:54:46 +01005420static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005421 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005422 psa_key_derivation_step_t step,
5423 const uint8_t *data,
5424 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005425{
5426 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005427 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005428
5429#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005430 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005431 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005432 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005433 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005434 step, data, data_length );
5435 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005436 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005437#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005438#if defined(MBEDTLS_MD_C)
Janos Follath6660f0e2019-06-17 08:44:03 +01005439 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005440 {
Janos Follathb03233e2019-06-11 15:30:30 +01005441 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5442 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5443 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005444 }
5445 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5446 {
5447 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5448 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5449 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005450 }
5451 else
5452#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005453 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005454 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005455 return( PSA_ERROR_BAD_STATE );
5456 }
5457
5458 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005459 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005460 return( status );
5461}
5462
Janos Follath51f4a0f2019-06-14 11:35:55 +01005463psa_status_t psa_key_derivation_input_bytes(
5464 psa_key_derivation_operation_t *operation,
5465 psa_key_derivation_step_t step,
5466 const uint8_t *data,
5467 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005468{
Janos Follathc5621512019-06-14 11:27:57 +01005469 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5470 return( PSA_ERROR_INVALID_ARGUMENT );
5471
5472 return( psa_key_derivation_input_internal( operation, step,
5473 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005474}
5475
Janos Follath51f4a0f2019-06-14 11:35:55 +01005476psa_status_t psa_key_derivation_input_key(
5477 psa_key_derivation_operation_t *operation,
5478 psa_key_derivation_step_t step,
5479 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005480{
5481 psa_key_slot_t *slot;
5482 psa_status_t status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02005483 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005484 PSA_KEY_USAGE_DERIVE,
5485 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005486 if( status != PSA_SUCCESS )
5487 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02005488 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005489 return( PSA_ERROR_INVALID_ARGUMENT );
5490 /* Don't allow a key to be used as an input that is usually public.
5491 * This is debatable. It's ok from a cryptographic perspective to
5492 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005493 * the material should be dedicated to a particular input step,
5494 * otherwise this may allow the key to be used in an unintended way
5495 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005496 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005497 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005498 return( psa_key_derivation_input_internal( operation,
5499 step,
5500 slot->data.raw.data,
5501 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005502}
5503
Gilles Peskineea0fb492018-07-12 17:17:20 +02005504
5505
5506/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005507/* Key agreement */
5508/****************************************************************/
5509
Gilles Peskinea05219c2018-11-16 16:02:56 +01005510#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005511static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5512 size_t peer_key_length,
5513 const mbedtls_ecp_keypair *our_key,
5514 uint8_t *shared_secret,
5515 size_t shared_secret_size,
5516 size_t *shared_secret_length )
5517{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005518 mbedtls_ecp_keypair *their_key = NULL;
5519 mbedtls_ecdh_context ecdh;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005520 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005521 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005522
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005523 status = psa_import_ec_public_key(
5524 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5525 peer_key, peer_key_length,
5526 &their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005527 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005528 goto exit;
Gilles Peskineb4086612018-11-14 20:51:23 +01005529
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005530 status = mbedtls_to_psa_error(
5531 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5532 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005533 goto exit;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005534 status = mbedtls_to_psa_error(
5535 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5536 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005537 goto exit;
5538
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005539 status = mbedtls_to_psa_error(
5540 mbedtls_ecdh_calc_secret( &ecdh,
5541 shared_secret_length,
5542 shared_secret, shared_secret_size,
5543 mbedtls_ctr_drbg_random,
5544 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005545
5546exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005547 mbedtls_ecdh_free( &ecdh );
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005548 mbedtls_ecp_keypair_free( their_key );
5549 mbedtls_free( their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005550 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005551}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005552#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005553
Gilles Peskine01d718c2018-09-18 12:01:02 +02005554#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5555
Gilles Peskine0216fe12019-04-11 21:23:21 +02005556static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5557 psa_key_slot_t *private_key,
5558 const uint8_t *peer_key,
5559 size_t peer_key_length,
5560 uint8_t *shared_secret,
5561 size_t shared_secret_size,
5562 size_t *shared_secret_length )
5563{
5564 switch( alg )
5565 {
5566#if defined(MBEDTLS_ECDH_C)
5567 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005568 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005569 return( PSA_ERROR_INVALID_ARGUMENT );
5570 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5571 private_key->data.ecp,
5572 shared_secret, shared_secret_size,
5573 shared_secret_length ) );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005574#endif /* MBEDTLS_ECDH_C */
5575 default:
5576 (void) private_key;
5577 (void) peer_key;
5578 (void) peer_key_length;
5579 (void) shared_secret;
5580 (void) shared_secret_size;
5581 (void) shared_secret_length;
5582 return( PSA_ERROR_NOT_SUPPORTED );
5583 }
5584}
5585
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005586/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005587 * to potentially free embedded data structures and wipe confidential data.
5588 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005589static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005590 psa_key_derivation_step_t step,
Gilles Peskine2f060a82018-12-04 17:12:32 +01005591 psa_key_slot_t *private_key,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005592 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005593 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005594{
5595 psa_status_t status;
5596 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5597 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005598 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005599
5600 /* Step 1: run the secret agreement algorithm to generate the shared
5601 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005602 status = psa_key_agreement_raw_internal( ka_alg,
5603 private_key,
5604 peer_key, peer_key_length,
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005605 shared_secret,
5606 sizeof( shared_secret ),
5607 &shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005608 if( status != PSA_SUCCESS )
5609 goto exit;
5610
5611 /* Step 2: set up the key derivation to generate key material from
5612 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005613 status = psa_key_derivation_input_internal( operation, step,
5614 shared_secret,
5615 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005616
Gilles Peskine01d718c2018-09-18 12:01:02 +02005617exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005618 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005619 return( status );
5620}
5621
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005622psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005623 psa_key_derivation_step_t step,
5624 psa_key_handle_t private_key,
5625 const uint8_t *peer_key,
5626 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005627{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005628 psa_key_slot_t *slot;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005629 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005630 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005631 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005632 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005633 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005634 if( status != PSA_SUCCESS )
5635 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005636 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005637 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005638 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005639 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005640 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005641 return( status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005642}
5643
Gilles Peskinebe697d82019-05-16 18:00:41 +02005644psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5645 psa_key_handle_t private_key,
5646 const uint8_t *peer_key,
5647 size_t peer_key_length,
5648 uint8_t *output,
5649 size_t output_size,
5650 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005651{
5652 psa_key_slot_t *slot;
5653 psa_status_t status;
5654
5655 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5656 {
5657 status = PSA_ERROR_INVALID_ARGUMENT;
5658 goto exit;
5659 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005660 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005661 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005662 if( status != PSA_SUCCESS )
5663 goto exit;
5664
5665 status = psa_key_agreement_raw_internal( alg, slot,
5666 peer_key, peer_key_length,
5667 output, output_size,
5668 output_length );
5669
5670exit:
5671 if( status != PSA_SUCCESS )
5672 {
5673 /* If an error happens and is not handled properly, the output
5674 * may be used as a key to protect sensitive data. Arrange for such
5675 * a key to be random, which is likely to result in decryption or
5676 * verification errors. This is better than filling the buffer with
5677 * some constant data such as zeros, which would result in the data
5678 * being protected with a reproducible, easily knowable key.
5679 */
5680 psa_generate_random( output, output_size );
5681 *output_length = output_size;
5682 }
5683 return( status );
5684}
Gilles Peskine01d718c2018-09-18 12:01:02 +02005685
5686
5687/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005688/* Random generation */
Gilles Peskine05d69892018-06-19 22:00:52 +02005689/****************************************************************/
5690
5691psa_status_t psa_generate_random( uint8_t *output,
5692 size_t output_size )
5693{
itayzafrir0adf0fc2018-09-06 16:24:41 +03005694 int ret;
5695 GUARD_MODULE_INITIALIZED;
5696
Gilles Peskinef181eca2019-08-07 13:49:00 +02005697 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5698 {
5699 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5700 output,
5701 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5702 if( ret != 0 )
5703 return( mbedtls_to_psa_error( ret ) );
5704 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5705 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5706 }
5707
itayzafrir0adf0fc2018-09-06 16:24:41 +03005708 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
Gilles Peskine05d69892018-06-19 22:00:52 +02005709 return( mbedtls_to_psa_error( ret ) );
5710}
5711
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005712#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5713#include "mbedtls/entropy_poll.h"
avolinski13beb102018-11-20 16:51:49 +02005714
Gilles Peskine7228da22019-07-15 11:06:15 +02005715psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005716 size_t seed_size )
5717{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005718 if( global_data.initialized )
5719 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005720
5721 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5722 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5723 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5724 return( PSA_ERROR_INVALID_ARGUMENT );
5725
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005726 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005727}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005728#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005729
Gilles Peskinee56e8782019-04-26 17:34:02 +02005730#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5731static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5732 size_t domain_parameters_size,
5733 int *exponent )
5734{
5735 size_t i;
5736 uint32_t acc = 0;
5737
5738 if( domain_parameters_size == 0 )
5739 {
5740 *exponent = 65537;
5741 return( PSA_SUCCESS );
5742 }
5743
5744 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5745 * support values that fit in a 32-bit integer, which is larger than
5746 * int on just about every platform anyway. */
5747 if( domain_parameters_size > sizeof( acc ) )
5748 return( PSA_ERROR_NOT_SUPPORTED );
5749 for( i = 0; i < domain_parameters_size; i++ )
5750 acc = ( acc << 8 ) | domain_parameters[i];
5751 if( acc > INT_MAX )
5752 return( PSA_ERROR_NOT_SUPPORTED );
5753 *exponent = acc;
5754 return( PSA_SUCCESS );
5755}
5756#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5757
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005758static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005759 psa_key_slot_t *slot, size_t bits,
5760 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskine05d69892018-06-19 22:00:52 +02005761{
Gilles Peskine8e338702019-07-30 20:06:31 +02005762 psa_key_type_t type = slot->attr.type;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005763
Gilles Peskinee56e8782019-04-26 17:34:02 +02005764 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005765 return( PSA_ERROR_INVALID_ARGUMENT );
5766
Gilles Peskine48c0ea12018-06-21 14:15:31 +02005767 if( key_type_is_raw_bytes( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005768 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005769 psa_status_t status;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005770 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005771 if( status != PSA_SUCCESS )
5772 return( status );
5773 status = psa_generate_random( slot->data.raw.data,
5774 slot->data.raw.bytes );
5775 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005776 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005777#if defined(MBEDTLS_DES_C)
5778 if( type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005779 psa_des_set_key_parity( slot->data.raw.data,
5780 slot->data.raw.bytes );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005781#endif /* MBEDTLS_DES_C */
5782 }
5783 else
5784
5785#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005786 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005787 {
5788 mbedtls_rsa_context *rsa;
5789 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005790 int exponent;
5791 psa_status_t status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005792 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5793 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine86a440b2018-11-12 18:39:40 +01005794 /* Accept only byte-aligned keys, for the same reasons as
5795 * in psa_import_rsa_key(). */
5796 if( bits % 8 != 0 )
5797 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005798 status = psa_read_rsa_exponent( domain_parameters,
5799 domain_parameters_size,
5800 &exponent );
5801 if( status != PSA_SUCCESS )
5802 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005803 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5804 if( rsa == NULL )
5805 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5806 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5807 ret = mbedtls_rsa_gen_key( rsa,
5808 mbedtls_ctr_drbg_random,
5809 &global_data.ctr_drbg,
Jaeden Amero23bbb752018-06-26 14:16:54 +01005810 (unsigned int) bits,
Gilles Peskine12313cd2018-06-20 00:20:32 +02005811 exponent );
5812 if( ret != 0 )
5813 {
5814 mbedtls_rsa_free( rsa );
5815 mbedtls_free( rsa );
5816 return( mbedtls_to_psa_error( ret ) );
5817 }
5818 slot->data.rsa = rsa;
5819 }
5820 else
5821#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5822
5823#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005824 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005825 {
5826 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5827 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5828 const mbedtls_ecp_curve_info *curve_info =
5829 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5830 mbedtls_ecp_keypair *ecp;
5831 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005832 if( domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005833 return( PSA_ERROR_NOT_SUPPORTED );
5834 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5835 return( PSA_ERROR_NOT_SUPPORTED );
5836 if( curve_info->bit_size != bits )
5837 return( PSA_ERROR_INVALID_ARGUMENT );
5838 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5839 if( ecp == NULL )
5840 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5841 mbedtls_ecp_keypair_init( ecp );
5842 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5843 mbedtls_ctr_drbg_random,
5844 &global_data.ctr_drbg );
5845 if( ret != 0 )
5846 {
5847 mbedtls_ecp_keypair_free( ecp );
5848 mbedtls_free( ecp );
5849 return( mbedtls_to_psa_error( ret ) );
5850 }
5851 slot->data.ecp = ecp;
5852 }
5853 else
5854#endif /* MBEDTLS_ECP_C */
5855
5856 return( PSA_ERROR_NOT_SUPPORTED );
5857
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005858 return( PSA_SUCCESS );
5859}
5860
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005861psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005862 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005863{
5864 psa_status_t status;
5865 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005866 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine011e4282019-06-26 18:34:38 +02005867 status = psa_start_key_creation( attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005868#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5869 if( driver != NULL )
5870 {
5871 /* Generating a key in a secure element is not implemented yet. */
5872 status = PSA_ERROR_NOT_SUPPORTED;
5873 }
5874#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005875 if( status == PSA_SUCCESS )
5876 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005877 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005878 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005879 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005880 }
5881 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005882 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005883 if( status != PSA_SUCCESS )
5884 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005885 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005886 *handle = 0;
5887 }
5888 return( status );
5889}
5890
5891
Gilles Peskine05d69892018-06-19 22:00:52 +02005892
5893/****************************************************************/
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01005894/* Module setup */
5895/****************************************************************/
5896
Gilles Peskine5e769522018-11-20 21:59:56 +01005897psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5898 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5899 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5900{
5901 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5902 return( PSA_ERROR_BAD_STATE );
5903 global_data.entropy_init = entropy_init;
5904 global_data.entropy_free = entropy_free;
5905 return( PSA_SUCCESS );
5906}
5907
Gilles Peskinee59236f2018-01-27 23:32:46 +01005908void mbedtls_psa_crypto_free( void )
5909{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005910 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005911 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5912 {
5913 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005914 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005915 }
5916 /* Wipe all remaining data, including configuration.
5917 * In particular, this sets all state indicator to the value
5918 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005919 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005920#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005921 /* Unregister all secure element drivers, so that we restart from
5922 * a pristine state. */
5923 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005924#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005925}
5926
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005927#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5928/** Recover a transaction that was interrupted by a power failure.
5929 *
5930 * This function is called during initialization, before psa_crypto_init()
5931 * returns. If this function returns a failure status, the initialization
5932 * fails.
5933 */
5934static psa_status_t psa_crypto_recover_transaction(
5935 const psa_crypto_transaction_t *transaction )
5936{
5937 switch( transaction->unknown.type )
5938 {
5939 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5940 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
5941 /* TOnogrepDO - fall through to the failure case until this
5942 * is implemented */
5943 default:
5944 /* We found an unsupported transaction in the storage.
5945 * We don't know what state the storage is in. Give up. */
5946 return( PSA_ERROR_STORAGE_FAILURE );
5947 }
5948}
5949#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5950
Gilles Peskinee59236f2018-01-27 23:32:46 +01005951psa_status_t psa_crypto_init( void )
5952{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005953 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005954 const unsigned char drbg_seed[] = "PSA";
5955
Gilles Peskinec6b69072018-11-20 21:42:52 +01005956 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005957 if( global_data.initialized != 0 )
5958 return( PSA_SUCCESS );
5959
Gilles Peskine5e769522018-11-20 21:59:56 +01005960 /* Set default configuration if
5961 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5962 if( global_data.entropy_init == NULL )
5963 global_data.entropy_init = mbedtls_entropy_init;
5964 if( global_data.entropy_free == NULL )
5965 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005966
Gilles Peskinec6b69072018-11-20 21:42:52 +01005967 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005968 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01005969#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5970 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5971 /* The PSA entropy injection feature depends on using NV seed as an entropy
5972 * source. Add NV seed as an entropy source for PSA entropy injection. */
5973 mbedtls_entropy_add_source( &global_data.entropy,
5974 mbedtls_nv_seed_poll, NULL,
5975 MBEDTLS_ENTROPY_BLOCK_SIZE,
5976 MBEDTLS_ENTROPY_SOURCE_STRONG );
5977#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01005978 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005979 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005980 status = mbedtls_to_psa_error(
5981 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5982 mbedtls_entropy_func,
5983 &global_data.entropy,
5984 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5985 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005986 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005987 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005988
Gilles Peskine66fb1262018-12-10 16:29:04 +01005989 status = psa_initialize_key_slots( );
5990 if( status != PSA_SUCCESS )
5991 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005992
Gilles Peskine4b734222019-07-24 15:56:31 +02005993#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005994 status = psa_crypto_load_transaction( );
5995 if( status == PSA_SUCCESS )
5996 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005997 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5998 if( status != PSA_SUCCESS )
5999 goto exit;
6000 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006001 }
6002 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6003 {
6004 /* There's no transaction to complete. It's all good. */
6005 status = PSA_SUCCESS;
6006 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006007#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006008
Gilles Peskinec6b69072018-11-20 21:42:52 +01006009 /* All done. */
Gilles Peskinee4ebc122018-03-07 14:16:44 +01006010 global_data.initialized = 1;
6011
Gilles Peskinee59236f2018-01-27 23:32:46 +01006012exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006013 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006014 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006015 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006016}
6017
6018#endif /* MBEDTLS_PSA_CRYPTO_C */