blob: fa920cca4f15a03d41a64f41adebba11404f2220 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
4/* Copyright (C) 2018, ARM Limited, All Rights Reserved
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS (https://tls.mbed.org)
20 */
21
22#if !defined(MBEDTLS_CONFIG_FILE)
23#include "mbedtls/config.h"
24#else
25#include MBEDTLS_CONFIG_FILE
26#endif
27
28#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030029
itayzafrir7723ab12019-02-14 10:28:02 +020030#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031#include "psa/crypto.h"
32
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020036#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010038#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010039/* Include internal declarations that are useful for implementing persistently
40 * stored keys. */
41#include "psa_crypto_storage.h"
42
Gilles Peskineb46bef22019-07-30 21:32:04 +020043#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include <stdlib.h>
45#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010046#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020047#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#define mbedtls_calloc calloc
49#define mbedtls_free free
50#endif
51
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020053#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000054#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020055#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/blowfish.h"
57#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020058#include "mbedtls/chacha20.h"
59#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/cipher.h"
61#include "mbedtls/ccm.h"
62#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020065#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010067#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/error.h"
69#include "mbedtls/gcm.h"
70#include "mbedtls/md2.h"
71#include "mbedtls/md4.h"
72#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010073#include "mbedtls/md.h"
74#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010075#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010077#include "mbedtls/platform_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010078#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010079#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010080#include "mbedtls/sha1.h"
81#include "mbedtls/sha256.h"
82#include "mbedtls/sha512.h"
83#include "mbedtls/xtea.h"
84
Gilles Peskine996deb12018-08-01 15:45:45 +020085#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
86
Gilles Peskine9ef733f2018-02-07 21:05:37 +010087/* constant-time buffer comparison */
88static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
89{
90 size_t i;
91 unsigned char diff = 0;
92
93 for( i = 0; i < n; i++ )
94 diff |= a[i] ^ b[i];
95
96 return( diff );
97}
98
99
100
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100101/****************************************************************/
102/* Global data, support functions and library management */
103/****************************************************************/
104
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105static int key_type_is_raw_bytes( psa_key_type_t type )
106{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200107 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200108}
109
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100110/* Values for psa_global_data_t::rng_state */
111#define RNG_NOT_INITIALIZED 0
112#define RNG_INITIALIZED 1
113#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100114
Gilles Peskine2d277862018-06-18 15:41:12 +0200115typedef struct
116{
Gilles Peskine5e769522018-11-20 21:59:56 +0100117 void (* entropy_init )( mbedtls_entropy_context *ctx );
118 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100119 mbedtls_entropy_context entropy;
120 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100121 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100122 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123} psa_global_data_t;
124
125static psa_global_data_t global_data;
126
itayzafrir0adf0fc2018-09-06 16:24:41 +0300127#define GUARD_MODULE_INITIALIZED \
128 if( global_data.initialized == 0 ) \
129 return( PSA_ERROR_BAD_STATE );
130
Gilles Peskinee59236f2018-01-27 23:32:46 +0100131static psa_status_t mbedtls_to_psa_error( int ret )
132{
Gilles Peskinea5905292018-02-07 20:59:33 +0100133 /* If there's both a high-level code and low-level code, dispatch on
134 * the high-level code. */
135 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100136 {
137 case 0:
138 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100139
140 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
141 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
142 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
143 return( PSA_ERROR_NOT_SUPPORTED );
144 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
147 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
148 return( PSA_ERROR_HARDWARE_FAILURE );
149
Gilles Peskine9a944802018-06-21 09:35:35 +0200150 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
151 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
152 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
153 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
154 case MBEDTLS_ERR_ASN1_INVALID_DATA:
155 return( PSA_ERROR_INVALID_ARGUMENT );
156 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
157 return( PSA_ERROR_INSUFFICIENT_MEMORY );
158 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
159 return( PSA_ERROR_BUFFER_TOO_SMALL );
160
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000162 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000163#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
164 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
165#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
169 return( PSA_ERROR_HARDWARE_FAILURE );
170
Jaeden Amero93e21112019-02-20 13:57:28 +0000171#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000172 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
174 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
175#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
177 return( PSA_ERROR_NOT_SUPPORTED );
178 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
179 return( PSA_ERROR_HARDWARE_FAILURE );
180
181 case MBEDTLS_ERR_CCM_BAD_INPUT:
182 return( PSA_ERROR_INVALID_ARGUMENT );
183 case MBEDTLS_ERR_CCM_AUTH_FAILED:
184 return( PSA_ERROR_INVALID_SIGNATURE );
185 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
186 return( PSA_ERROR_HARDWARE_FAILURE );
187
Gilles Peskine26869f22019-05-06 15:25:00 +0200188 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
189 return( PSA_ERROR_INVALID_ARGUMENT );
190
191 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
192 return( PSA_ERROR_BAD_STATE );
193 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
194 return( PSA_ERROR_INVALID_SIGNATURE );
195
Gilles Peskinea5905292018-02-07 20:59:33 +0100196 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
197 return( PSA_ERROR_NOT_SUPPORTED );
198 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
199 return( PSA_ERROR_INVALID_ARGUMENT );
200 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
201 return( PSA_ERROR_INSUFFICIENT_MEMORY );
202 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
203 return( PSA_ERROR_INVALID_PADDING );
204 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
205 return( PSA_ERROR_BAD_STATE );
206 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
207 return( PSA_ERROR_INVALID_SIGNATURE );
208 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200209 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100210 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
214 return( PSA_ERROR_HARDWARE_FAILURE );
215
216 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
219 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
220 return( PSA_ERROR_NOT_SUPPORTED );
221 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
222 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
223
224 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
225 return( PSA_ERROR_NOT_SUPPORTED );
226 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
227 return( PSA_ERROR_HARDWARE_FAILURE );
228
Gilles Peskinee59236f2018-01-27 23:32:46 +0100229 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
230 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
231 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
232 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100233
234 case MBEDTLS_ERR_GCM_AUTH_FAILED:
235 return( PSA_ERROR_INVALID_SIGNATURE );
236 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200237 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100238 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
239 return( PSA_ERROR_HARDWARE_FAILURE );
240
241 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
242 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
243 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
244 return( PSA_ERROR_HARDWARE_FAILURE );
245
246 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
247 return( PSA_ERROR_NOT_SUPPORTED );
248 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
249 return( PSA_ERROR_INVALID_ARGUMENT );
250 case MBEDTLS_ERR_MD_ALLOC_FAILED:
251 return( PSA_ERROR_INSUFFICIENT_MEMORY );
252 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
253 return( PSA_ERROR_STORAGE_FAILURE );
254 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
255 return( PSA_ERROR_HARDWARE_FAILURE );
256
Gilles Peskinef76aa772018-10-29 19:24:33 +0100257 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
258 return( PSA_ERROR_STORAGE_FAILURE );
259 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
260 return( PSA_ERROR_INVALID_ARGUMENT );
261 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
264 return( PSA_ERROR_BUFFER_TOO_SMALL );
265 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
266 return( PSA_ERROR_INVALID_ARGUMENT );
267 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
268 return( PSA_ERROR_INVALID_ARGUMENT );
269 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
270 return( PSA_ERROR_INVALID_ARGUMENT );
271 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100274 case MBEDTLS_ERR_PK_ALLOC_FAILED:
275 return( PSA_ERROR_INSUFFICIENT_MEMORY );
276 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
277 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100281 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
282 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
283 return( PSA_ERROR_INVALID_ARGUMENT );
284 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
285 return( PSA_ERROR_NOT_SUPPORTED );
286 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
287 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
288 return( PSA_ERROR_NOT_PERMITTED );
289 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
290 return( PSA_ERROR_INVALID_ARGUMENT );
291 case MBEDTLS_ERR_PK_INVALID_ALG:
292 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
293 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
294 return( PSA_ERROR_NOT_SUPPORTED );
295 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
296 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100297 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299
Gilles Peskineff2d2002019-05-06 15:26:23 +0200300 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
301 return( PSA_ERROR_HARDWARE_FAILURE );
302 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
303 return( PSA_ERROR_NOT_SUPPORTED );
304
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
306 return( PSA_ERROR_HARDWARE_FAILURE );
307
308 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
309 return( PSA_ERROR_INVALID_ARGUMENT );
310 case MBEDTLS_ERR_RSA_INVALID_PADDING:
311 return( PSA_ERROR_INVALID_PADDING );
312 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
313 return( PSA_ERROR_HARDWARE_FAILURE );
314 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
315 return( PSA_ERROR_INVALID_ARGUMENT );
316 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
317 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200318 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100319 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
320 return( PSA_ERROR_INVALID_SIGNATURE );
321 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
322 return( PSA_ERROR_BUFFER_TOO_SMALL );
323 case MBEDTLS_ERR_RSA_RNG_FAILED:
324 return( PSA_ERROR_INSUFFICIENT_MEMORY );
325 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
326 return( PSA_ERROR_NOT_SUPPORTED );
327 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
328 return( PSA_ERROR_HARDWARE_FAILURE );
329
330 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
331 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
332 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
333 return( PSA_ERROR_HARDWARE_FAILURE );
334
335 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
336 return( PSA_ERROR_INVALID_ARGUMENT );
337 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
338 return( PSA_ERROR_HARDWARE_FAILURE );
339
itayzafrir5c753392018-05-08 11:18:38 +0300340 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300341 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300342 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300343 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
344 return( PSA_ERROR_BUFFER_TOO_SMALL );
345 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
346 return( PSA_ERROR_NOT_SUPPORTED );
347 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
348 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
349 return( PSA_ERROR_INVALID_SIGNATURE );
350 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
351 return( PSA_ERROR_INSUFFICIENT_MEMORY );
352 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
353 return( PSA_ERROR_HARDWARE_FAILURE );
itayzafrir5c753392018-05-08 11:18:38 +0300354
Gilles Peskinee59236f2018-01-27 23:32:46 +0100355 default:
David Saadab4ecc272019-02-14 13:48:10 +0200356 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100357 }
358}
359
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200360
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200361
362
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100363/****************************************************************/
364/* Key management */
365/****************************************************************/
366
Gilles Peskine73167e12019-07-12 23:44:37 +0200367#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
368static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
369{
Gilles Peskine8e338702019-07-30 20:06:31 +0200370 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200371}
372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
373
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100374#if defined(MBEDTLS_ECP_C)
Gilles Peskine34ef7f52018-06-18 20:47:51 +0200375static psa_ecc_curve_t mbedtls_ecc_group_to_psa( mbedtls_ecp_group_id grpid )
376{
377 switch( grpid )
378 {
379 case MBEDTLS_ECP_DP_SECP192R1:
380 return( PSA_ECC_CURVE_SECP192R1 );
381 case MBEDTLS_ECP_DP_SECP224R1:
382 return( PSA_ECC_CURVE_SECP224R1 );
383 case MBEDTLS_ECP_DP_SECP256R1:
384 return( PSA_ECC_CURVE_SECP256R1 );
385 case MBEDTLS_ECP_DP_SECP384R1:
386 return( PSA_ECC_CURVE_SECP384R1 );
387 case MBEDTLS_ECP_DP_SECP521R1:
388 return( PSA_ECC_CURVE_SECP521R1 );
389 case MBEDTLS_ECP_DP_BP256R1:
390 return( PSA_ECC_CURVE_BRAINPOOL_P256R1 );
391 case MBEDTLS_ECP_DP_BP384R1:
392 return( PSA_ECC_CURVE_BRAINPOOL_P384R1 );
393 case MBEDTLS_ECP_DP_BP512R1:
394 return( PSA_ECC_CURVE_BRAINPOOL_P512R1 );
395 case MBEDTLS_ECP_DP_CURVE25519:
396 return( PSA_ECC_CURVE_CURVE25519 );
397 case MBEDTLS_ECP_DP_SECP192K1:
398 return( PSA_ECC_CURVE_SECP192K1 );
399 case MBEDTLS_ECP_DP_SECP224K1:
400 return( PSA_ECC_CURVE_SECP224K1 );
401 case MBEDTLS_ECP_DP_SECP256K1:
402 return( PSA_ECC_CURVE_SECP256K1 );
403 case MBEDTLS_ECP_DP_CURVE448:
404 return( PSA_ECC_CURVE_CURVE448 );
405 default:
406 return( 0 );
407 }
408}
409
Gilles Peskine12313cd2018-06-20 00:20:32 +0200410static mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_curve_t curve )
411{
412 switch( curve )
413 {
414 case PSA_ECC_CURVE_SECP192R1:
415 return( MBEDTLS_ECP_DP_SECP192R1 );
416 case PSA_ECC_CURVE_SECP224R1:
417 return( MBEDTLS_ECP_DP_SECP224R1 );
418 case PSA_ECC_CURVE_SECP256R1:
419 return( MBEDTLS_ECP_DP_SECP256R1 );
420 case PSA_ECC_CURVE_SECP384R1:
421 return( MBEDTLS_ECP_DP_SECP384R1 );
422 case PSA_ECC_CURVE_SECP521R1:
423 return( MBEDTLS_ECP_DP_SECP521R1 );
424 case PSA_ECC_CURVE_BRAINPOOL_P256R1:
425 return( MBEDTLS_ECP_DP_BP256R1 );
426 case PSA_ECC_CURVE_BRAINPOOL_P384R1:
427 return( MBEDTLS_ECP_DP_BP384R1 );
428 case PSA_ECC_CURVE_BRAINPOOL_P512R1:
429 return( MBEDTLS_ECP_DP_BP512R1 );
430 case PSA_ECC_CURVE_CURVE25519:
431 return( MBEDTLS_ECP_DP_CURVE25519 );
432 case PSA_ECC_CURVE_SECP192K1:
433 return( MBEDTLS_ECP_DP_SECP192K1 );
434 case PSA_ECC_CURVE_SECP224K1:
435 return( MBEDTLS_ECP_DP_SECP224K1 );
436 case PSA_ECC_CURVE_SECP256K1:
437 return( MBEDTLS_ECP_DP_SECP256K1 );
438 case PSA_ECC_CURVE_CURVE448:
439 return( MBEDTLS_ECP_DP_CURVE448 );
440 default:
441 return( MBEDTLS_ECP_DP_NONE );
442 }
443}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100444#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200445
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446static psa_status_t prepare_raw_data_slot( psa_key_type_t type,
447 size_t bits,
448 struct raw_data *raw )
449{
450 /* Check that the bit size is acceptable for the key type */
451 switch( type )
452 {
453 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200454 if( bits == 0 )
455 {
456 raw->bytes = 0;
457 raw->data = NULL;
458 return( PSA_SUCCESS );
459 }
460 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200461#if defined(MBEDTLS_MD_C)
462 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200463#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200464 case PSA_KEY_TYPE_DERIVE:
465 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200466#if defined(MBEDTLS_AES_C)
467 case PSA_KEY_TYPE_AES:
468 if( bits != 128 && bits != 192 && bits != 256 )
469 return( PSA_ERROR_INVALID_ARGUMENT );
470 break;
471#endif
472#if defined(MBEDTLS_CAMELLIA_C)
473 case PSA_KEY_TYPE_CAMELLIA:
474 if( bits != 128 && bits != 192 && bits != 256 )
475 return( PSA_ERROR_INVALID_ARGUMENT );
476 break;
477#endif
478#if defined(MBEDTLS_DES_C)
479 case PSA_KEY_TYPE_DES:
480 if( bits != 64 && bits != 128 && bits != 192 )
481 return( PSA_ERROR_INVALID_ARGUMENT );
482 break;
483#endif
484#if defined(MBEDTLS_ARC4_C)
485 case PSA_KEY_TYPE_ARC4:
486 if( bits < 8 || bits > 2048 )
487 return( PSA_ERROR_INVALID_ARGUMENT );
488 break;
489#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200490#if defined(MBEDTLS_CHACHA20_C)
491 case PSA_KEY_TYPE_CHACHA20:
492 if( bits != 256 )
493 return( PSA_ERROR_INVALID_ARGUMENT );
494 break;
495#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200496 default:
497 return( PSA_ERROR_NOT_SUPPORTED );
498 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200499 if( bits % 8 != 0 )
500 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200501
502 /* Allocate memory for the key */
503 raw->bytes = PSA_BITS_TO_BYTES( bits );
504 raw->data = mbedtls_calloc( 1, raw->bytes );
505 if( raw->data == NULL )
506 {
507 raw->bytes = 0;
508 return( PSA_ERROR_INSUFFICIENT_MEMORY );
509 }
510 return( PSA_SUCCESS );
511}
512
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200513#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100514/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
515 * that are not a multiple of 8) well. For example, there is only
516 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
517 * way to return the exact bit size of a key.
518 * To keep things simple, reject non-byte-aligned key sizes. */
519static psa_status_t psa_check_rsa_key_byte_aligned(
520 const mbedtls_rsa_context *rsa )
521{
522 mbedtls_mpi n;
523 psa_status_t status;
524 mbedtls_mpi_init( &n );
525 status = mbedtls_to_psa_error(
526 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
527 if( status == PSA_SUCCESS )
528 {
529 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
530 status = PSA_ERROR_NOT_SUPPORTED;
531 }
532 mbedtls_mpi_free( &n );
533 return( status );
534}
535
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536static psa_status_t psa_import_rsa_key( psa_key_type_t type,
537 const uint8_t *data,
538 size_t data_length,
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200539 mbedtls_rsa_context **p_rsa )
540{
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000541 psa_status_t status;
542 mbedtls_pk_context pk;
543 mbedtls_rsa_context *rsa;
544 size_t bits;
545
546 mbedtls_pk_init( &pk );
547
548 /* Parse the data. */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200549 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000550 status = mbedtls_to_psa_error(
551 mbedtls_pk_parse_key( &pk, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200552 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000553 status = mbedtls_to_psa_error(
554 mbedtls_pk_parse_public_key( &pk, data, data_length ) );
555 if( status != PSA_SUCCESS )
556 goto exit;
557
558 /* We have something that the pkparse module recognizes. If it is a
559 * valid RSA key, store it. */
560 if( mbedtls_pk_get_type( &pk ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200561 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000562 status = PSA_ERROR_INVALID_ARGUMENT;
563 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200564 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000565
566 rsa = mbedtls_pk_rsa( pk );
567 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
568 * supports non-byte-aligned key sizes, but not well. For example,
569 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
570 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
571 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
572 {
573 status = PSA_ERROR_NOT_SUPPORTED;
574 goto exit;
575 }
576 status = psa_check_rsa_key_byte_aligned( rsa );
577
578exit:
579 /* Free the content of the pk object only on error. */
580 if( status != PSA_SUCCESS )
581 {
582 mbedtls_pk_free( &pk );
583 return( status );
584 }
585
586 /* On success, store the content of the object in the RSA context. */
587 *p_rsa = rsa;
588
589 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200590}
591#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
592
Jaeden Ameroccdce902019-01-10 11:42:27 +0000593#if defined(MBEDTLS_ECP_C)
594
595/* Import a public key given as the uncompressed representation defined by SEC1
596 * 2.3.3 as the content of an ECPoint. */
597static psa_status_t psa_import_ec_public_key( psa_ecc_curve_t curve,
598 const uint8_t *data,
599 size_t data_length,
600 mbedtls_ecp_keypair **p_ecp )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200601{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200602 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000603 mbedtls_ecp_keypair *ecp = NULL;
604 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
605
606 *p_ecp = NULL;
607 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
608 if( ecp == NULL )
609 return( PSA_ERROR_INSUFFICIENT_MEMORY );
610 mbedtls_ecp_keypair_init( ecp );
611
612 /* Load the group. */
613 status = mbedtls_to_psa_error(
614 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
615 if( status != PSA_SUCCESS )
616 goto exit;
617 /* Load the public value. */
618 status = mbedtls_to_psa_error(
619 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
620 data, data_length ) );
621 if( status != PSA_SUCCESS )
622 goto exit;
623
624 /* Check that the point is on the curve. */
625 status = mbedtls_to_psa_error(
626 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
627 if( status != PSA_SUCCESS )
628 goto exit;
629
630 *p_ecp = ecp;
631 return( PSA_SUCCESS );
632
633exit:
634 if( ecp != NULL )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200635 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000636 mbedtls_ecp_keypair_free( ecp );
637 mbedtls_free( ecp );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200638 }
Jaeden Ameroccdce902019-01-10 11:42:27 +0000639 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200640}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000641#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200642
Gilles Peskinef76aa772018-10-29 19:24:33 +0100643#if defined(MBEDTLS_ECP_C)
644/* Import a private key given as a byte string which is the private value
645 * in big-endian order. */
646static psa_status_t psa_import_ec_private_key( psa_ecc_curve_t curve,
647 const uint8_t *data,
648 size_t data_length,
649 mbedtls_ecp_keypair **p_ecp )
650{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100652 mbedtls_ecp_keypair *ecp = NULL;
653 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
654
Gilles Peskine2c86ebc2019-05-13 14:21:57 +0200655 if( PSA_BITS_TO_BYTES( PSA_ECC_CURVE_BITS( curve ) ) != data_length )
656 return( PSA_ERROR_INVALID_ARGUMENT );
657
Gilles Peskinef76aa772018-10-29 19:24:33 +0100658 *p_ecp = NULL;
659 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
660 if( ecp == NULL )
661 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Jaeden Amero83d29392019-01-10 20:17:42 +0000662 mbedtls_ecp_keypair_init( ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100663
664 /* Load the group. */
665 status = mbedtls_to_psa_error(
666 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
667 if( status != PSA_SUCCESS )
668 goto exit;
669 /* Load the secret value. */
670 status = mbedtls_to_psa_error(
671 mbedtls_mpi_read_binary( &ecp->d, data, data_length ) );
672 if( status != PSA_SUCCESS )
673 goto exit;
674 /* Validate the private key. */
675 status = mbedtls_to_psa_error(
676 mbedtls_ecp_check_privkey( &ecp->grp, &ecp->d ) );
677 if( status != PSA_SUCCESS )
678 goto exit;
679 /* Calculate the public key from the private key. */
680 status = mbedtls_to_psa_error(
681 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
682 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
683 if( status != PSA_SUCCESS )
684 goto exit;
685
686 *p_ecp = ecp;
687 return( PSA_SUCCESS );
688
689exit:
690 if( ecp != NULL )
691 {
692 mbedtls_ecp_keypair_free( ecp );
693 mbedtls_free( ecp );
694 }
695 return( status );
696}
697#endif /* defined(MBEDTLS_ECP_C) */
698
Gilles Peskineb46bef22019-07-30 21:32:04 +0200699
700/** Return the size of the key in the given slot, in bits.
701 *
702 * \param[in] slot A key slot.
703 *
704 * \return The key size in bits, read from the metadata in the slot.
705 */
706static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
707{
708 return( slot->attr.bits );
709}
710
711/** Calculate the size of the key in the given slot, in bits.
712 *
713 * \param[in] slot A key slot containing a transparent key.
714 *
715 * \return The key size in bits, calculated from the key data.
716 */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200717static psa_key_bits_t psa_calculate_key_bits( const psa_key_slot_t *slot )
Gilles Peskineb46bef22019-07-30 21:32:04 +0200718{
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200719 size_t bits = 0; /* return 0 on an empty slot */
720
Gilles Peskineb46bef22019-07-30 21:32:04 +0200721 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200722 bits = PSA_BYTES_TO_BITS( slot->data.raw.bytes );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200723#if defined(MBEDTLS_RSA_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200724 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
725 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200726#endif /* defined(MBEDTLS_RSA_C) */
727#if defined(MBEDTLS_ECP_C)
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200728 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
729 bits = slot->data.ecp->grp.pbits;
Gilles Peskineb46bef22019-07-30 21:32:04 +0200730#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine8908c5e2019-07-31 18:55:00 +0200731
732 /* We know that the size fits in psa_key_bits_t thanks to checks
733 * when the key was created. */
734 return( (psa_key_bits_t) bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +0200735}
736
Gilles Peskine8e338702019-07-30 20:06:31 +0200737/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100738 * previously. This function assumes that the slot does not contain
739 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100740psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
741 const uint8_t *data,
742 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100743{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200744 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100745
Gilles Peskine8e338702019-07-30 20:06:31 +0200746 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100747 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200748 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200749 /* Ensure that the bytes-to-bit conversion didn't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100750 if( data_length > SIZE_MAX / 8 )
751 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200752 /* Enforce a size limit, and in particular ensure that the bit
753 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200754 if( bit_size > PSA_MAX_KEY_BITS )
755 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine8e338702019-07-30 20:06:31 +0200756 status = prepare_raw_data_slot( slot->attr.type, bit_size,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200757 &slot->data.raw );
758 if( status != PSA_SUCCESS )
759 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200760 if( data_length != 0 )
761 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100762 }
763 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100764#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200765 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100766 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200767 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100768 data, data_length,
769 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100770 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200771 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100772 {
Jaeden Ameroccdce902019-01-10 11:42:27 +0000773 status = psa_import_ec_public_key(
Gilles Peskine8e338702019-07-30 20:06:31 +0200774 PSA_KEY_TYPE_GET_CURVE( slot->attr.type ),
Jaeden Ameroccdce902019-01-10 11:42:27 +0000775 data, data_length,
776 &slot->data.ecp );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100777 }
778 else
Gilles Peskine969ac722018-01-28 18:16:59 +0100779#endif /* MBEDTLS_ECP_C */
Jaeden Ameroccdce902019-01-10 11:42:27 +0000780#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200781 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100782 {
Gilles Peskine8e338702019-07-30 20:06:31 +0200783 status = psa_import_rsa_key( slot->attr.type,
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000784 data, data_length,
785 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100786 }
787 else
Jaeden Ameroccdce902019-01-10 11:42:27 +0000788#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100789 {
790 return( PSA_ERROR_NOT_SUPPORTED );
791 }
Darryl Green940d72c2018-07-13 13:18:51 +0100792
Gilles Peskineb46bef22019-07-30 21:32:04 +0200793 if( status == PSA_SUCCESS )
794 {
795 /* Write the actual key size to the slot.
796 * psa_start_key_creation() wrote the size declared by the
797 * caller, which may be 0 (meaning unspecified) or wrong. */
798 slot->attr.bits = psa_calculate_key_bits( slot );
799 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100800 return( status );
801}
802
Gilles Peskinef603c712019-01-19 13:40:11 +0100803/** Calculate the intersection of two algorithm usage policies.
804 *
805 * Return 0 (which allows no operation) on incompatibility.
806 */
807static psa_algorithm_t psa_key_policy_algorithm_intersection(
808 psa_algorithm_t alg1,
809 psa_algorithm_t alg2 )
810{
Gilles Peskine549ea862019-05-22 11:45:59 +0200811 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100812 if( alg1 == alg2 )
813 return( alg1 );
814 /* If the policies are from the same hash-and-sign family, check
815 * if one is a wildcard. If so the other has the specific algorithm. */
816 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
817 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
818 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
819 {
820 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
821 return( alg2 );
822 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
823 return( alg1 );
824 }
825 /* If the policies are incompatible, allow nothing. */
826 return( 0 );
827}
828
Gilles Peskined6f371b2019-05-10 19:33:38 +0200829static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
830 psa_algorithm_t requested_alg )
831{
Gilles Peskine549ea862019-05-22 11:45:59 +0200832 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200833 if( requested_alg == policy_alg )
834 return( 1 );
835 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200836 * and requested_alg is the same hash-and-sign family with any hash,
837 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200838 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
839 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
840 {
841 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
842 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
843 }
844 /* If it isn't permitted, it's forbidden. */
845 return( 0 );
846}
847
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100848/** Test whether a policy permits an algorithm.
849 *
850 * The caller must test usage flags separately.
851 */
852static int psa_key_policy_permits( const psa_key_policy_t *policy,
853 psa_algorithm_t alg )
854{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200855 return( psa_key_algorithm_permits( policy->alg, alg ) ||
856 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100857}
858
Gilles Peskinef603c712019-01-19 13:40:11 +0100859/** Restrict a key policy based on a constraint.
860 *
861 * \param[in,out] policy The policy to restrict.
862 * \param[in] constraint The policy constraint to apply.
863 *
864 * \retval #PSA_SUCCESS
865 * \c *policy contains the intersection of the original value of
866 * \c *policy and \c *constraint.
867 * \retval #PSA_ERROR_INVALID_ARGUMENT
868 * \c *policy and \c *constraint are incompatible.
869 * \c *policy is unchanged.
870 */
871static psa_status_t psa_restrict_key_policy(
872 psa_key_policy_t *policy,
873 const psa_key_policy_t *constraint )
874{
875 psa_algorithm_t intersection_alg =
876 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200877 psa_algorithm_t intersection_alg2 =
878 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100879 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
880 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200881 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
882 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100883 policy->usage &= constraint->usage;
884 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200885 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100886 return( PSA_SUCCESS );
887}
888
Darryl Green06fd18d2018-07-16 11:21:11 +0100889/** Retrieve a slot which must contain a key. The key must have allow all the
890 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
891 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100892static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100893 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100894 psa_key_usage_t usage,
895 psa_algorithm_t alg )
896{
897 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100898 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100899
900 *p_slot = NULL;
901
Gilles Peskinec5487a82018-12-03 18:08:14 +0100902 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100903 if( status != PSA_SUCCESS )
904 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100905
906 /* Enforce that usage policy for the key slot contains all the flags
907 * required by the usage parameter. There is one exception: public
908 * keys can always be exported, so we treat public key objects as
909 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200910 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100911 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +0200912 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +0100913 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914
915 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200916 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100917 return( PSA_ERROR_NOT_PERMITTED );
918
919 *p_slot = slot;
920 return( PSA_SUCCESS );
921}
Darryl Green940d72c2018-07-13 13:18:51 +0100922
Gilles Peskine28f8f302019-07-24 13:30:31 +0200923/** Retrieve a slot which must contain a transparent key.
924 *
925 * A transparent key is a key for which the key material is directly
926 * available, as opposed to a key in a secure element.
927 *
Gilles Peskine60450a42019-07-25 11:32:45 +0200928 * This is a temporary function to use instead of psa_get_key_from_slot()
929 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200930 */
931#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
932static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
933 psa_key_slot_t **p_slot,
934 psa_key_usage_t usage,
935 psa_algorithm_t alg )
936{
937 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
938 if( status != PSA_SUCCESS )
939 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +0200940 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200941 {
942 *p_slot = NULL;
943 return( PSA_ERROR_NOT_SUPPORTED );
944 }
945 return( PSA_SUCCESS );
946}
947#else /* MBEDTLS_PSA_CRYPTO_SE_C */
948/* With no secure element support, all keys are transparent. */
949#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
950 psa_get_key_from_slot( handle, p_slot, usage, alg )
951#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
952
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100953/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100954static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000955{
Gilles Peskine73167e12019-07-12 23:44:37 +0200956#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
957 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000958 {
959 /* No key material to clean. */
960 }
Gilles Peskine73167e12019-07-12 23:44:37 +0200961 else
962#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine8e338702019-07-30 20:06:31 +0200963 if( slot->attr.type == PSA_KEY_TYPE_NONE )
Darryl Green40225ba2018-11-15 14:48:15 +0000964 {
965 /* No key material to clean. */
966 }
Gilles Peskine8e338702019-07-30 20:06:31 +0200967 else if( key_type_is_raw_bytes( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000968 {
969 mbedtls_free( slot->data.raw.data );
970 }
971 else
972#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200973 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000974 {
975 mbedtls_rsa_free( slot->data.rsa );
976 mbedtls_free( slot->data.rsa );
977 }
978 else
979#endif /* defined(MBEDTLS_RSA_C) */
980#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200981 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Darryl Green40225ba2018-11-15 14:48:15 +0000982 {
983 mbedtls_ecp_keypair_free( slot->data.ecp );
984 mbedtls_free( slot->data.ecp );
985 }
986 else
987#endif /* defined(MBEDTLS_ECP_C) */
988 {
989 /* Shouldn't happen: the key type is not any type that we
990 * put in. */
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200991 return( PSA_ERROR_CORRUPTION_DETECTED );
Darryl Green40225ba2018-11-15 14:48:15 +0000992 }
993
994 return( PSA_SUCCESS );
995}
996
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100997/** Completely wipe a slot in memory, including its policy.
998 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100999psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001000{
1001 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001002 /* Multipart operations may still be using the key. This is safe
1003 * because all multipart operation objects are independent from
1004 * the key slot: if they need to access the key after the setup
1005 * phase, they have a copy of the key. Note that this means that
1006 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001007 /* At this point, key material and other type-specific content has
1008 * been wiped. Clear remaining metadata. We can call memset and not
1009 * zeroize because the metadata is not particularly sensitive. */
1010 memset( slot, 0, sizeof( *slot ) );
1011 return( status );
1012}
1013
Gilles Peskinec5487a82018-12-03 18:08:14 +01001014psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001015{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001016 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001017 psa_status_t status; /* status of the last operation */
1018 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001019#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1020 psa_se_drv_table_entry_t *driver;
1021#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001022
Gilles Peskinec5487a82018-12-03 18:08:14 +01001023 status = psa_get_key_slot( handle, &slot );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001024 if( status != PSA_SUCCESS )
1025 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001026
1027#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001028 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001029 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001030 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001031 /* For a key in a secure element, we need to do three things:
1032 * remove the key file in internal storage, destroy the
1033 * key inside the secure element, and update the driver's
1034 * persistent data. Start a transaction that will encompass these
1035 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001036 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001037 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001038 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001039 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001040 status = psa_crypto_save_transaction( );
1041 if( status != PSA_SUCCESS )
1042 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001043 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001044 /* We should still try to destroy the key in the secure
1045 * element and the key metadata in storage. This is especially
1046 * important if the error is that the storage is full.
1047 * But how to do it exactly without risking an inconsistent
1048 * state after a reset?
1049 * https://github.com/ARMmbed/mbed-crypto/issues/215
1050 */
1051 overall_status = status;
1052 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001053 }
1054
Gilles Peskine354f7672019-07-12 23:46:38 +02001055 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001056 if( overall_status == PSA_SUCCESS )
1057 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001058 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001059#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1060
Darryl Greend49a4992018-06-18 17:27:26 +01001061#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001062 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001063 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001064 status = psa_destroy_persistent_key( slot->attr.id );
1065 if( overall_status == PSA_SUCCESS )
1066 overall_status = status;
1067
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001068 /* TODO: other slots may have a copy of the same key. We should
1069 * invalidate them.
1070 * https://github.com/ARMmbed/mbed-crypto/issues/214
1071 */
Darryl Greend49a4992018-06-18 17:27:26 +01001072 }
1073#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001074
Gilles Peskinefc762652019-07-22 19:30:34 +02001075#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1076 if( driver != NULL )
1077 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001078 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079 if( overall_status == PSA_SUCCESS )
1080 overall_status = status;
1081 status = psa_crypto_stop_transaction( );
1082 if( overall_status == PSA_SUCCESS )
1083 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001084 }
1085#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1086
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001087#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1088exit:
1089#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001090 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001091 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1092 if( overall_status == PSA_SUCCESS )
1093 overall_status = status;
1094 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001095}
1096
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001097void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001098{
Gilles Peskineb699f072019-04-26 16:06:02 +02001099 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001100 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001101}
1102
Gilles Peskineb699f072019-04-26 16:06:02 +02001103psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1104 psa_key_type_t type,
1105 const uint8_t *data,
1106 size_t data_length )
1107{
1108 uint8_t *copy = NULL;
1109
1110 if( data_length != 0 )
1111 {
1112 copy = mbedtls_calloc( 1, data_length );
1113 if( copy == NULL )
1114 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1115 memcpy( copy, data, data_length );
1116 }
1117 /* After this point, this function is guaranteed to succeed, so it
1118 * can start modifying `*attributes`. */
1119
1120 if( attributes->domain_parameters != NULL )
1121 {
1122 mbedtls_free( attributes->domain_parameters );
1123 attributes->domain_parameters = NULL;
1124 attributes->domain_parameters_size = 0;
1125 }
1126
1127 attributes->domain_parameters = copy;
1128 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001129 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001130 return( PSA_SUCCESS );
1131}
1132
1133psa_status_t psa_get_key_domain_parameters(
1134 const psa_key_attributes_t *attributes,
1135 uint8_t *data, size_t data_size, size_t *data_length )
1136{
1137 if( attributes->domain_parameters_size > data_size )
1138 return( PSA_ERROR_BUFFER_TOO_SMALL );
1139 *data_length = attributes->domain_parameters_size;
1140 if( attributes->domain_parameters_size != 0 )
1141 memcpy( data, attributes->domain_parameters,
1142 attributes->domain_parameters_size );
1143 return( PSA_SUCCESS );
1144}
1145
1146#if defined(MBEDTLS_RSA_C)
1147static psa_status_t psa_get_rsa_public_exponent(
1148 const mbedtls_rsa_context *rsa,
1149 psa_key_attributes_t *attributes )
1150{
1151 mbedtls_mpi mpi;
1152 int ret;
1153 uint8_t *buffer = NULL;
1154 size_t buflen;
1155 mbedtls_mpi_init( &mpi );
1156
1157 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1158 if( ret != 0 )
1159 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001160 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1161 {
1162 /* It's the default value, which is reported as an empty string,
1163 * so there's nothing to do. */
1164 goto exit;
1165 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001166
1167 buflen = mbedtls_mpi_size( &mpi );
1168 buffer = mbedtls_calloc( 1, buflen );
1169 if( buffer == NULL )
1170 {
1171 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1172 goto exit;
1173 }
1174 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1175 if( ret != 0 )
1176 goto exit;
1177 attributes->domain_parameters = buffer;
1178 attributes->domain_parameters_size = buflen;
1179
1180exit:
1181 mbedtls_mpi_free( &mpi );
1182 if( ret != 0 )
1183 mbedtls_free( buffer );
1184 return( mbedtls_to_psa_error( ret ) );
1185}
1186#endif /* MBEDTLS_RSA_C */
1187
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001188/** Retrieve all the publicly-accessible attributes of a key.
1189 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001190psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1191 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001192{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001193 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001194 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001195
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001196 psa_reset_key_attributes( attributes );
1197
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001198 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001199 if( status != PSA_SUCCESS )
1200 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001201
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001202 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001203 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1204 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1205
1206#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1207 if( psa_key_slot_is_external( slot ) )
1208 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1209#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001210
Gilles Peskine8e338702019-07-30 20:06:31 +02001211 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001212 {
1213#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001214 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001215 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001216#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001217 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001218 * is not yet implemented.
1219 * https://github.com/ARMmbed/mbed-crypto/issues/216
1220 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001221 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001222 break;
1223#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001224 status = psa_get_rsa_public_exponent( slot->data.rsa, attributes );
1225 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001226#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001227 default:
1228 /* Nothing else to do. */
1229 break;
1230 }
1231
1232 if( status != PSA_SUCCESS )
1233 psa_reset_key_attributes( attributes );
1234 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001235}
1236
Gilles Peskinec8000c02019-08-02 20:15:51 +02001237#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1238psa_status_t psa_get_key_slot_number(
1239 const psa_key_attributes_t *attributes,
1240 psa_key_slot_number_t *slot_number )
1241{
1242 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1243 {
1244 *slot_number = attributes->slot_number;
1245 return( PSA_SUCCESS );
1246 }
1247 else
1248 return( PSA_ERROR_INVALID_ARGUMENT );
1249}
1250#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1251
Jaeden Ameroccdce902019-01-10 11:42:27 +00001252#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero25384a22019-01-10 10:23:21 +00001253static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1254 unsigned char *buf, size_t size )
1255{
1256 int ret;
1257 unsigned char *c;
1258 size_t len = 0;
1259
1260 c = buf + size;
1261
1262 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1263
1264 return( (int) len );
1265}
Jaeden Ameroccdce902019-01-10 11:42:27 +00001266#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero25384a22019-01-10 10:23:21 +00001267
Gilles Peskinef603c712019-01-19 13:40:11 +01001268static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1269 uint8_t *data,
1270 size_t data_size,
1271 size_t *data_length,
1272 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001273{
Gilles Peskine5d309672019-07-12 23:47:28 +02001274#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1275 const psa_drv_se_t *drv;
1276 psa_drv_se_context_t *drv_context;
1277#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1278
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001279 *data_length = 0;
1280
Gilles Peskine8e338702019-07-30 20:06:31 +02001281 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001282 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001283
Gilles Peskine5d309672019-07-12 23:47:28 +02001284#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001285 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001286 {
1287 psa_drv_se_export_key_t method;
1288 if( drv->key_management == NULL )
1289 return( PSA_ERROR_NOT_SUPPORTED );
1290 method = ( export_public_key ?
1291 drv->key_management->p_export_public :
1292 drv->key_management->p_export );
1293 if( method == NULL )
1294 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001295 return( method( drv_context,
1296 slot->data.se.slot_number,
1297 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001298 }
1299#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1300
Gilles Peskine8e338702019-07-30 20:06:31 +02001301 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001302 {
1303 if( slot->data.raw.bytes > data_size )
1304 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine52b90182018-10-29 19:26:27 +01001305 if( data_size != 0 )
1306 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001307 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
Gilles Peskine52b90182018-10-29 19:26:27 +01001308 memset( data + slot->data.raw.bytes, 0,
1309 data_size - slot->data.raw.bytes );
1310 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001311 *data_length = slot->data.raw.bytes;
1312 return( PSA_SUCCESS );
1313 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001314#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001315 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->attr.type ) && !export_public_key )
Gilles Peskine188c71e2018-10-29 19:26:02 +01001316 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001317 psa_status_t status;
1318
Gilles Peskineb46bef22019-07-30 21:32:04 +02001319 size_t bytes = PSA_BITS_TO_BYTES( slot->attr.bits );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001320 if( bytes > data_size )
1321 return( PSA_ERROR_BUFFER_TOO_SMALL );
1322 status = mbedtls_to_psa_error(
1323 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1324 if( status != PSA_SUCCESS )
1325 return( status );
1326 memset( data + bytes, 0, data_size - bytes );
1327 *data_length = bytes;
1328 return( PSA_SUCCESS );
1329 }
1330#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001331 else
Moran Peker17e36e12018-05-02 12:55:20 +03001332 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001333#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001334 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1335 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001336 {
Moran Pekera998bc62018-04-16 18:16:20 +03001337 mbedtls_pk_context pk;
1338 int ret;
Gilles Peskine8e338702019-07-30 20:06:31 +02001339 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001340 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001341#if defined(MBEDTLS_RSA_C)
1342 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001343 pk.pk_info = &mbedtls_rsa_info;
1344 pk.pk_ctx = slot->data.rsa;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001345#else
1346 return( PSA_ERROR_NOT_SUPPORTED );
1347#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001348 }
1349 else
1350 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001351#if defined(MBEDTLS_ECP_C)
1352 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001353 pk.pk_info = &mbedtls_eckey_info;
1354 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001355#else
1356 return( PSA_ERROR_NOT_SUPPORTED );
1357#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001358 }
Gilles Peskine8e338702019-07-30 20:06:31 +02001359 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Jaeden Amero25384a22019-01-10 10:23:21 +00001360 {
Jaeden Ameroccdce902019-01-10 11:42:27 +00001361 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001362 }
Moran Peker17e36e12018-05-02 12:55:20 +03001363 else
Jaeden Amero25384a22019-01-10 10:23:21 +00001364 {
Moran Peker17e36e12018-05-02 12:55:20 +03001365 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero25384a22019-01-10 10:23:21 +00001366 }
Moran Peker60364322018-04-29 11:34:58 +03001367 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001368 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001369 /* If data_size is 0 then data may be NULL and then the
1370 * call to memset would have undefined behavior. */
1371 if( data_size != 0 )
1372 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001373 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001374 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001375 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1376 * Move the data to the beginning and erase remaining data
1377 * at the original location. */
1378 if( 2 * (size_t) ret <= data_size )
1379 {
1380 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001381 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001382 }
1383 else if( (size_t) ret < data_size )
1384 {
1385 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001386 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001387 }
Moran Pekera998bc62018-04-16 18:16:20 +03001388 *data_length = ret;
1389 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001390 }
1391 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001392#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001393 {
1394 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001395 it is valid for a special-purpose implementation to omit
1396 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001397 return( PSA_ERROR_NOT_SUPPORTED );
1398 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001399 }
1400}
1401
Gilles Peskinec5487a82018-12-03 18:08:14 +01001402psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001403 uint8_t *data,
1404 size_t data_size,
1405 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001406{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001407 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001408 psa_status_t status;
1409
1410 /* Set the key to empty now, so that even when there are errors, we always
1411 * set data_length to a value between 0 and data_size. On error, setting
1412 * the key to empty is a good choice because an empty key representation is
1413 * unlikely to be accepted anywhere. */
1414 *data_length = 0;
1415
1416 /* Export requires the EXPORT flag. There is an exception for public keys,
1417 * which don't require any flag, but psa_get_key_from_slot takes
1418 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001419 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001420 if( status != PSA_SUCCESS )
1421 return( status );
1422 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001423 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001424}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001425
Gilles Peskinec5487a82018-12-03 18:08:14 +01001426psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001427 uint8_t *data,
1428 size_t data_size,
1429 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001430{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001431 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001432 psa_status_t status;
1433
1434 /* Set the key to empty now, so that even when there are errors, we always
1435 * set data_length to a value between 0 and data_size. On error, setting
1436 * the key to empty is a good choice because an empty key representation is
1437 * unlikely to be accepted anywhere. */
1438 *data_length = 0;
1439
1440 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001441 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001442 if( status != PSA_SUCCESS )
1443 return( status );
1444 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001445 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001446}
1447
Gilles Peskine91e8c332019-08-02 19:19:39 +02001448#if defined(static_assert)
1449static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1450 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001451static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001452 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001453static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001454 "One or more key attribute flag is listed as both internal-only and external-only" );
1455#endif
1456
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001457/** Validate that a key policy is internally well-formed.
1458 *
1459 * This function only rejects invalid policies. It does not validate the
1460 * consistency of the policy with respect to other attributes of the key
1461 * such as the key type.
1462 */
1463static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001464{
1465 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001466 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001467 PSA_KEY_USAGE_ENCRYPT |
1468 PSA_KEY_USAGE_DECRYPT |
1469 PSA_KEY_USAGE_SIGN |
1470 PSA_KEY_USAGE_VERIFY |
1471 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1472 return( PSA_ERROR_INVALID_ARGUMENT );
1473
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 return( PSA_SUCCESS );
1475}
1476
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001477/** Validate the internal consistency of key attributes.
1478 *
1479 * This function only rejects invalid attribute values. If does not
1480 * validate the consistency of the attributes with any key data that may
1481 * be involved in the creation of the key.
1482 *
1483 * Call this function early in the key creation process.
1484 *
1485 * \param[in] attributes Key attributes for the new key.
1486 * \param[out] p_drv On any return, the driver for the key, if any.
1487 * NULL for a transparent key.
1488 *
1489 */
1490static psa_status_t psa_validate_key_attributes(
1491 const psa_key_attributes_t *attributes,
1492 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001493{
1494 psa_status_t status;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001495
Michael Thomas153cd2f2020-01-22 16:54:38 +00001496 if( PSA_KEY_LIFETIME_IS_PERSISTENT (attributes->core.lifetime))
Darryl Green0c6575a2018-11-07 16:05:30 +00001497 {
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001498 status = psa_validate_persistent_key_parameters(
1499 attributes->core.lifetime, attributes->core.id,
1500 p_drv, 1 );
1501 if( status != PSA_SUCCESS )
1502 return( status );
Darryl Green0c6575a2018-11-07 16:05:30 +00001503 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001504
1505 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001506 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001507 return( status );
1508
1509 /* Refuse to create overly large keys.
1510 * Note that this doesn't trigger on import if the attributes don't
1511 * explicitly specify a size (so psa_get_key_bits returns 0), so
1512 * psa_import_key() needs its own checks. */
1513 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1514 return( PSA_ERROR_NOT_SUPPORTED );
1515
Gilles Peskine91e8c332019-08-02 19:19:39 +02001516 /* Reject invalid flags. These should not be reachable through the API. */
1517 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1518 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1519 return( PSA_ERROR_INVALID_ARGUMENT );
1520
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001521 return( PSA_SUCCESS );
1522}
1523
Gilles Peskine4747d192019-04-17 15:05:45 +02001524/** Prepare a key slot to receive key material.
1525 *
1526 * This function allocates a key slot and sets its metadata.
1527 *
1528 * If this function fails, call psa_fail_key_creation().
1529 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001530 * This function is intended to be used as follows:
1531 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1532 * it with the specified attributes, and assign it a handle.
1533 * -# Populate the slot with the key material.
1534 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1535 * In case of failure at any step, stop the sequence and call
1536 * psa_fail_key_creation().
1537 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001538 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001539 * \param[in] attributes Key attributes for the new key.
1540 * \param[out] handle On success, a handle for the allocated slot.
1541 * \param[out] p_slot On success, a pointer to the prepared slot.
1542 * \param[out] p_drv On any return, the driver for the key, if any.
1543 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001544 *
1545 * \retval #PSA_SUCCESS
1546 * The key slot is ready to receive key material.
1547 * \return If this function fails, the key slot is an invalid state.
1548 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001549 */
1550static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001551 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001552 const psa_key_attributes_t *attributes,
1553 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001554 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001555 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001556{
1557 psa_status_t status;
1558 psa_key_slot_t *slot;
1559
Gilles Peskinedf179142019-07-15 22:02:14 +02001560 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001561 *p_drv = NULL;
1562
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001563 status = psa_validate_key_attributes( attributes, p_drv );
1564 if( status != PSA_SUCCESS )
1565 return( status );
1566
Gilles Peskineedbed562019-08-07 18:19:59 +02001567 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001568 if( status != PSA_SUCCESS )
1569 return( status );
1570 slot = *p_slot;
1571
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001572 /* We're storing the declared bit-size of the key. It's up to each
1573 * creation mechanism to verify that this information is correct.
1574 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001575 * an input (generate, device) but not for those where the bit-size
1576 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001577
1578 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001579
Gilles Peskine91e8c332019-08-02 19:19:39 +02001580 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001581 * external-only flags, query `attributes`. Thanks to the check
1582 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001583 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001584 * may have set. */
1585 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001586
Gilles Peskinecbaff462019-07-12 23:46:04 +02001587#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001588 /* For a key in a secure element, we need to do three things
1589 * when creating a key (but not when registering an existing key):
Gilles Peskine60450a42019-07-25 11:32:45 +02001590 * create the key file in internal storage, create the
1591 * key inside the secure element, and update the driver's
1592 * persistent data. Start a transaction that will encompass these
1593 * three actions. */
1594 /* The first thing to do is to find a slot number for the new key.
1595 * We save the slot number in persistent storage as part of the
1596 * transaction data. It will be needed to recover if the power
1597 * fails during the key creation process, to clean up on the secure
1598 * element side after restarting. Obtaining a slot number from the
1599 * secure element driver updates its persistent state, but we do not yet
1600 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001601 * we can roll back to a state where the key doesn't exist. */
Gilles Peskined7729582019-08-05 15:55:54 +02001602 if( *p_drv != NULL && method != PSA_KEY_CREATION_REGISTER )
Darryl Green0c6575a2018-11-07 16:05:30 +00001603 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001604 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001605 &slot->data.se.slot_number );
1606 if( status != PSA_SUCCESS )
1607 return( status );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001608 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001609 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001610 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001611 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine4aea1032019-07-25 17:38:34 +02001612 status = psa_crypto_save_transaction( );
1613 if( status != PSA_SUCCESS )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001614 {
1615 (void) psa_crypto_stop_transaction( );
Gilles Peskine4aea1032019-07-25 17:38:34 +02001616 return( status );
Gilles Peskine66be51c2019-07-25 18:02:52 +02001617 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001618 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001619#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1620
Darryl Green0c6575a2018-11-07 16:05:30 +00001621 return( status );
1622}
Gilles Peskine4747d192019-04-17 15:05:45 +02001623
1624/** Finalize the creation of a key once its key material has been set.
1625 *
1626 * This entails writing the key to persistent storage.
1627 *
1628 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001629 * See the documentation of psa_start_key_creation() for the intended use
1630 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001631 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001632 * \param[in,out] slot Pointer to the slot with key material.
1633 * \param[in] driver The secure element driver for the key,
1634 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001635 *
1636 * \retval #PSA_SUCCESS
1637 * The key was successfully created. The handle is now valid.
1638 * \return If this function fails, the key slot is an invalid state.
1639 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001640 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001641static psa_status_t psa_finish_key_creation(
1642 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001643 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001644{
1645 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001646 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001647 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001648
1649#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001650 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskine4747d192019-04-17 15:05:45 +02001651 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001652#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1653 if( driver != NULL )
1654 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001655 psa_se_key_data_storage_t data;
1656#if defined(static_assert)
1657 static_assert( sizeof( slot->data.se.slot_number ) ==
1658 sizeof( data.slot_number ),
1659 "Slot number size does not match psa_se_key_data_storage_t" );
1660 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1661 "Bit-size size does not match psa_se_key_data_storage_t" );
1662#endif
1663 memcpy( &data.slot_number, &slot->data.se.slot_number,
1664 sizeof( slot->data.se.slot_number ) );
1665 memcpy( &data.bits, &slot->attr.bits,
1666 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001667 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001668 (uint8_t*) &data,
1669 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001670 }
1671 else
1672#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1673 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001674 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001675 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001676 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001677 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1678 size_t length = 0;
Gilles Peskine1df83d42019-07-23 16:13:14 +02001679 if( buffer == NULL && buffer_size != 0 )
1680 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1681 status = psa_internal_export_key( slot,
1682 buffer, buffer_size, &length,
1683 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001684 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001685 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001686 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001687
Gilles Peskine1df83d42019-07-23 16:13:14 +02001688 if( buffer_size != 0 )
1689 mbedtls_platform_zeroize( buffer, buffer_size );
1690 mbedtls_free( buffer );
1691 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001692 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001693#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1694
Gilles Peskinecbaff462019-07-12 23:46:04 +02001695#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001696 /* Finish the transaction for a key creation. This does not
1697 * happen when registering an existing key. Detect this case
1698 * by checking whether a transaction is in progress (actual
1699 * creation of a key in a secure element requires a transaction,
1700 * but registration doesn't use one). */
1701 if( driver != NULL &&
1702 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001703 {
1704 status = psa_save_se_persistent_data( driver );
1705 if( status != PSA_SUCCESS )
1706 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001707 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001708 return( status );
1709 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001710 status = psa_crypto_stop_transaction( );
1711 if( status != PSA_SUCCESS )
1712 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001713 }
1714#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1715
Gilles Peskine4747d192019-04-17 15:05:45 +02001716 return( status );
1717}
1718
1719/** Abort the creation of a key.
1720 *
1721 * You may call this function after calling psa_start_key_creation(),
1722 * or after psa_finish_key_creation() fails. In other circumstances, this
1723 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001724 * See the documentation of psa_start_key_creation() for the intended use
1725 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001727 * \param[in,out] slot Pointer to the slot with key material.
1728 * \param[in] driver The secure element driver for the key,
1729 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001730 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001731static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001732 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001733{
Gilles Peskine011e4282019-06-26 18:34:38 +02001734 (void) driver;
1735
Gilles Peskine4747d192019-04-17 15:05:45 +02001736 if( slot == NULL )
1737 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001738
1739#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001740 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001741 * element, and the failure happened later (when saving metadata
1742 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001743 * element.
1744 * https://github.com/ARMmbed/mbed-crypto/issues/217
1745 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001746
Gilles Peskined7729582019-08-05 15:55:54 +02001747 /* Abort the ongoing transaction if any (there may not be one if
1748 * the creation process failed before starting one, or if the
1749 * key creation is a registration of a key in a secure element).
1750 * Earlier functions must already have done what it takes to undo any
1751 * partial creation. All that's left is to update the transaction data
1752 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001753 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001754#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1755
Gilles Peskine4747d192019-04-17 15:05:45 +02001756 psa_wipe_key_slot( slot );
1757}
1758
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001759/** Validate optional attributes during key creation.
1760 *
1761 * Some key attributes are optional during key creation. If they are
1762 * specified in the attributes structure, check that they are consistent
1763 * with the data in the slot.
1764 *
1765 * This function should be called near the end of key creation, after
1766 * the slot in memory is fully populated but before saving persistent data.
1767 */
1768static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001769 const psa_key_slot_t *slot,
1770 const psa_key_attributes_t *attributes )
1771{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001772 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001773 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001774 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001775 return( PSA_ERROR_INVALID_ARGUMENT );
1776 }
1777
1778 if( attributes->domain_parameters_size != 0 )
1779 {
1780#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001781 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001782 {
1783 mbedtls_mpi actual, required;
1784 int ret;
1785 mbedtls_mpi_init( &actual );
1786 mbedtls_mpi_init( &required );
1787 ret = mbedtls_rsa_export( slot->data.rsa,
1788 NULL, NULL, NULL, NULL, &actual );
1789 if( ret != 0 )
1790 goto rsa_exit;
1791 ret = mbedtls_mpi_read_binary( &required,
1792 attributes->domain_parameters,
1793 attributes->domain_parameters_size );
1794 if( ret != 0 )
1795 goto rsa_exit;
1796 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1797 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1798 rsa_exit:
1799 mbedtls_mpi_free( &actual );
1800 mbedtls_mpi_free( &required );
1801 if( ret != 0)
1802 return( mbedtls_to_psa_error( ret ) );
1803 }
1804 else
1805#endif
1806 {
1807 return( PSA_ERROR_INVALID_ARGUMENT );
1808 }
1809 }
1810
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001811 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001812 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001813 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001814 return( PSA_ERROR_INVALID_ARGUMENT );
1815 }
1816
1817 return( PSA_SUCCESS );
1818}
1819
Gilles Peskine4747d192019-04-17 15:05:45 +02001820psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001822 size_t data_length,
1823 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001824{
1825 psa_status_t status;
1826 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001827 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001828
Gilles Peskinedf179142019-07-15 22:02:14 +02001829 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
1830 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001831 if( status != PSA_SUCCESS )
1832 goto exit;
1833
Gilles Peskine5d309672019-07-12 23:47:28 +02001834#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1835 if( driver != NULL )
1836 {
1837 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001838 /* The driver should set the number of key bits, however in
1839 * case it doesn't, we initialize bits to an invalid value. */
1840 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001841 if( drv->key_management == NULL ||
1842 drv->key_management->p_import == NULL )
1843 {
1844 status = PSA_ERROR_NOT_SUPPORTED;
1845 goto exit;
1846 }
1847 status = drv->key_management->p_import(
1848 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02001849 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001850 &bits );
1851 if( status != PSA_SUCCESS )
1852 goto exit;
1853 if( bits > PSA_MAX_KEY_BITS )
1854 {
1855 status = PSA_ERROR_NOT_SUPPORTED;
1856 goto exit;
1857 }
1858 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001859 }
1860 else
1861#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1862 {
1863 status = psa_import_key_into_slot( slot, data, data_length );
1864 if( status != PSA_SUCCESS )
1865 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001866 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001867 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001868 if( status != PSA_SUCCESS )
1869 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001870
Gilles Peskine011e4282019-06-26 18:34:38 +02001871 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001872exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001873 if( status != PSA_SUCCESS )
1874 {
Gilles Peskine011e4282019-06-26 18:34:38 +02001875 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02001876 *handle = 0;
1877 }
1878 return( status );
1879}
1880
Gilles Peskined7729582019-08-05 15:55:54 +02001881#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1882psa_status_t mbedtls_psa_register_se_key(
1883 const psa_key_attributes_t *attributes )
1884{
1885 psa_status_t status;
1886 psa_key_slot_t *slot = NULL;
1887 psa_se_drv_table_entry_t *driver = NULL;
1888 const psa_drv_se_t *drv;
1889 psa_key_handle_t handle = 0;
1890
1891 /* Leaving attributes unspecified is not currently supported.
1892 * It could make sense to query the key type and size from the
1893 * secure element, but not all secure elements support this
1894 * and the driver HAL doesn't currently support it. */
1895 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1896 return( PSA_ERROR_NOT_SUPPORTED );
1897 if( psa_get_key_bits( attributes ) == 0 )
1898 return( PSA_ERROR_NOT_SUPPORTED );
1899
1900 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
1901 &handle, &slot, &driver );
1902 if( status != PSA_SUCCESS )
1903 goto exit;
1904
1905 if( driver == NULL )
1906 {
1907 status = PSA_ERROR_INVALID_ARGUMENT;
1908 goto exit;
1909 }
1910 drv = psa_get_se_driver_methods( driver );
1911
1912 if ( psa_get_key_slot_number( attributes,
1913 &slot->data.se.slot_number ) != PSA_SUCCESS )
1914 {
1915 /* The application didn't specify a slot number. This doesn't
1916 * make sense when registering a slot. */
1917 status = PSA_ERROR_INVALID_ARGUMENT;
1918 goto exit;
1919 }
1920
Gilles Peskinea5f87492019-08-05 16:46:18 +02001921 /* If the driver has a slot number validation method, call it.
1922 * If it doesn't, it means the secure element is unable to validate
1923 * anything and so we have to trust the application. */
1924 if( drv->key_management != NULL &&
1925 drv->key_management->p_validate_slot_number != NULL )
1926 {
1927 status = drv->key_management->p_validate_slot_number(
1928 psa_get_se_driver_context( driver ),
1929 attributes,
1930 PSA_KEY_CREATION_REGISTER,
1931 slot->data.se.slot_number );
1932 if( status != PSA_SUCCESS )
1933 goto exit;
1934 }
1935
Gilles Peskined7729582019-08-05 15:55:54 +02001936 status = psa_finish_key_creation( slot, driver );
1937
1938exit:
1939 if( status != PSA_SUCCESS )
1940 {
1941 psa_fail_key_creation( slot, driver );
1942 }
1943 /* Registration doesn't keep the key in RAM. */
1944 psa_close_key( handle );
1945 return( status );
1946}
1947#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1948
Gilles Peskinef603c712019-01-19 13:40:11 +01001949static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001950 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001951{
1952 psa_status_t status;
1953 uint8_t *buffer = NULL;
1954 size_t buffer_size = 0;
1955 size_t length;
1956
Gilles Peskine8e338702019-07-30 20:06:31 +02001957 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001958 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01001959 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001960 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001961 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01001962 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1963 if( status != PSA_SUCCESS )
1964 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02001965 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001966 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01001967
1968exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001969 if( buffer_size != 0 )
1970 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001971 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01001972 return( status );
1973}
1974
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001975psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1976 const psa_key_attributes_t *specified_attributes,
1977 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01001978{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001979 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01001980 psa_key_slot_t *source_slot = NULL;
1981 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001982 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001983 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001984
Gilles Peskine28f8f302019-07-24 13:30:31 +02001985 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02001986 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001987 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001988 goto exit;
1989
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001990 status = psa_validate_optional_attributes( source_slot,
1991 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001992 if( status != PSA_SUCCESS )
1993 goto exit;
1994
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001995 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001996 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001997 if( status != PSA_SUCCESS )
1998 goto exit;
1999
Gilles Peskinedf179142019-07-15 22:02:14 +02002000 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2001 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002002 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002003 if( status != PSA_SUCCESS )
2004 goto exit;
2005
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002006#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2007 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002008 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002009 /* Copying to a secure element is not implemented yet. */
2010 status = PSA_ERROR_NOT_SUPPORTED;
2011 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002012 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002013#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002014
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002015 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002016 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002018
Gilles Peskine011e4282019-06-26 18:34:38 +02002019 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002020exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002021 if( status != PSA_SUCCESS )
2022 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002023 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002024 *target_handle = 0;
2025 }
2026 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002027}
2028
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002029
2030
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002031/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002032/* Message digests */
2033/****************************************************************/
2034
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002035static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002036{
2037 switch( alg )
2038 {
2039#if defined(MBEDTLS_MD2_C)
2040 case PSA_ALG_MD2:
2041 return( &mbedtls_md2_info );
2042#endif
2043#if defined(MBEDTLS_MD4_C)
2044 case PSA_ALG_MD4:
2045 return( &mbedtls_md4_info );
2046#endif
2047#if defined(MBEDTLS_MD5_C)
2048 case PSA_ALG_MD5:
2049 return( &mbedtls_md5_info );
2050#endif
2051#if defined(MBEDTLS_RIPEMD160_C)
2052 case PSA_ALG_RIPEMD160:
2053 return( &mbedtls_ripemd160_info );
2054#endif
2055#if defined(MBEDTLS_SHA1_C)
2056 case PSA_ALG_SHA_1:
2057 return( &mbedtls_sha1_info );
2058#endif
2059#if defined(MBEDTLS_SHA256_C)
2060 case PSA_ALG_SHA_224:
2061 return( &mbedtls_sha224_info );
2062 case PSA_ALG_SHA_256:
2063 return( &mbedtls_sha256_info );
2064#endif
2065#if defined(MBEDTLS_SHA512_C)
2066 case PSA_ALG_SHA_384:
2067 return( &mbedtls_sha384_info );
2068 case PSA_ALG_SHA_512:
2069 return( &mbedtls_sha512_info );
2070#endif
2071 default:
2072 return( NULL );
2073 }
2074}
2075
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002076psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2077{
2078 switch( operation->alg )
2079 {
Gilles Peskine81736312018-06-26 15:04:31 +02002080 case 0:
2081 /* The object has (apparently) been initialized but it is not
2082 * in use. It's ok to call abort on such an object, and there's
2083 * nothing to do. */
2084 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002085#if defined(MBEDTLS_MD2_C)
2086 case PSA_ALG_MD2:
2087 mbedtls_md2_free( &operation->ctx.md2 );
2088 break;
2089#endif
2090#if defined(MBEDTLS_MD4_C)
2091 case PSA_ALG_MD4:
2092 mbedtls_md4_free( &operation->ctx.md4 );
2093 break;
2094#endif
2095#if defined(MBEDTLS_MD5_C)
2096 case PSA_ALG_MD5:
2097 mbedtls_md5_free( &operation->ctx.md5 );
2098 break;
2099#endif
2100#if defined(MBEDTLS_RIPEMD160_C)
2101 case PSA_ALG_RIPEMD160:
2102 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2103 break;
2104#endif
2105#if defined(MBEDTLS_SHA1_C)
2106 case PSA_ALG_SHA_1:
2107 mbedtls_sha1_free( &operation->ctx.sha1 );
2108 break;
2109#endif
2110#if defined(MBEDTLS_SHA256_C)
2111 case PSA_ALG_SHA_224:
2112 case PSA_ALG_SHA_256:
2113 mbedtls_sha256_free( &operation->ctx.sha256 );
2114 break;
2115#endif
2116#if defined(MBEDTLS_SHA512_C)
2117 case PSA_ALG_SHA_384:
2118 case PSA_ALG_SHA_512:
2119 mbedtls_sha512_free( &operation->ctx.sha512 );
2120 break;
2121#endif
2122 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002123 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002124 }
2125 operation->alg = 0;
2126 return( PSA_SUCCESS );
2127}
2128
Gilles Peskineda8191d2018-07-08 19:46:38 +02002129psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002130 psa_algorithm_t alg )
2131{
2132 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002133
2134 /* A context must be freshly initialized before it can be set up. */
2135 if( operation->alg != 0 )
2136 {
2137 return( PSA_ERROR_BAD_STATE );
2138 }
2139
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002140 switch( alg )
2141 {
2142#if defined(MBEDTLS_MD2_C)
2143 case PSA_ALG_MD2:
2144 mbedtls_md2_init( &operation->ctx.md2 );
2145 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2146 break;
2147#endif
2148#if defined(MBEDTLS_MD4_C)
2149 case PSA_ALG_MD4:
2150 mbedtls_md4_init( &operation->ctx.md4 );
2151 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2152 break;
2153#endif
2154#if defined(MBEDTLS_MD5_C)
2155 case PSA_ALG_MD5:
2156 mbedtls_md5_init( &operation->ctx.md5 );
2157 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2158 break;
2159#endif
2160#if defined(MBEDTLS_RIPEMD160_C)
2161 case PSA_ALG_RIPEMD160:
2162 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2163 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2164 break;
2165#endif
2166#if defined(MBEDTLS_SHA1_C)
2167 case PSA_ALG_SHA_1:
2168 mbedtls_sha1_init( &operation->ctx.sha1 );
2169 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2170 break;
2171#endif
2172#if defined(MBEDTLS_SHA256_C)
2173 case PSA_ALG_SHA_224:
2174 mbedtls_sha256_init( &operation->ctx.sha256 );
2175 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2176 break;
2177 case PSA_ALG_SHA_256:
2178 mbedtls_sha256_init( &operation->ctx.sha256 );
2179 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2180 break;
2181#endif
2182#if defined(MBEDTLS_SHA512_C)
2183 case PSA_ALG_SHA_384:
2184 mbedtls_sha512_init( &operation->ctx.sha512 );
2185 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2186 break;
2187 case PSA_ALG_SHA_512:
2188 mbedtls_sha512_init( &operation->ctx.sha512 );
2189 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2190 break;
2191#endif
2192 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002193 return( PSA_ALG_IS_HASH( alg ) ?
2194 PSA_ERROR_NOT_SUPPORTED :
2195 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002196 }
2197 if( ret == 0 )
2198 operation->alg = alg;
2199 else
2200 psa_hash_abort( operation );
2201 return( mbedtls_to_psa_error( ret ) );
2202}
2203
2204psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2205 const uint8_t *input,
2206 size_t input_length )
2207{
2208 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02002209
2210 /* Don't require hash implementations to behave correctly on a
2211 * zero-length input, which may have an invalid pointer. */
2212 if( input_length == 0 )
2213 return( PSA_SUCCESS );
2214
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002215 switch( operation->alg )
2216 {
2217#if defined(MBEDTLS_MD2_C)
2218 case PSA_ALG_MD2:
2219 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2220 input, input_length );
2221 break;
2222#endif
2223#if defined(MBEDTLS_MD4_C)
2224 case PSA_ALG_MD4:
2225 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2226 input, input_length );
2227 break;
2228#endif
2229#if defined(MBEDTLS_MD5_C)
2230 case PSA_ALG_MD5:
2231 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2232 input, input_length );
2233 break;
2234#endif
2235#if defined(MBEDTLS_RIPEMD160_C)
2236 case PSA_ALG_RIPEMD160:
2237 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2238 input, input_length );
2239 break;
2240#endif
2241#if defined(MBEDTLS_SHA1_C)
2242 case PSA_ALG_SHA_1:
2243 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2244 input, input_length );
2245 break;
2246#endif
2247#if defined(MBEDTLS_SHA256_C)
2248 case PSA_ALG_SHA_224:
2249 case PSA_ALG_SHA_256:
2250 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2251 input, input_length );
2252 break;
2253#endif
2254#if defined(MBEDTLS_SHA512_C)
2255 case PSA_ALG_SHA_384:
2256 case PSA_ALG_SHA_512:
2257 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2258 input, input_length );
2259 break;
2260#endif
2261 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002262 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002263 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002264
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265 if( ret != 0 )
2266 psa_hash_abort( operation );
2267 return( mbedtls_to_psa_error( ret ) );
2268}
2269
2270psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2271 uint8_t *hash,
2272 size_t hash_size,
2273 size_t *hash_length )
2274{
itayzafrir40835d42018-08-02 13:14:17 +03002275 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002276 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002277 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278
2279 /* Fill the output buffer with something that isn't a valid hash
2280 * (barring an attack on the hash and deliberately-crafted input),
2281 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002282 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002283 /* If hash_size is 0 then hash may be NULL and then the
2284 * call to memset would have undefined behavior. */
2285 if( hash_size != 0 )
2286 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002287
2288 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002289 {
2290 status = PSA_ERROR_BUFFER_TOO_SMALL;
2291 goto exit;
2292 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002293
2294 switch( operation->alg )
2295 {
2296#if defined(MBEDTLS_MD2_C)
2297 case PSA_ALG_MD2:
2298 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2299 break;
2300#endif
2301#if defined(MBEDTLS_MD4_C)
2302 case PSA_ALG_MD4:
2303 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2304 break;
2305#endif
2306#if defined(MBEDTLS_MD5_C)
2307 case PSA_ALG_MD5:
2308 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2309 break;
2310#endif
2311#if defined(MBEDTLS_RIPEMD160_C)
2312 case PSA_ALG_RIPEMD160:
2313 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2314 break;
2315#endif
2316#if defined(MBEDTLS_SHA1_C)
2317 case PSA_ALG_SHA_1:
2318 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2319 break;
2320#endif
2321#if defined(MBEDTLS_SHA256_C)
2322 case PSA_ALG_SHA_224:
2323 case PSA_ALG_SHA_256:
2324 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2325 break;
2326#endif
2327#if defined(MBEDTLS_SHA512_C)
2328 case PSA_ALG_SHA_384:
2329 case PSA_ALG_SHA_512:
2330 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2331 break;
2332#endif
2333 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002334 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002335 }
itayzafrir40835d42018-08-02 13:14:17 +03002336 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337
itayzafrir40835d42018-08-02 13:14:17 +03002338exit:
2339 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002340 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002341 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002342 return( psa_hash_abort( operation ) );
2343 }
2344 else
2345 {
2346 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002347 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002348 }
2349}
2350
Gilles Peskine2d277862018-06-18 15:41:12 +02002351psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2352 const uint8_t *hash,
2353 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002354{
2355 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2356 size_t actual_hash_length;
2357 psa_status_t status = psa_hash_finish( operation,
2358 actual_hash, sizeof( actual_hash ),
2359 &actual_hash_length );
2360 if( status != PSA_SUCCESS )
2361 return( status );
2362 if( actual_hash_length != hash_length )
2363 return( PSA_ERROR_INVALID_SIGNATURE );
2364 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2365 return( PSA_ERROR_INVALID_SIGNATURE );
2366 return( PSA_SUCCESS );
2367}
2368
Gilles Peskineeb35d782019-01-22 17:56:16 +01002369psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2370 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002371{
2372 if( target_operation->alg != 0 )
2373 return( PSA_ERROR_BAD_STATE );
2374
2375 switch( source_operation->alg )
2376 {
2377 case 0:
2378 return( PSA_ERROR_BAD_STATE );
2379#if defined(MBEDTLS_MD2_C)
2380 case PSA_ALG_MD2:
2381 mbedtls_md2_clone( &target_operation->ctx.md2,
2382 &source_operation->ctx.md2 );
2383 break;
2384#endif
2385#if defined(MBEDTLS_MD4_C)
2386 case PSA_ALG_MD4:
2387 mbedtls_md4_clone( &target_operation->ctx.md4,
2388 &source_operation->ctx.md4 );
2389 break;
2390#endif
2391#if defined(MBEDTLS_MD5_C)
2392 case PSA_ALG_MD5:
2393 mbedtls_md5_clone( &target_operation->ctx.md5,
2394 &source_operation->ctx.md5 );
2395 break;
2396#endif
2397#if defined(MBEDTLS_RIPEMD160_C)
2398 case PSA_ALG_RIPEMD160:
2399 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2400 &source_operation->ctx.ripemd160 );
2401 break;
2402#endif
2403#if defined(MBEDTLS_SHA1_C)
2404 case PSA_ALG_SHA_1:
2405 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2406 &source_operation->ctx.sha1 );
2407 break;
2408#endif
2409#if defined(MBEDTLS_SHA256_C)
2410 case PSA_ALG_SHA_224:
2411 case PSA_ALG_SHA_256:
2412 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2413 &source_operation->ctx.sha256 );
2414 break;
2415#endif
2416#if defined(MBEDTLS_SHA512_C)
2417 case PSA_ALG_SHA_384:
2418 case PSA_ALG_SHA_512:
2419 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2420 &source_operation->ctx.sha512 );
2421 break;
2422#endif
2423 default:
2424 return( PSA_ERROR_NOT_SUPPORTED );
2425 }
2426
2427 target_operation->alg = source_operation->alg;
2428 return( PSA_SUCCESS );
2429}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002430/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431/* MAC */
2432/****************************************************************/
2433
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002434static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002435 psa_algorithm_t alg,
2436 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002437 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002438 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002439{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002440 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002441 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002442
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002443 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002444 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002445
Gilles Peskine8c9def32018-02-08 10:02:12 +01002446 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2447 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002448 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002449 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002450 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002451 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002452 mode = MBEDTLS_MODE_STREAM;
2453 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002454 case PSA_ALG_CTR:
2455 mode = MBEDTLS_MODE_CTR;
2456 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002457 case PSA_ALG_CFB:
2458 mode = MBEDTLS_MODE_CFB;
2459 break;
2460 case PSA_ALG_OFB:
2461 mode = MBEDTLS_MODE_OFB;
2462 break;
2463 case PSA_ALG_CBC_NO_PADDING:
2464 mode = MBEDTLS_MODE_CBC;
2465 break;
2466 case PSA_ALG_CBC_PKCS7:
2467 mode = MBEDTLS_MODE_CBC;
2468 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002469 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002470 mode = MBEDTLS_MODE_CCM;
2471 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002472 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002473 mode = MBEDTLS_MODE_GCM;
2474 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002475 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2476 mode = MBEDTLS_MODE_CHACHAPOLY;
2477 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478 default:
2479 return( NULL );
2480 }
2481 }
2482 else if( alg == PSA_ALG_CMAC )
2483 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484 else
2485 return( NULL );
2486
2487 switch( key_type )
2488 {
2489 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002490 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002491 break;
2492 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002493 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2494 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002495 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002496 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002497 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002498 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002499 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2500 * but two-key Triple-DES is functionally three-key Triple-DES
2501 * with K1=K3, so that's how we present it to mbedtls. */
2502 if( key_bits == 128 )
2503 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002504 break;
2505 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002506 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002507 break;
2508 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002509 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002510 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002511 case PSA_KEY_TYPE_CHACHA20:
2512 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2513 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002514 default:
2515 return( NULL );
2516 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002517 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002518 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002519
Jaeden Amero23bbb752018-06-26 14:16:54 +01002520 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2521 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522}
2523
Gilles Peskinea05219c2018-11-16 16:02:56 +01002524#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002525static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002526{
Gilles Peskine2d277862018-06-18 15:41:12 +02002527 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002528 {
2529 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002530 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002531 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002532 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002533 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002534 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002535 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002536 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002537 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002538 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002539 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002540 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002541 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002542 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002543 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002544 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002545 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002546 return( 128 );
2547 default:
2548 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002549 }
2550}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002551#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002552
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002553/* Initialize the MAC operation structure. Once this function has been
2554 * called, psa_mac_abort can run and will do the right thing. */
2555static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2556 psa_algorithm_t alg )
2557{
2558 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2559
2560 operation->alg = alg;
2561 operation->key_set = 0;
2562 operation->iv_set = 0;
2563 operation->iv_required = 0;
2564 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002565 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002566
2567#if defined(MBEDTLS_CMAC_C)
2568 if( alg == PSA_ALG_CMAC )
2569 {
2570 operation->iv_required = 0;
2571 mbedtls_cipher_init( &operation->ctx.cmac );
2572 status = PSA_SUCCESS;
2573 }
2574 else
2575#endif /* MBEDTLS_CMAC_C */
2576#if defined(MBEDTLS_MD_C)
2577 if( PSA_ALG_IS_HMAC( operation->alg ) )
2578 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002579 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2580 operation->ctx.hmac.hash_ctx.alg = 0;
2581 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002582 }
2583 else
2584#endif /* MBEDTLS_MD_C */
2585 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002586 if( ! PSA_ALG_IS_MAC( alg ) )
2587 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002588 }
2589
2590 if( status != PSA_SUCCESS )
2591 memset( operation, 0, sizeof( *operation ) );
2592 return( status );
2593}
2594
Gilles Peskine01126fa2018-07-12 17:04:55 +02002595#if defined(MBEDTLS_MD_C)
2596static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2597{
Gilles Peskine3f108122018-12-07 18:14:53 +01002598 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002599 return( psa_hash_abort( &hmac->hash_ctx ) );
2600}
2601#endif /* MBEDTLS_MD_C */
2602
Gilles Peskine8c9def32018-02-08 10:02:12 +01002603psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2604{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002605 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002606 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002607 /* The object has (apparently) been initialized but it is not
2608 * in use. It's ok to call abort on such an object, and there's
2609 * nothing to do. */
2610 return( PSA_SUCCESS );
2611 }
2612 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002613#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002614 if( operation->alg == PSA_ALG_CMAC )
2615 {
2616 mbedtls_cipher_free( &operation->ctx.cmac );
2617 }
2618 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002619#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002620#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002621 if( PSA_ALG_IS_HMAC( operation->alg ) )
2622 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002623 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002624 }
2625 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002626#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002627 {
2628 /* Sanity check (shouldn't happen: operation->alg should
2629 * always have been initialized to a valid value). */
2630 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002631 }
Moran Peker41deec42018-04-04 15:43:05 +03002632
Gilles Peskine8c9def32018-02-08 10:02:12 +01002633 operation->alg = 0;
2634 operation->key_set = 0;
2635 operation->iv_set = 0;
2636 operation->iv_required = 0;
2637 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002638 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002639
Gilles Peskine8c9def32018-02-08 10:02:12 +01002640 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002641
2642bad_state:
2643 /* If abort is called on an uninitialized object, we can't trust
2644 * anything. Wipe the object in case it contains confidential data.
2645 * This may result in a memory leak if a pointer gets overwritten,
2646 * but it's too late to do anything about this. */
2647 memset( operation, 0, sizeof( *operation ) );
2648 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002649}
2650
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002651#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002652static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002653 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002654 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002655 const mbedtls_cipher_info_t *cipher_info )
2656{
2657 int ret;
2658
2659 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002660
2661 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2662 if( ret != 0 )
2663 return( ret );
2664
2665 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2666 slot->data.raw.data,
2667 key_bits );
2668 return( ret );
2669}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002670#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002671
Gilles Peskine248051a2018-06-20 16:09:38 +02002672#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002673static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2674 const uint8_t *key,
2675 size_t key_length,
2676 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002677{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002678 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002679 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002680 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002681 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002682 psa_status_t status;
2683
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002684 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2685 * overflow below. This should never trigger if the hash algorithm
2686 * is implemented correctly. */
2687 /* The size checks against the ipad and opad buffers cannot be written
2688 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2689 * because that triggers -Wlogical-op on GCC 7.3. */
2690 if( block_size > sizeof( ipad ) )
2691 return( PSA_ERROR_NOT_SUPPORTED );
2692 if( block_size > sizeof( hmac->opad ) )
2693 return( PSA_ERROR_NOT_SUPPORTED );
2694 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002695 return( PSA_ERROR_NOT_SUPPORTED );
2696
Gilles Peskined223b522018-06-11 18:12:58 +02002697 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002698 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002699 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002700 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002701 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002702 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002703 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002704 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002705 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002706 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002707 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002708 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002709 }
Gilles Peskine96889972018-07-12 17:07:03 +02002710 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2711 * but it is permitted. It is common when HMAC is used in HKDF, for
2712 * example. Don't call `memcpy` in the 0-length because `key` could be
2713 * an invalid pointer which would make the behavior undefined. */
2714 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002715 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002716
Gilles Peskined223b522018-06-11 18:12:58 +02002717 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2718 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002719 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002720 ipad[i] ^= 0x36;
2721 memset( ipad + key_length, 0x36, block_size - key_length );
2722
2723 /* Copy the key material from ipad to opad, flipping the requisite bits,
2724 * and filling the rest of opad with the requisite constant. */
2725 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002726 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2727 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002728
Gilles Peskine01126fa2018-07-12 17:04:55 +02002729 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002730 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002731 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002732
Gilles Peskine01126fa2018-07-12 17:04:55 +02002733 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002734
2735cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002736 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002737
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002738 return( status );
2739}
Gilles Peskine248051a2018-06-20 16:09:38 +02002740#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002741
Gilles Peskine89167cb2018-07-08 20:12:23 +02002742static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002743 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002744 psa_algorithm_t alg,
2745 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002746{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002747 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002748 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002749 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002750 psa_key_usage_t usage =
2751 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002752 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002753 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002754
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002755 /* A context must be freshly initialized before it can be set up. */
2756 if( operation->alg != 0 )
2757 {
2758 return( PSA_ERROR_BAD_STATE );
2759 }
2760
Gilles Peskined911eb72018-08-14 15:18:45 +02002761 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002762 if( status != PSA_SUCCESS )
2763 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002764 if( is_sign )
2765 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002766
Gilles Peskine28f8f302019-07-24 13:30:31 +02002767 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002768 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002769 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002770 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002771
Gilles Peskine8c9def32018-02-08 10:02:12 +01002772#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002773 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002774 {
2775 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002776 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002777 slot->attr.type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002778 int ret;
2779 if( cipher_info == NULL )
2780 {
2781 status = PSA_ERROR_NOT_SUPPORTED;
2782 goto exit;
2783 }
2784 operation->mac_size = cipher_info->block_size;
2785 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2786 status = mbedtls_to_psa_error( ret );
2787 }
2788 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002789#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002790#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002791 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002792 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002793 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002794 if( hash_alg == 0 )
2795 {
2796 status = PSA_ERROR_NOT_SUPPORTED;
2797 goto exit;
2798 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002799
2800 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2801 /* Sanity check. This shouldn't fail on a valid configuration. */
2802 if( operation->mac_size == 0 ||
2803 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2804 {
2805 status = PSA_ERROR_NOT_SUPPORTED;
2806 goto exit;
2807 }
2808
Gilles Peskine8e338702019-07-30 20:06:31 +02002809 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002810 {
2811 status = PSA_ERROR_INVALID_ARGUMENT;
2812 goto exit;
2813 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002814
Gilles Peskine01126fa2018-07-12 17:04:55 +02002815 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2816 slot->data.raw.data,
2817 slot->data.raw.bytes,
2818 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002819 }
2820 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002821#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002822 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002823 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002824 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002825 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002826
Gilles Peskined911eb72018-08-14 15:18:45 +02002827 if( truncated == 0 )
2828 {
2829 /* The "normal" case: untruncated algorithm. Nothing to do. */
2830 }
2831 else if( truncated < 4 )
2832 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002833 /* A very short MAC is too short for security since it can be
2834 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2835 * so we make this our minimum, even though 32 bits is still
2836 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002837 status = PSA_ERROR_NOT_SUPPORTED;
2838 }
2839 else if( truncated > operation->mac_size )
2840 {
2841 /* It's impossible to "truncate" to a larger length. */
2842 status = PSA_ERROR_INVALID_ARGUMENT;
2843 }
2844 else
2845 operation->mac_size = truncated;
2846
Gilles Peskinefbfac682018-07-08 20:51:54 +02002847exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002848 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002849 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002850 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002851 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002852 else
2853 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002854 operation->key_set = 1;
2855 }
2856 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002857}
2858
Gilles Peskine89167cb2018-07-08 20:12:23 +02002859psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002860 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002861 psa_algorithm_t alg )
2862{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002863 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002864}
2865
2866psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002867 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002868 psa_algorithm_t alg )
2869{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002870 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002871}
2872
Gilles Peskine8c9def32018-02-08 10:02:12 +01002873psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2874 const uint8_t *input,
2875 size_t input_length )
2876{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002877 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002878 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002879 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002880 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002881 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002882 operation->has_input = 1;
2883
Gilles Peskine8c9def32018-02-08 10:02:12 +01002884#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002885 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002886 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002887 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2888 input, input_length );
2889 status = mbedtls_to_psa_error( ret );
2890 }
2891 else
2892#endif /* MBEDTLS_CMAC_C */
2893#if defined(MBEDTLS_MD_C)
2894 if( PSA_ALG_IS_HMAC( operation->alg ) )
2895 {
2896 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2897 input_length );
2898 }
2899 else
2900#endif /* MBEDTLS_MD_C */
2901 {
2902 /* This shouldn't happen if `operation` was initialized by
2903 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002904 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002905 }
2906
Gilles Peskinefbfac682018-07-08 20:51:54 +02002907 if( status != PSA_SUCCESS )
2908 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002909 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002910}
2911
Gilles Peskine01126fa2018-07-12 17:04:55 +02002912#if defined(MBEDTLS_MD_C)
2913static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2914 uint8_t *mac,
2915 size_t mac_size )
2916{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002917 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002918 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2919 size_t hash_size = 0;
2920 size_t block_size = psa_get_hash_block_size( hash_alg );
2921 psa_status_t status;
2922
Gilles Peskine01126fa2018-07-12 17:04:55 +02002923 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2924 if( status != PSA_SUCCESS )
2925 return( status );
2926 /* From here on, tmp needs to be wiped. */
2927
2928 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2929 if( status != PSA_SUCCESS )
2930 goto exit;
2931
2932 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2933 if( status != PSA_SUCCESS )
2934 goto exit;
2935
2936 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2937 if( status != PSA_SUCCESS )
2938 goto exit;
2939
Gilles Peskined911eb72018-08-14 15:18:45 +02002940 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2941 if( status != PSA_SUCCESS )
2942 goto exit;
2943
2944 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002945
2946exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002947 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002948 return( status );
2949}
2950#endif /* MBEDTLS_MD_C */
2951
mohammad16036df908f2018-04-02 08:34:15 -07002952static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002953 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002954 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002955{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002956 if( ! operation->key_set )
2957 return( PSA_ERROR_BAD_STATE );
2958 if( operation->iv_required && ! operation->iv_set )
2959 return( PSA_ERROR_BAD_STATE );
2960
Gilles Peskine8c9def32018-02-08 10:02:12 +01002961 if( mac_size < operation->mac_size )
2962 return( PSA_ERROR_BUFFER_TOO_SMALL );
2963
Gilles Peskine8c9def32018-02-08 10:02:12 +01002964#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002965 if( operation->alg == PSA_ALG_CMAC )
2966 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002967 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2968 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2969 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002970 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002971 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002972 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002973 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002974 else
2975#endif /* MBEDTLS_CMAC_C */
2976#if defined(MBEDTLS_MD_C)
2977 if( PSA_ALG_IS_HMAC( operation->alg ) )
2978 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002979 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002980 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002981 }
2982 else
2983#endif /* MBEDTLS_MD_C */
2984 {
2985 /* This shouldn't happen if `operation` was initialized by
2986 * a setup function. */
2987 return( PSA_ERROR_BAD_STATE );
2988 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002989}
2990
Gilles Peskineacd4be32018-07-08 19:56:25 +02002991psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2992 uint8_t *mac,
2993 size_t mac_size,
2994 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002995{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002996 psa_status_t status;
2997
Jaeden Amero252ef282019-02-15 14:05:35 +00002998 if( operation->alg == 0 )
2999 {
3000 return( PSA_ERROR_BAD_STATE );
3001 }
3002
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003003 /* Fill the output buffer with something that isn't a valid mac
3004 * (barring an attack on the mac and deliberately-crafted input),
3005 * in case the caller doesn't check the return status properly. */
3006 *mac_length = mac_size;
3007 /* If mac_size is 0 then mac may be NULL and then the
3008 * call to memset would have undefined behavior. */
3009 if( mac_size != 0 )
3010 memset( mac, '!', mac_size );
3011
Gilles Peskine89167cb2018-07-08 20:12:23 +02003012 if( ! operation->is_sign )
3013 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003014 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003015 }
mohammad16036df908f2018-04-02 08:34:15 -07003016
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003017 status = psa_mac_finish_internal( operation, mac, mac_size );
3018
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003019 if( status == PSA_SUCCESS )
3020 {
3021 status = psa_mac_abort( operation );
3022 if( status == PSA_SUCCESS )
3023 *mac_length = operation->mac_size;
3024 else
3025 memset( mac, '!', mac_size );
3026 }
3027 else
3028 psa_mac_abort( operation );
3029 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003030}
3031
Gilles Peskineacd4be32018-07-08 19:56:25 +02003032psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3033 const uint8_t *mac,
3034 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003035{
Gilles Peskine828ed142018-06-18 23:25:51 +02003036 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003037 psa_status_t status;
3038
Jaeden Amero252ef282019-02-15 14:05:35 +00003039 if( operation->alg == 0 )
3040 {
3041 return( PSA_ERROR_BAD_STATE );
3042 }
3043
Gilles Peskine89167cb2018-07-08 20:12:23 +02003044 if( operation->is_sign )
3045 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003046 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003047 }
3048 if( operation->mac_size != mac_length )
3049 {
3050 status = PSA_ERROR_INVALID_SIGNATURE;
3051 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003052 }
mohammad16036df908f2018-04-02 08:34:15 -07003053
3054 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003055 actual_mac, sizeof( actual_mac ) );
3056
3057 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3058 status = PSA_ERROR_INVALID_SIGNATURE;
3059
3060cleanup:
3061 if( status == PSA_SUCCESS )
3062 status = psa_mac_abort( operation );
3063 else
3064 psa_mac_abort( operation );
3065
Gilles Peskine3f108122018-12-07 18:14:53 +01003066 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003067
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003068 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003069}
3070
3071
Gilles Peskine20035e32018-02-03 22:44:14 +01003072
Gilles Peskine20035e32018-02-03 22:44:14 +01003073/****************************************************************/
3074/* Asymmetric cryptography */
3075/****************************************************************/
3076
Gilles Peskine2b450e32018-06-27 15:42:46 +02003077#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003078/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003079 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003080static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3081 size_t hash_length,
3082 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003083{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003084 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003085 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003086 *md_alg = mbedtls_md_get_type( md_info );
3087
3088 /* The Mbed TLS RSA module uses an unsigned int for hash length
3089 * parameters. Validate that it fits so that we don't risk an
3090 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003091#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003092 if( hash_length > UINT_MAX )
3093 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003094#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003095
3096#if defined(MBEDTLS_PKCS1_V15)
3097 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3098 * must be correct. */
3099 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3100 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003101 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003102 if( md_info == NULL )
3103 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003104 if( mbedtls_md_get_size( md_info ) != hash_length )
3105 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003106 }
3107#endif /* MBEDTLS_PKCS1_V15 */
3108
3109#if defined(MBEDTLS_PKCS1_V21)
3110 /* PSS requires a hash internally. */
3111 if( PSA_ALG_IS_RSA_PSS( alg ) )
3112 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003113 if( md_info == NULL )
3114 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003115 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003116#endif /* MBEDTLS_PKCS1_V21 */
3117
Gilles Peskine61b91d42018-06-08 16:09:36 +02003118 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003119}
3120
Gilles Peskine2b450e32018-06-27 15:42:46 +02003121static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3122 psa_algorithm_t alg,
3123 const uint8_t *hash,
3124 size_t hash_length,
3125 uint8_t *signature,
3126 size_t signature_size,
3127 size_t *signature_length )
3128{
3129 psa_status_t status;
3130 int ret;
3131 mbedtls_md_type_t md_alg;
3132
3133 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3134 if( status != PSA_SUCCESS )
3135 return( status );
3136
Gilles Peskine630a18a2018-06-29 17:49:35 +02003137 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003138 return( PSA_ERROR_BUFFER_TOO_SMALL );
3139
3140#if defined(MBEDTLS_PKCS1_V15)
3141 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3142 {
3143 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3144 MBEDTLS_MD_NONE );
3145 ret = mbedtls_rsa_pkcs1_sign( rsa,
3146 mbedtls_ctr_drbg_random,
3147 &global_data.ctr_drbg,
3148 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003149 md_alg,
3150 (unsigned int) hash_length,
3151 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003152 signature );
3153 }
3154 else
3155#endif /* MBEDTLS_PKCS1_V15 */
3156#if defined(MBEDTLS_PKCS1_V21)
3157 if( PSA_ALG_IS_RSA_PSS( alg ) )
3158 {
3159 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3160 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3161 mbedtls_ctr_drbg_random,
3162 &global_data.ctr_drbg,
3163 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003164 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003165 (unsigned int) hash_length,
3166 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003167 signature );
3168 }
3169 else
3170#endif /* MBEDTLS_PKCS1_V21 */
3171 {
3172 return( PSA_ERROR_INVALID_ARGUMENT );
3173 }
3174
3175 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003176 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003177 return( mbedtls_to_psa_error( ret ) );
3178}
3179
3180static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3181 psa_algorithm_t alg,
3182 const uint8_t *hash,
3183 size_t hash_length,
3184 const uint8_t *signature,
3185 size_t signature_length )
3186{
3187 psa_status_t status;
3188 int ret;
3189 mbedtls_md_type_t md_alg;
3190
3191 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3192 if( status != PSA_SUCCESS )
3193 return( status );
3194
Gilles Peskine630a18a2018-06-29 17:49:35 +02003195 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003196 return( PSA_ERROR_BUFFER_TOO_SMALL );
3197
3198#if defined(MBEDTLS_PKCS1_V15)
3199 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3200 {
3201 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3202 MBEDTLS_MD_NONE );
3203 ret = mbedtls_rsa_pkcs1_verify( rsa,
3204 mbedtls_ctr_drbg_random,
3205 &global_data.ctr_drbg,
3206 MBEDTLS_RSA_PUBLIC,
3207 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003208 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003209 hash,
3210 signature );
3211 }
3212 else
3213#endif /* MBEDTLS_PKCS1_V15 */
3214#if defined(MBEDTLS_PKCS1_V21)
3215 if( PSA_ALG_IS_RSA_PSS( alg ) )
3216 {
3217 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3218 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3219 mbedtls_ctr_drbg_random,
3220 &global_data.ctr_drbg,
3221 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003222 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003223 (unsigned int) hash_length,
3224 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003225 signature );
3226 }
3227 else
3228#endif /* MBEDTLS_PKCS1_V21 */
3229 {
3230 return( PSA_ERROR_INVALID_ARGUMENT );
3231 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003232
3233 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3234 * the rest of the signature is invalid". This has little use in
3235 * practice and PSA doesn't report this distinction. */
3236 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3237 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003238 return( mbedtls_to_psa_error( ret ) );
3239}
3240#endif /* MBEDTLS_RSA_C */
3241
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003242#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003243/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3244 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3245 * (even though these functions don't modify it). */
3246static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3247 psa_algorithm_t alg,
3248 const uint8_t *hash,
3249 size_t hash_length,
3250 uint8_t *signature,
3251 size_t signature_size,
3252 size_t *signature_length )
3253{
3254 int ret;
3255 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003256 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003257 mbedtls_mpi_init( &r );
3258 mbedtls_mpi_init( &s );
3259
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003260 if( signature_size < 2 * curve_bytes )
3261 {
3262 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3263 goto cleanup;
3264 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003265
Gilles Peskinea05219c2018-11-16 16:02:56 +01003266#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003267 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3268 {
3269 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3270 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3271 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003272 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3273 &ecp->d, hash,
3274 hash_length, md_alg,
3275 mbedtls_ctr_drbg_random,
3276 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003277 }
3278 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003279#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003280 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003281 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003282 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3283 hash, hash_length,
3284 mbedtls_ctr_drbg_random,
3285 &global_data.ctr_drbg ) );
3286 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003287
3288 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3289 signature,
3290 curve_bytes ) );
3291 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3292 signature + curve_bytes,
3293 curve_bytes ) );
3294
3295cleanup:
3296 mbedtls_mpi_free( &r );
3297 mbedtls_mpi_free( &s );
3298 if( ret == 0 )
3299 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003300 return( mbedtls_to_psa_error( ret ) );
3301}
3302
3303static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3304 const uint8_t *hash,
3305 size_t hash_length,
3306 const uint8_t *signature,
3307 size_t signature_length )
3308{
3309 int ret;
3310 mbedtls_mpi r, s;
3311 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3312 mbedtls_mpi_init( &r );
3313 mbedtls_mpi_init( &s );
3314
3315 if( signature_length != 2 * curve_bytes )
3316 return( PSA_ERROR_INVALID_SIGNATURE );
3317
3318 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3319 signature,
3320 curve_bytes ) );
3321 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3322 signature + curve_bytes,
3323 curve_bytes ) );
3324
3325 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3326 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003327
3328cleanup:
3329 mbedtls_mpi_free( &r );
3330 mbedtls_mpi_free( &s );
3331 return( mbedtls_to_psa_error( ret ) );
3332}
3333#endif /* MBEDTLS_ECDSA_C */
3334
Michael Thomasff0e8b92020-01-21 15:01:10 +00003335// The weakly linked function "psa_asymmetric_sign_vendor_weak" which returns "PSA_ERROR_NOT_SUPPORTED" will be linked if
3336// the vendor does not provide a definition for "psa_asymmetric_sign_vendor"
Michael Thomas153cd2f2020-01-22 16:54:38 +00003337psa_status_t psa_asymmetric_sign_vendor( psa_key_slot_t * slot,
Michael Thomasff0e8b92020-01-21 15:01:10 +00003338 psa_algorithm_t alg,
3339 const uint8_t *hash,
3340 size_t hash_length,
3341 uint8_t *signature,
3342 size_t signature_size,
3343 size_t *signature_length ) __attribute__ ((weak, alias("psa_asymmetric_sign_vendor_weak")));
Michael Thomas153cd2f2020-01-22 16:54:38 +00003344psa_status_t psa_asymmetric_sign_vendor_weak( psa_key_slot_t * slot,
Michael Thomasff0e8b92020-01-21 15:01:10 +00003345 psa_algorithm_t alg,
3346 const uint8_t *hash,
3347 size_t hash_length,
3348 uint8_t *signature,
3349 size_t signature_size,
3350 size_t *signature_length );
Michael Thomas153cd2f2020-01-22 16:54:38 +00003351psa_status_t psa_asymmetric_sign_vendor_weak( psa_key_slot_t * slot,
Michael Thomasff0e8b92020-01-21 15:01:10 +00003352 psa_algorithm_t alg,
3353 const uint8_t *hash,
3354 size_t hash_length,
3355 uint8_t *signature,
3356 size_t signature_size,
3357 size_t *signature_length )
3358{
Michael Thomas153cd2f2020-01-22 16:54:38 +00003359 (void) slot ;
Michael Thomasff0e8b92020-01-21 15:01:10 +00003360 (void) alg;
3361 (void)hash;
3362 (void)hash_length;
3363 (void)signature;
3364 (void)signature_size;
3365 (void)signature_length;
3366
3367
3368 return PSA_ERROR_NOT_SUPPORTED;
3369}
Gilles Peskinec5487a82018-12-03 18:08:14 +01003370psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003371 psa_algorithm_t alg,
3372 const uint8_t *hash,
3373 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003374 uint8_t *signature,
3375 size_t signature_size,
3376 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003377{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003378 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003379 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003380#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3381 const psa_drv_se_t *drv;
3382 psa_drv_se_context_t *drv_context;
3383#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003384
3385 *signature_length = signature_size;
3386
Gilles Peskineedc64242019-08-07 21:05:07 +02003387 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003388 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003389 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003390 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003391 {
3392 status = PSA_ERROR_INVALID_ARGUMENT;
3393 goto exit;
3394 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003395
Gilles Peskineedc64242019-08-07 21:05:07 +02003396#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3397 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3398 {
3399 if( drv->asymmetric == NULL ||
3400 drv->asymmetric->p_sign == NULL )
3401 {
3402 status = PSA_ERROR_NOT_SUPPORTED;
3403 goto exit;
3404 }
3405 status = drv->asymmetric->p_sign( drv_context,
3406 slot->data.se.slot_number,
3407 alg,
3408 hash, hash_length,
3409 signature, signature_size,
3410 signature_length );
3411 }
3412 else
3413#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Michael Thomas153cd2f2020-01-22 16:54:38 +00003414 if (PSA_KEY_LIFETIME_IS_VENDOR_DEFINED(slot->attr.lifetime))
Michael Thomasff0e8b92020-01-21 15:01:10 +00003415 {
Michael Thomas153cd2f2020-01-22 16:54:38 +00003416 status = psa_asymmetric_sign_vendor(slot,alg,
Michael Thomasecb72842020-01-22 23:24:41 +00003417 hash, hash_length,
3418 signature, signature_size,
3419 signature_length );
Michael Thomasff0e8b92020-01-21 15:01:10 +00003420 }
3421 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003422#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003423 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003424 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003425 status = psa_rsa_sign( slot->data.rsa,
3426 alg,
3427 hash, hash_length,
3428 signature, signature_size,
3429 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01003430 }
3431 else
3432#endif /* defined(MBEDTLS_RSA_C) */
3433#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003434 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003435 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003436#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003437 if(
3438#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3439 PSA_ALG_IS_ECDSA( alg )
3440#else
3441 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3442#endif
3443 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003444 status = psa_ecdsa_sign( slot->data.ecp,
3445 alg,
3446 hash, hash_length,
3447 signature, signature_size,
3448 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003449 else
3450#endif /* defined(MBEDTLS_ECDSA_C) */
3451 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003452 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003453 }
itayzafrir5c753392018-05-08 11:18:38 +03003454 }
3455 else
3456#endif /* defined(MBEDTLS_ECP_C) */
3457 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003458 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003459 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003460
3461exit:
3462 /* Fill the unused part of the output buffer (the whole buffer on error,
3463 * the trailing part on success) with something that isn't a valid mac
3464 * (barring an attack on the mac and deliberately-crafted input),
3465 * in case the caller doesn't check the return status properly. */
3466 if( status == PSA_SUCCESS )
3467 memset( signature + *signature_length, '!',
3468 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003469 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003470 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003471 /* If signature_size is 0 then we have nothing to do. We must not call
3472 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003473 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003474}
Michael Thomasff0e8b92020-01-21 15:01:10 +00003475// The weakly linked function "psa_asymmetric_verify_vendor_weak" which returns "PSA_ERROR_NOT_SUPPORTED" will be linked if
3476// the vendor does not provide a definition for "psa_asymmetric_verify_vendor"
Michael Thomas153cd2f2020-01-22 16:54:38 +00003477psa_status_t psa_asymmetric_verify_vendor( psa_key_slot_t * slot,
Michael Thomasff0e8b92020-01-21 15:01:10 +00003478 psa_algorithm_t alg,
3479 const uint8_t *hash,
3480 size_t hash_length,
3481 uint8_t *signature,
Michael Thomas153cd2f2020-01-22 16:54:38 +00003482 size_t signature_length ) __attribute__ ((weak, alias("psa_asymmetric_verify_vendor_weak")));
3483psa_status_t psa_asymmetric_verify_vendor_weak( psa_key_slot_t * slot,
Michael Thomasff0e8b92020-01-21 15:01:10 +00003484 psa_algorithm_t alg,
3485 const uint8_t *hash,
3486 size_t hash_length,
3487 uint8_t *signature,
Michael Thomas153cd2f2020-01-22 16:54:38 +00003488 size_t signature_length );
3489psa_status_t psa_asymmetric_verify_vendor_weak( psa_key_slot_t * slot,
Michael Thomasff0e8b92020-01-21 15:01:10 +00003490 psa_algorithm_t alg,
3491 const uint8_t *hash,
3492 size_t hash_length,
3493 uint8_t *signature,
Michael Thomas153cd2f2020-01-22 16:54:38 +00003494 size_t signature_length )
Michael Thomasff0e8b92020-01-21 15:01:10 +00003495{
Michael Thomas153cd2f2020-01-22 16:54:38 +00003496 (void) slot;
Michael Thomasff0e8b92020-01-21 15:01:10 +00003497 (void) alg;
3498 (void)hash;
3499 (void)hash_length;
3500 (void)signature;
3501 (void)signature_length;
itayzafrir5c753392018-05-08 11:18:38 +03003502
Michael Thomasff0e8b92020-01-21 15:01:10 +00003503
3504 return PSA_ERROR_NOT_SUPPORTED;
3505}
Gilles Peskinec5487a82018-12-03 18:08:14 +01003506psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03003507 psa_algorithm_t alg,
3508 const uint8_t *hash,
3509 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02003510 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02003511 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003512{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003513 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003514 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003515#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3516 const psa_drv_se_t *drv;
3517 psa_drv_se_context_t *drv_context;
3518#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003519
Gilles Peskineedc64242019-08-07 21:05:07 +02003520 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003521 if( status != PSA_SUCCESS )
3522 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003523
Gilles Peskineedc64242019-08-07 21:05:07 +02003524#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3525 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3526 {
3527 if( drv->asymmetric == NULL ||
3528 drv->asymmetric->p_verify == NULL )
3529 return( PSA_ERROR_NOT_SUPPORTED );
3530 return( drv->asymmetric->p_verify( drv_context,
3531 slot->data.se.slot_number,
3532 alg,
3533 hash, hash_length,
3534 signature, signature_length ) );
3535 }
3536 else
3537#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Michael Thomas153cd2f2020-01-22 16:54:38 +00003538if (PSA_KEY_LIFETIME_IS_VENDOR_DEFINED(slot->attr.lifetime))
Michael Thomasff0e8b92020-01-21 15:01:10 +00003539 {
Michael Thomas153cd2f2020-01-22 16:54:38 +00003540 return( psa_asymmetric_verify_vendor(slot,alg,
Michael Thomasecb72842020-01-22 23:24:41 +00003541 hash, hash_length,
3542 signature, signature_length ) );
Michael Thomasff0e8b92020-01-21 15:01:10 +00003543 }
3544 else
Gilles Peskine61b91d42018-06-08 16:09:36 +02003545#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003546 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003547 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02003548 return( psa_rsa_verify( slot->data.rsa,
3549 alg,
3550 hash, hash_length,
3551 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003552 }
3553 else
3554#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003555#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003556 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003557 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003558#if defined(MBEDTLS_ECDSA_C)
3559 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003560 return( psa_ecdsa_verify( slot->data.ecp,
3561 hash, hash_length,
3562 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003563 else
3564#endif /* defined(MBEDTLS_ECDSA_C) */
3565 {
3566 return( PSA_ERROR_INVALID_ARGUMENT );
3567 }
itayzafrir5c753392018-05-08 11:18:38 +03003568 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003569 else
3570#endif /* defined(MBEDTLS_ECP_C) */
3571 {
3572 return( PSA_ERROR_NOT_SUPPORTED );
3573 }
3574}
3575
Gilles Peskine072ac562018-06-30 00:21:29 +02003576#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3577static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3578 mbedtls_rsa_context *rsa )
3579{
3580 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3581 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3582 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3583 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3584}
3585#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3586
Gilles Peskinec5487a82018-12-03 18:08:14 +01003587psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003588 psa_algorithm_t alg,
3589 const uint8_t *input,
3590 size_t input_length,
3591 const uint8_t *salt,
3592 size_t salt_length,
3593 uint8_t *output,
3594 size_t output_size,
3595 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003596{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003597 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003598 psa_status_t status;
3599
Darryl Green5cc689a2018-07-24 15:34:10 +01003600 (void) input;
3601 (void) input_length;
3602 (void) salt;
3603 (void) output;
3604 (void) output_size;
3605
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003606 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003607
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003608 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3609 return( PSA_ERROR_INVALID_ARGUMENT );
3610
Gilles Peskine28f8f302019-07-24 13:30:31 +02003611 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003612 if( status != PSA_SUCCESS )
3613 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003614 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3615 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003616 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003617
3618#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003619 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003620 {
3621 mbedtls_rsa_context *rsa = slot->data.rsa;
3622 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003623 if( output_size < mbedtls_rsa_get_len( rsa ) )
Vikas Katariya21599b62019-08-02 12:26:29 +01003624 return( PSA_ERROR_BUFFER_TOO_SMALL );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003625#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003626 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003627 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003628 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3629 mbedtls_ctr_drbg_random,
3630 &global_data.ctr_drbg,
3631 MBEDTLS_RSA_PUBLIC,
3632 input_length,
3633 input,
3634 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003635 }
3636 else
3637#endif /* MBEDTLS_PKCS1_V15 */
3638#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003639 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003640 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003641 psa_rsa_oaep_set_padding_mode( alg, rsa );
3642 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3643 mbedtls_ctr_drbg_random,
3644 &global_data.ctr_drbg,
3645 MBEDTLS_RSA_PUBLIC,
3646 salt, salt_length,
3647 input_length,
3648 input,
3649 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003650 }
3651 else
3652#endif /* MBEDTLS_PKCS1_V21 */
3653 {
3654 return( PSA_ERROR_INVALID_ARGUMENT );
3655 }
3656 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003657 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003658 return( mbedtls_to_psa_error( ret ) );
3659 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003660 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003661#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003662 {
3663 return( PSA_ERROR_NOT_SUPPORTED );
3664 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003665}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003666
Gilles Peskinec5487a82018-12-03 18:08:14 +01003667psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003668 psa_algorithm_t alg,
3669 const uint8_t *input,
3670 size_t input_length,
3671 const uint8_t *salt,
3672 size_t salt_length,
3673 uint8_t *output,
3674 size_t output_size,
3675 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003676{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003677 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003678 psa_status_t status;
3679
Darryl Green5cc689a2018-07-24 15:34:10 +01003680 (void) input;
3681 (void) input_length;
3682 (void) salt;
3683 (void) output;
3684 (void) output_size;
3685
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003686 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003687
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003688 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3689 return( PSA_ERROR_INVALID_ARGUMENT );
3690
Gilles Peskine28f8f302019-07-24 13:30:31 +02003691 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003692 if( status != PSA_SUCCESS )
3693 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003694 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003695 return( PSA_ERROR_INVALID_ARGUMENT );
3696
3697#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003698 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003699 {
3700 mbedtls_rsa_context *rsa = slot->data.rsa;
3701 int ret;
3702
Gilles Peskine630a18a2018-06-29 17:49:35 +02003703 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003704 return( PSA_ERROR_INVALID_ARGUMENT );
3705
3706#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003707 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003708 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003709 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3710 mbedtls_ctr_drbg_random,
3711 &global_data.ctr_drbg,
3712 MBEDTLS_RSA_PRIVATE,
3713 output_length,
3714 input,
3715 output,
3716 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003717 }
3718 else
3719#endif /* MBEDTLS_PKCS1_V15 */
3720#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003721 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003722 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003723 psa_rsa_oaep_set_padding_mode( alg, rsa );
3724 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3725 mbedtls_ctr_drbg_random,
3726 &global_data.ctr_drbg,
3727 MBEDTLS_RSA_PRIVATE,
3728 salt, salt_length,
3729 output_length,
3730 input,
3731 output,
3732 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003733 }
3734 else
3735#endif /* MBEDTLS_PKCS1_V21 */
3736 {
3737 return( PSA_ERROR_INVALID_ARGUMENT );
3738 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003739
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003740 return( mbedtls_to_psa_error( ret ) );
3741 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003742 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003743#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003744 {
3745 return( PSA_ERROR_NOT_SUPPORTED );
3746 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003747}
Gilles Peskine20035e32018-02-03 22:44:14 +01003748
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003749
3750
mohammad1603503973b2018-03-12 15:59:30 +02003751/****************************************************************/
3752/* Symmetric cryptography */
3753/****************************************************************/
3754
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003755/* Initialize the cipher operation structure. Once this function has been
3756 * called, psa_cipher_abort can run and will do the right thing. */
3757static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3758 psa_algorithm_t alg )
3759{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003760 if( ! PSA_ALG_IS_CIPHER( alg ) )
3761 {
3762 memset( operation, 0, sizeof( *operation ) );
3763 return( PSA_ERROR_INVALID_ARGUMENT );
3764 }
3765
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003766 operation->alg = alg;
3767 operation->key_set = 0;
3768 operation->iv_set = 0;
3769 operation->iv_required = 1;
3770 operation->iv_size = 0;
3771 operation->block_size = 0;
3772 mbedtls_cipher_init( &operation->ctx.cipher );
3773 return( PSA_SUCCESS );
3774}
Michael Thomas2d73c202020-01-10 21:59:40 +00003775// The weakly linked function "psa_cipher_setup_vendor_weak" which returns "PSA_ERROR_NOT_SUPPORTED" will be linked if
3776// the vendor does not provide a definition for "psa_cipher_setup_vendor"
3777psa_status_t psa_cipher_setup_vendor( psa_cipher_operation_t * operation, psa_key_handle_t handle, psa_algorithm_t alg) __attribute__ ((weak, alias("psa_cipher_setup_vendor_weak")));
3778psa_status_t psa_cipher_setup_vendor_weak( psa_cipher_operation_t * operation, psa_key_handle_t handle, psa_algorithm_t alg);
3779psa_status_t psa_cipher_setup_vendor_weak( psa_cipher_operation_t * operation, psa_key_handle_t handle, psa_algorithm_t alg)
3780{
3781 (void)operation;
3782 (void)handle;
3783 (void)alg;
3784 return PSA_ERROR_NOT_SUPPORTED;
3785}
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003786
Gilles Peskinee553c652018-06-04 16:22:46 +02003787static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003788 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003789 psa_algorithm_t alg,
3790 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003791{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003792 int ret = 0;
3793 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003794 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003795 size_t key_bits;
3796 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003797 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3798 PSA_KEY_USAGE_ENCRYPT :
3799 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003800
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003801 /* A context must be freshly initialized before it can be set up. */
3802 if( operation->alg != 0 )
3803 {
3804 return( PSA_ERROR_BAD_STATE );
3805 }
3806
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003807 status = psa_cipher_init( operation, alg );
3808 if( status != PSA_SUCCESS )
3809 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003810
Gilles Peskine28f8f302019-07-24 13:30:31 +02003811 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003812 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003813 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003814 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003815
Gilles Peskine8e338702019-07-30 20:06:31 +02003816 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003817 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003818 {
3819 status = PSA_ERROR_NOT_SUPPORTED;
3820 goto exit;
3821 }
mohammad1603503973b2018-03-12 15:59:30 +02003822
mohammad1603503973b2018-03-12 15:59:30 +02003823 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003824 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003825 goto exit;
Michael Thomas17547bc2020-01-14 16:47:03 +00003826
Michael Thomas153cd2f2020-01-22 16:54:38 +00003827 if (PSA_KEY_LIFETIME_IS_VENDOR_DEFINED(slot->attr.lifetime))
Michael Thomas17547bc2020-01-14 16:47:03 +00003828 {
3829 status = psa_cipher_setup_vendor(operation, handle, alg);
Michael Thomasecb72842020-01-22 23:24:41 +00003830 if( status != PSA_SUCCESS )
3831 goto exit;
Michael Thomas17547bc2020-01-14 16:47:03 +00003832 }
mohammad1603503973b2018-03-12 15:59:30 +02003833
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003834#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003835 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003836 {
3837 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003838 uint8_t keys[24];
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003839 memcpy( keys, slot->data.raw.data, 16 );
3840 memcpy( keys + 16, slot->data.raw.data, 8 );
3841 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3842 keys,
3843 192, cipher_operation );
3844 }
3845 else
3846#endif
3847 {
3848 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3849 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003850 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003851 }
Moran Peker41deec42018-04-04 15:43:05 +03003852 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003853 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003854
mohammad16038481e742018-03-18 13:57:31 +02003855#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003856 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003857 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003858 case PSA_ALG_CBC_NO_PADDING:
3859 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3860 MBEDTLS_PADDING_NONE );
3861 break;
3862 case PSA_ALG_CBC_PKCS7:
3863 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3864 MBEDTLS_PADDING_PKCS7 );
3865 break;
3866 default:
3867 /* The algorithm doesn't involve padding. */
3868 ret = 0;
3869 break;
3870 }
3871 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003872 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003873#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3874
mohammad1603503973b2018-03-12 15:59:30 +02003875 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003876 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02003877 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003878 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003879 {
Gilles Peskine8e338702019-07-30 20:06:31 +02003880 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003881 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003882#if defined(MBEDTLS_CHACHA20_C)
3883 else
3884 if( alg == PSA_ALG_CHACHA20 )
3885 operation->iv_size = 12;
3886#endif
mohammad1603503973b2018-03-12 15:59:30 +02003887
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003888exit:
3889 if( status == 0 )
3890 status = mbedtls_to_psa_error( ret );
3891 if( status != 0 )
3892 psa_cipher_abort( operation );
3893 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003894}
3895
Gilles Peskinefe119512018-07-08 21:39:34 +02003896psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003897 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003898 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003899{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003900 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003901}
3902
Gilles Peskinefe119512018-07-08 21:39:34 +02003903psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003904 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003905 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003906{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003907 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003908}
3909
Gilles Peskinefe119512018-07-08 21:39:34 +02003910psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003911 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003912 size_t iv_size,
3913 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003914{
itayzafrir534bd7c2018-08-02 13:56:32 +03003915 psa_status_t status;
3916 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003917 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003918 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003919 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003920 }
Moran Peker41deec42018-04-04 15:43:05 +03003921 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003922 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003923 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003924 goto exit;
3925 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003926 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3927 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003928 if( ret != 0 )
3929 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003930 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003931 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003932 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003933
mohammad16038481e742018-03-18 13:57:31 +02003934 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003935 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003936
Moran Peker395db872018-05-31 14:07:14 +03003937exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003938 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003939 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003940 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003941}
3942
Gilles Peskinefe119512018-07-08 21:39:34 +02003943psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003944 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003945 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003946{
itayzafrir534bd7c2018-08-02 13:56:32 +03003947 psa_status_t status;
3948 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003949 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003950 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003951 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003952 }
Moran Pekera28258c2018-05-29 16:25:04 +03003953 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003954 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003955 status = PSA_ERROR_INVALID_ARGUMENT;
3956 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003957 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003958 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3959 status = mbedtls_to_psa_error( ret );
3960exit:
3961 if( status == PSA_SUCCESS )
3962 operation->iv_set = 1;
3963 else
mohammad1603503973b2018-03-12 15:59:30 +02003964 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003965 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003966}
3967
Gilles Peskinee553c652018-06-04 16:22:46 +02003968psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3969 const uint8_t *input,
3970 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003971 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003972 size_t output_size,
3973 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003974{
itayzafrir534bd7c2018-08-02 13:56:32 +03003975 psa_status_t status;
3976 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003977 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003978
3979 if( operation->alg == 0 )
3980 {
3981 return( PSA_ERROR_BAD_STATE );
3982 }
3983
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003984 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003985 {
3986 /* Take the unprocessed partial block left over from previous
3987 * update calls, if any, plus the input to this call. Remove
3988 * the last partial block, if any. You get the data that will be
3989 * output in this call. */
3990 expected_output_size =
3991 ( operation->ctx.cipher.unprocessed_len + input_length )
3992 / operation->block_size * operation->block_size;
3993 }
3994 else
3995 {
3996 expected_output_size = input_length;
3997 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003998
Gilles Peskine89d789c2018-06-04 17:17:16 +02003999 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004000 {
4001 status = PSA_ERROR_BUFFER_TOO_SMALL;
4002 goto exit;
4003 }
mohammad160382759612018-03-12 18:16:40 +02004004
mohammad1603503973b2018-03-12 15:59:30 +02004005 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02004006 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03004007 status = mbedtls_to_psa_error( ret );
4008exit:
4009 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004010 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004011 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004012}
4013
Gilles Peskinee553c652018-06-04 16:22:46 +02004014psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4015 uint8_t *output,
4016 size_t output_size,
4017 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004018{
David Saadab4ecc272019-02-14 13:48:10 +02004019 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01004020 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02004021 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03004022
mohammad1603503973b2018-03-12 15:59:30 +02004023 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004024 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00004025 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03004026 }
4027 if( operation->iv_required && ! operation->iv_set )
4028 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00004029 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03004030 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004031
Gilles Peskine2c5219a2018-06-06 15:12:32 +02004032 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004033 operation->alg == PSA_ALG_CBC_NO_PADDING &&
4034 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004035 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004036 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01004037 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004038 }
4039
Janos Follath315b51c2018-07-09 16:04:51 +01004040 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
4041 temp_output_buffer,
4042 output_length );
4043 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02004044 {
Janos Follath315b51c2018-07-09 16:04:51 +01004045 status = mbedtls_to_psa_error( cipher_ret );
4046 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02004047 }
Janos Follath315b51c2018-07-09 16:04:51 +01004048
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004049 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004050 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004051 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004052 memcpy( output, temp_output_buffer, *output_length );
4053 else
4054 {
Janos Follath315b51c2018-07-09 16:04:51 +01004055 status = PSA_ERROR_BUFFER_TOO_SMALL;
4056 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004057 }
mohammad1603503973b2018-03-12 15:59:30 +02004058
Gilles Peskine3f108122018-12-07 18:14:53 +01004059 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004060 status = psa_cipher_abort( operation );
4061
4062 return( status );
4063
4064error:
4065
4066 *output_length = 0;
4067
Gilles Peskine3f108122018-12-07 18:14:53 +01004068 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004069 (void) psa_cipher_abort( operation );
4070
4071 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004072}
4073
Michael Thomas7de9ac52020-01-15 18:08:15 +00004074// The weakly linked function "psa_cipher_abort_vendor_weak" which returns "PSA_SUCCESS" will be linked if
4075// the vendor does not provide a definition for "psa_cipher_abort_vendor"
4076psa_status_t psa_cipher_abort_vendor( psa_cipher_operation_t * operation) __attribute__ ((weak, alias("psa_cipher_abort_vendor_weak")));
4077psa_status_t psa_cipher_abort_vendor_weak( psa_cipher_operation_t * operation);
4078psa_status_t psa_cipher_abort_vendor_weak( psa_cipher_operation_t * operation)
4079{
4080 (void)operation;
4081 return PSA_SUCCESS;
4082}
4083
Gilles Peskinee553c652018-06-04 16:22:46 +02004084psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4085{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004086 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004087 {
4088 /* The object has (apparently) been initialized but it is not
4089 * in use. It's ok to call abort on such an object, and there's
4090 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004091 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004092 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004093
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004094 /* Sanity check (shouldn't happen: operation->alg should
4095 * always have been initialized to a valid value). */
4096 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4097 return( PSA_ERROR_BAD_STATE );
4098
Michael Thomas7de9ac52020-01-15 18:08:15 +00004099 psa_cipher_abort_vendor(operation);
mohammad1603503973b2018-03-12 15:59:30 +02004100 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004101
Moran Peker41deec42018-04-04 15:43:05 +03004102 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004103 operation->key_set = 0;
4104 operation->iv_set = 0;
4105 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004106 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004107 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004108
Moran Peker395db872018-05-31 14:07:14 +03004109 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004110}
4111
Gilles Peskinea0655c32018-04-30 17:06:50 +02004112
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004113
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004114
mohammad16035955c982018-04-26 00:53:03 +03004115/****************************************************************/
4116/* AEAD */
4117/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004118
Gilles Peskineedf9a652018-08-17 18:11:56 +02004119typedef struct
4120{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004121 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004122 const mbedtls_cipher_info_t *cipher_info;
4123 union
4124 {
4125#if defined(MBEDTLS_CCM_C)
4126 mbedtls_ccm_context ccm;
4127#endif /* MBEDTLS_CCM_C */
4128#if defined(MBEDTLS_GCM_C)
4129 mbedtls_gcm_context gcm;
4130#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004131#if defined(MBEDTLS_CHACHAPOLY_C)
4132 mbedtls_chachapoly_context chachapoly;
4133#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004134 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004135 psa_algorithm_t core_alg;
4136 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004137 uint8_t tag_length;
4138} aead_operation_t;
4139
Gilles Peskine30a9e412019-01-14 18:36:12 +01004140static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004141{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004142 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004143 {
4144#if defined(MBEDTLS_CCM_C)
4145 case PSA_ALG_CCM:
4146 mbedtls_ccm_free( &operation->ctx.ccm );
4147 break;
4148#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004149#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004150 case PSA_ALG_GCM:
4151 mbedtls_gcm_free( &operation->ctx.gcm );
4152 break;
4153#endif /* MBEDTLS_GCM_C */
4154 }
4155}
4156
4157static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004158 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004159 psa_key_usage_t usage,
4160 psa_algorithm_t alg )
4161{
4162 psa_status_t status;
4163 size_t key_bits;
4164 mbedtls_cipher_id_t cipher_id;
4165
Gilles Peskine28f8f302019-07-24 13:30:31 +02004166 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004167 if( status != PSA_SUCCESS )
4168 return( status );
4169
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004170 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004171
4172 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004173 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004174 &cipher_id );
4175 if( operation->cipher_info == NULL )
4176 return( PSA_ERROR_NOT_SUPPORTED );
4177
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004178 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004179 {
4180#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004181 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4182 operation->core_alg = PSA_ALG_CCM;
4183 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004184 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4185 * The call to mbedtls_ccm_encrypt_and_tag or
4186 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004187 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004188 return( PSA_ERROR_INVALID_ARGUMENT );
4189 mbedtls_ccm_init( &operation->ctx.ccm );
4190 status = mbedtls_to_psa_error(
4191 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
4192 operation->slot->data.raw.data,
4193 (unsigned int) key_bits ) );
4194 if( status != 0 )
4195 goto cleanup;
4196 break;
4197#endif /* MBEDTLS_CCM_C */
4198
4199#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004200 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4201 operation->core_alg = PSA_ALG_GCM;
4202 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004203 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4204 * The call to mbedtls_gcm_crypt_and_tag or
4205 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004206 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004207 return( PSA_ERROR_INVALID_ARGUMENT );
4208 mbedtls_gcm_init( &operation->ctx.gcm );
4209 status = mbedtls_to_psa_error(
4210 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
4211 operation->slot->data.raw.data,
4212 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004213 if( status != 0 )
4214 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004215 break;
4216#endif /* MBEDTLS_GCM_C */
4217
Gilles Peskine26869f22019-05-06 15:25:00 +02004218#if defined(MBEDTLS_CHACHAPOLY_C)
4219 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4220 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4221 operation->full_tag_length = 16;
4222 /* We only support the default tag length. */
4223 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4224 return( PSA_ERROR_NOT_SUPPORTED );
4225 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4226 status = mbedtls_to_psa_error(
4227 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
4228 operation->slot->data.raw.data ) );
4229 if( status != 0 )
4230 goto cleanup;
4231 break;
4232#endif /* MBEDTLS_CHACHAPOLY_C */
4233
Gilles Peskineedf9a652018-08-17 18:11:56 +02004234 default:
4235 return( PSA_ERROR_NOT_SUPPORTED );
4236 }
4237
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004238 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4239 {
4240 status = PSA_ERROR_INVALID_ARGUMENT;
4241 goto cleanup;
4242 }
4243 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004244
Gilles Peskineedf9a652018-08-17 18:11:56 +02004245 return( PSA_SUCCESS );
4246
4247cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004248 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004249 return( status );
4250}
4251
Gilles Peskinec5487a82018-12-03 18:08:14 +01004252psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004253 psa_algorithm_t alg,
4254 const uint8_t *nonce,
4255 size_t nonce_length,
4256 const uint8_t *additional_data,
4257 size_t additional_data_length,
4258 const uint8_t *plaintext,
4259 size_t plaintext_length,
4260 uint8_t *ciphertext,
4261 size_t ciphertext_size,
4262 size_t *ciphertext_length )
4263{
mohammad16035955c982018-04-26 00:53:03 +03004264 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004265 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004266 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004267
mohammad1603f08a5502018-06-03 15:05:47 +03004268 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004269
Gilles Peskinec5487a82018-12-03 18:08:14 +01004270 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004271 if( status != PSA_SUCCESS )
4272 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004273
Gilles Peskineedf9a652018-08-17 18:11:56 +02004274 /* For all currently supported modes, the tag is at the end of the
4275 * ciphertext. */
4276 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4277 {
4278 status = PSA_ERROR_BUFFER_TOO_SMALL;
4279 goto exit;
4280 }
4281 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004282
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004283#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004284 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004285 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004286 status = mbedtls_to_psa_error(
4287 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4288 MBEDTLS_GCM_ENCRYPT,
4289 plaintext_length,
4290 nonce, nonce_length,
4291 additional_data, additional_data_length,
4292 plaintext, ciphertext,
4293 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004294 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004295 else
4296#endif /* MBEDTLS_GCM_C */
4297#if defined(MBEDTLS_CCM_C)
4298 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004299 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004300 status = mbedtls_to_psa_error(
4301 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4302 plaintext_length,
4303 nonce, nonce_length,
4304 additional_data,
4305 additional_data_length,
4306 plaintext, ciphertext,
4307 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004308 }
mohammad16035c8845f2018-05-09 05:40:09 -07004309 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004310#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004311#if defined(MBEDTLS_CHACHAPOLY_C)
4312 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4313 {
4314 if( nonce_length != 12 || operation.tag_length != 16 )
4315 {
4316 status = PSA_ERROR_NOT_SUPPORTED;
4317 goto exit;
4318 }
4319 status = mbedtls_to_psa_error(
4320 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4321 plaintext_length,
4322 nonce,
4323 additional_data,
4324 additional_data_length,
4325 plaintext,
4326 ciphertext,
4327 tag ) );
4328 }
4329 else
4330#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004331 {
mohammad1603554faad2018-06-03 15:07:38 +03004332 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004333 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004334
Gilles Peskineedf9a652018-08-17 18:11:56 +02004335 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4336 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004337
Gilles Peskineedf9a652018-08-17 18:11:56 +02004338exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004339 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004340 if( status == PSA_SUCCESS )
4341 *ciphertext_length = plaintext_length + operation.tag_length;
4342 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004343}
4344
Gilles Peskineee652a32018-06-01 19:23:52 +02004345/* Locate the tag in a ciphertext buffer containing the encrypted data
4346 * followed by the tag. Return the length of the part preceding the tag in
4347 * *plaintext_length. This is the size of the plaintext in modes where
4348 * the encrypted data has the same size as the plaintext, such as
4349 * CCM and GCM. */
4350static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4351 const uint8_t *ciphertext,
4352 size_t ciphertext_length,
4353 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004354 const uint8_t **p_tag )
4355{
4356 size_t payload_length;
4357 if( tag_length > ciphertext_length )
4358 return( PSA_ERROR_INVALID_ARGUMENT );
4359 payload_length = ciphertext_length - tag_length;
4360 if( payload_length > plaintext_size )
4361 return( PSA_ERROR_BUFFER_TOO_SMALL );
4362 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004363 return( PSA_SUCCESS );
4364}
4365
Gilles Peskinec5487a82018-12-03 18:08:14 +01004366psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004367 psa_algorithm_t alg,
4368 const uint8_t *nonce,
4369 size_t nonce_length,
4370 const uint8_t *additional_data,
4371 size_t additional_data_length,
4372 const uint8_t *ciphertext,
4373 size_t ciphertext_length,
4374 uint8_t *plaintext,
4375 size_t plaintext_size,
4376 size_t *plaintext_length )
4377{
mohammad16035955c982018-04-26 00:53:03 +03004378 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004379 aead_operation_t operation;
4380 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004381
Gilles Peskineee652a32018-06-01 19:23:52 +02004382 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004383
Gilles Peskinec5487a82018-12-03 18:08:14 +01004384 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004385 if( status != PSA_SUCCESS )
4386 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004387
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004388 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4389 ciphertext, ciphertext_length,
4390 plaintext_size, &tag );
4391 if( status != PSA_SUCCESS )
4392 goto exit;
4393
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004394#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004395 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004396 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004397 status = mbedtls_to_psa_error(
4398 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4399 ciphertext_length - operation.tag_length,
4400 nonce, nonce_length,
4401 additional_data,
4402 additional_data_length,
4403 tag, operation.tag_length,
4404 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004405 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004406 else
4407#endif /* MBEDTLS_GCM_C */
4408#if defined(MBEDTLS_CCM_C)
4409 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004410 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004411 status = mbedtls_to_psa_error(
4412 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4413 ciphertext_length - operation.tag_length,
4414 nonce, nonce_length,
4415 additional_data,
4416 additional_data_length,
4417 ciphertext, plaintext,
4418 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004419 }
mohammad160339574652018-06-01 04:39:53 -07004420 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004421#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004422#if defined(MBEDTLS_CHACHAPOLY_C)
4423 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4424 {
4425 if( nonce_length != 12 || operation.tag_length != 16 )
4426 {
4427 status = PSA_ERROR_NOT_SUPPORTED;
4428 goto exit;
4429 }
4430 status = mbedtls_to_psa_error(
4431 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4432 ciphertext_length - operation.tag_length,
4433 nonce,
4434 additional_data,
4435 additional_data_length,
4436 tag,
4437 ciphertext,
4438 plaintext ) );
4439 }
4440 else
4441#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004442 {
mohammad1603554faad2018-06-03 15:07:38 +03004443 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004444 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004445
Gilles Peskineedf9a652018-08-17 18:11:56 +02004446 if( status != PSA_SUCCESS && plaintext_size != 0 )
4447 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004448
Gilles Peskineedf9a652018-08-17 18:11:56 +02004449exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004450 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004451 if( status == PSA_SUCCESS )
4452 *plaintext_length = ciphertext_length - operation.tag_length;
4453 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004454}
4455
Gilles Peskinea0655c32018-04-30 17:06:50 +02004456
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004457
Gilles Peskine20035e32018-02-03 22:44:14 +01004458/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004459/* Generators */
4460/****************************************************************/
4461
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004462#define HKDF_STATE_INIT 0 /* no input yet */
4463#define HKDF_STATE_STARTED 1 /* got salt */
4464#define HKDF_STATE_KEYED 2 /* got key */
4465#define HKDF_STATE_OUTPUT 3 /* output started */
4466
Gilles Peskinecbe66502019-05-16 16:59:18 +02004467static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004468 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004469{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004470 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4471 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004472 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004473 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004474}
4475
4476
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004477psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004478{
4479 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004480 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004481 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004482 {
4483 /* The object has (apparently) been initialized but it is not
4484 * in use. It's ok to call abort on such an object, and there's
4485 * nothing to do. */
4486 }
4487 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004488#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004489 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004490 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004491 mbedtls_free( operation->ctx.hkdf.info );
4492 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004493 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004494 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004495 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004496 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004497 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004498 if( operation->ctx.tls12_prf.seed != NULL )
4499 {
4500 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4501 operation->ctx.tls12_prf.seed_length );
4502 mbedtls_free( operation->ctx.tls12_prf.seed );
4503 }
4504
4505 if( operation->ctx.tls12_prf.label != NULL )
4506 {
4507 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4508 operation->ctx.tls12_prf.label_length );
4509 mbedtls_free( operation->ctx.tls12_prf.label );
4510 }
4511
4512 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4513
4514 /* We leave the fields Ai and output_block to be erased safely by the
4515 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004516 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004517 else
4518#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004519 {
4520 status = PSA_ERROR_BAD_STATE;
4521 }
Janos Follath083036a2019-06-11 10:22:26 +01004522 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004523 return( status );
4524}
4525
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004526psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004527 size_t *capacity)
4528{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004529 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004530 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004531 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004532 return PSA_ERROR_BAD_STATE;
4533 }
4534
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004535 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004536 return( PSA_SUCCESS );
4537}
4538
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004539psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004540 size_t capacity )
4541{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004542 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004543 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004544 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004545 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004546 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004547 return( PSA_SUCCESS );
4548}
4549
Gilles Peskinebef7f142018-07-12 17:22:21 +02004550#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004551/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004552 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004553static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004554 psa_algorithm_t hash_alg,
4555 uint8_t *output,
4556 size_t output_length )
4557{
4558 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4559 psa_status_t status;
4560
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004561 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4562 return( PSA_ERROR_BAD_STATE );
4563 hkdf->state = HKDF_STATE_OUTPUT;
4564
Gilles Peskinebef7f142018-07-12 17:22:21 +02004565 while( output_length != 0 )
4566 {
4567 /* Copy what remains of the current block */
4568 uint8_t n = hash_length - hkdf->offset_in_block;
4569 if( n > output_length )
4570 n = (uint8_t) output_length;
4571 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4572 output += n;
4573 output_length -= n;
4574 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004575 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004576 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004577 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004578 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004579 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004580 * object was corrupted or if this function is called directly
4581 * inside the library. */
4582 if( hkdf->block_number == 0xff )
4583 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004584
4585 /* We need a new block */
4586 ++hkdf->block_number;
4587 hkdf->offset_in_block = 0;
4588 status = psa_hmac_setup_internal( &hkdf->hmac,
4589 hkdf->prk, hash_length,
4590 hash_alg );
4591 if( status != PSA_SUCCESS )
4592 return( status );
4593 if( hkdf->block_number != 1 )
4594 {
4595 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4596 hkdf->output_block,
4597 hash_length );
4598 if( status != PSA_SUCCESS )
4599 return( status );
4600 }
4601 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4602 hkdf->info,
4603 hkdf->info_length );
4604 if( status != PSA_SUCCESS )
4605 return( status );
4606 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4607 &hkdf->block_number, 1 );
4608 if( status != PSA_SUCCESS )
4609 return( status );
4610 status = psa_hmac_finish_internal( &hkdf->hmac,
4611 hkdf->output_block,
4612 sizeof( hkdf->output_block ) );
4613 if( status != PSA_SUCCESS )
4614 return( status );
4615 }
4616
4617 return( PSA_SUCCESS );
4618}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004619
Janos Follath7742fee2019-06-17 12:58:10 +01004620static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4621 psa_tls12_prf_key_derivation_t *tls12_prf,
4622 psa_algorithm_t alg )
4623{
4624 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4625 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004626 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4627 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004628
Janos Follath7742fee2019-06-17 12:58:10 +01004629 /* We can't be wanting more output after block 0xff, otherwise
4630 * the capacity check in psa_key_derivation_output_bytes() would have
4631 * prevented this call. It could happen only if the operation
4632 * object was corrupted or if this function is called directly
4633 * inside the library. */
4634 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004635 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004636
4637 /* We need a new block */
4638 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004639 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004640
4641 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4642 *
4643 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4644 *
4645 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4646 * HMAC_hash(secret, A(2) + seed) +
4647 * HMAC_hash(secret, A(3) + seed) + ...
4648 *
4649 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004650 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004651 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004652 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004653 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004654 * is currently extracted as `output_block` and where i is
4655 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004656 */
4657
Janos Follathea29bfb2019-06-19 12:21:20 +01004658 /* Save the hash context before using it, to preserve the hash state with
4659 * only the inner padding in it. We need this, because inner padding depends
4660 * on the key (secret in the RFC's terminology). */
4661 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4662 if( status != PSA_SUCCESS )
4663 goto cleanup;
4664
4665 /* Calculate A(i) where i = tls12_prf->block_number. */
4666 if( tls12_prf->block_number == 1 )
4667 {
4668 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4669 * the variable seed and in this instance means it in the context of the
4670 * P_hash function, where seed = label + seed.) */
4671 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4672 tls12_prf->label, tls12_prf->label_length );
4673 if( status != PSA_SUCCESS )
4674 goto cleanup;
4675 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4676 tls12_prf->seed, tls12_prf->seed_length );
4677 if( status != PSA_SUCCESS )
4678 goto cleanup;
4679 }
4680 else
4681 {
4682 /* A(i) = HMAC_hash(secret, A(i-1)) */
4683 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4684 tls12_prf->Ai, hash_length );
4685 if( status != PSA_SUCCESS )
4686 goto cleanup;
4687 }
4688
4689 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4690 tls12_prf->Ai, hash_length );
4691 if( status != PSA_SUCCESS )
4692 goto cleanup;
4693 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4694 if( status != PSA_SUCCESS )
4695 goto cleanup;
4696
4697 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4698 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4699 tls12_prf->Ai, hash_length );
4700 if( status != PSA_SUCCESS )
4701 goto cleanup;
4702 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4703 tls12_prf->label, tls12_prf->label_length );
4704 if( status != PSA_SUCCESS )
4705 goto cleanup;
4706 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4707 tls12_prf->seed, tls12_prf->seed_length );
4708 if( status != PSA_SUCCESS )
4709 goto cleanup;
4710 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4711 tls12_prf->output_block, hash_length );
4712 if( status != PSA_SUCCESS )
4713 goto cleanup;
4714 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4715 if( status != PSA_SUCCESS )
4716 goto cleanup;
4717
Janos Follath7742fee2019-06-17 12:58:10 +01004718
4719cleanup:
4720
Janos Follathea29bfb2019-06-19 12:21:20 +01004721 cleanup_status = psa_hash_abort( &backup );
4722 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4723 status = cleanup_status;
4724
4725 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004726}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004727
Janos Follath844eb0e2019-06-19 12:10:49 +01004728static psa_status_t psa_key_derivation_tls12_prf_read(
4729 psa_tls12_prf_key_derivation_t *tls12_prf,
4730 psa_algorithm_t alg,
4731 uint8_t *output,
4732 size_t output_length )
4733{
4734 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4735 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4736 psa_status_t status;
4737 uint8_t offset, length;
4738
4739 while( output_length != 0 )
4740 {
4741 /* Check if we have fully processed the current block. */
4742 if( tls12_prf->left_in_block == 0 )
4743 {
4744 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4745 alg );
4746 if( status != PSA_SUCCESS )
4747 return( status );
4748
4749 continue;
4750 }
4751
4752 if( tls12_prf->left_in_block > output_length )
4753 length = (uint8_t) output_length;
4754 else
4755 length = tls12_prf->left_in_block;
4756
4757 offset = hash_length - tls12_prf->left_in_block;
4758 memcpy( output, tls12_prf->output_block + offset, length );
4759 output += length;
4760 output_length -= length;
4761 tls12_prf->left_in_block -= length;
4762 }
4763
4764 return( PSA_SUCCESS );
4765}
Gilles Peskinebef7f142018-07-12 17:22:21 +02004766#endif /* MBEDTLS_MD_C */
4767
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004768psa_status_t psa_key_derivation_output_bytes(
4769 psa_key_derivation_operation_t *operation,
4770 uint8_t *output,
4771 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004772{
4773 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004774 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004775
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004776 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004777 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004778 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004779 return PSA_ERROR_BAD_STATE;
4780 }
4781
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004782 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004783 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004784 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004785 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004786 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004787 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004788 goto exit;
4789 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004790 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004791 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004792 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004793 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004794 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4795 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004796 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004797 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004798 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004799 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004800 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004801
Gilles Peskinebef7f142018-07-12 17:22:21 +02004802#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004803 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004804 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004805 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004806 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004807 output, output_length );
4808 }
Janos Follathadbec812019-06-14 11:05:39 +01004809 else
Janos Follathadbec812019-06-14 11:05:39 +01004810 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004811 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004812 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004813 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004814 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004815 output_length );
4816 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004817 else
4818#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004819 {
4820 return( PSA_ERROR_BAD_STATE );
4821 }
4822
4823exit:
4824 if( status != PSA_SUCCESS )
4825 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004826 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004827 * This allows us to differentiate between exhausted operations and
4828 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4829 * operations. */
4830 psa_algorithm_t alg = operation->alg;
4831 psa_key_derivation_abort( operation );
4832 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004833 memset( output, '!', output_length );
4834 }
4835 return( status );
4836}
4837
Gilles Peskine08542d82018-07-19 17:05:42 +02004838#if defined(MBEDTLS_DES_C)
4839static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4840{
4841 if( data_size >= 8 )
4842 mbedtls_des_key_set_parity( data );
4843 if( data_size >= 16 )
4844 mbedtls_des_key_set_parity( data + 8 );
4845 if( data_size >= 24 )
4846 mbedtls_des_key_set_parity( data + 16 );
4847}
4848#endif /* MBEDTLS_DES_C */
4849
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004850static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004851 psa_key_slot_t *slot,
4852 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004853 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004854{
4855 uint8_t *data = NULL;
4856 size_t bytes = PSA_BITS_TO_BYTES( bits );
4857 psa_status_t status;
4858
Gilles Peskine8e338702019-07-30 20:06:31 +02004859 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004860 return( PSA_ERROR_INVALID_ARGUMENT );
4861 if( bits % 8 != 0 )
4862 return( PSA_ERROR_INVALID_ARGUMENT );
4863 data = mbedtls_calloc( 1, bytes );
4864 if( data == NULL )
4865 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4866
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004867 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004868 if( status != PSA_SUCCESS )
4869 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02004870#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004871 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004872 psa_des_set_key_parity( data, bytes );
4873#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004874 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004875
4876exit:
4877 mbedtls_free( data );
4878 return( status );
4879}
4880
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004881psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004882 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004883 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004884{
4885 psa_status_t status;
4886 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004887 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinedf179142019-07-15 22:02:14 +02004888 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
4889 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004890#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4891 if( driver != NULL )
4892 {
4893 /* Deriving a key in a secure element is not implemented yet. */
4894 status = PSA_ERROR_NOT_SUPPORTED;
4895 }
4896#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004897 if( status == PSA_SUCCESS )
4898 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004899 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004900 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004901 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004902 }
4903 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004904 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004905 if( status != PSA_SUCCESS )
4906 {
Gilles Peskine011e4282019-06-26 18:34:38 +02004907 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004908 *handle = 0;
4909 }
4910 return( status );
4911}
4912
Gilles Peskineeab56e42018-07-12 17:12:33 +02004913
4914
4915/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004916/* Key derivation */
4917/****************************************************************/
4918
Gilles Peskine969c5d62019-01-16 15:53:06 +01004919static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004920 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004921 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004922{
Janos Follath5fe19732019-06-20 15:09:30 +01004923 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4924 * initialisers for this union leave some bytes unspecified.) */
4925 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4926
Gilles Peskine969c5d62019-01-16 15:53:06 +01004927 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004928#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004929 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
4930 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4931 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004932 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004933 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004934 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4935 if( hash_size == 0 )
4936 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004937 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4938 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004939 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004940 {
4941 return( PSA_ERROR_NOT_SUPPORTED );
4942 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004943 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004944 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004945 }
4946#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004947 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004948 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004949}
4950
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004951psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004952 psa_algorithm_t alg )
4953{
4954 psa_status_t status;
4955
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004956 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004957 return( PSA_ERROR_BAD_STATE );
4958
Gilles Peskine6843c292019-01-18 16:44:49 +01004959 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4960 return( PSA_ERROR_INVALID_ARGUMENT );
4961 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004962 {
4963 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004964 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004965 }
4966 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4967 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004968 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004969 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004970 else
4971 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004972
4973 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004974 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004975 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004976}
4977
4978#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004979static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004980 psa_algorithm_t hash_alg,
4981 psa_key_derivation_step_t step,
4982 const uint8_t *data,
4983 size_t data_length )
4984{
4985 psa_status_t status;
4986 switch( step )
4987 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004988 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004989 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004990 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004991 status = psa_hmac_setup_internal( &hkdf->hmac,
4992 data, data_length,
4993 hash_alg );
4994 if( status != PSA_SUCCESS )
4995 return( status );
4996 hkdf->state = HKDF_STATE_STARTED;
4997 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004998 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004999 /* If no salt was provided, use an empty salt. */
5000 if( hkdf->state == HKDF_STATE_INIT )
5001 {
5002 status = psa_hmac_setup_internal( &hkdf->hmac,
5003 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005004 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005005 if( status != PSA_SUCCESS )
5006 return( status );
5007 hkdf->state = HKDF_STATE_STARTED;
5008 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005009 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005010 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005011 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5012 data, data_length );
5013 if( status != PSA_SUCCESS )
5014 return( status );
5015 status = psa_hmac_finish_internal( &hkdf->hmac,
5016 hkdf->prk,
5017 sizeof( hkdf->prk ) );
5018 if( status != PSA_SUCCESS )
5019 return( status );
5020 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5021 hkdf->block_number = 0;
5022 hkdf->state = HKDF_STATE_KEYED;
5023 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005024 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005025 if( hkdf->state == HKDF_STATE_OUTPUT )
5026 return( PSA_ERROR_BAD_STATE );
5027 if( hkdf->info_set )
5028 return( PSA_ERROR_BAD_STATE );
5029 hkdf->info_length = data_length;
5030 if( data_length != 0 )
5031 {
5032 hkdf->info = mbedtls_calloc( 1, data_length );
5033 if( hkdf->info == NULL )
5034 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5035 memcpy( hkdf->info, data, data_length );
5036 }
5037 hkdf->info_set = 1;
5038 return( PSA_SUCCESS );
5039 default:
5040 return( PSA_ERROR_INVALID_ARGUMENT );
5041 }
5042}
Janos Follathb03233e2019-06-11 15:30:30 +01005043
Janos Follathf08e2652019-06-13 09:05:41 +01005044static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5045 const uint8_t *data,
5046 size_t data_length )
5047{
5048 if( prf->state != TLS12_PRF_STATE_INIT )
5049 return( PSA_ERROR_BAD_STATE );
5050
Janos Follathd6dce9f2019-07-04 09:11:38 +01005051 if( data_length != 0 )
5052 {
5053 prf->seed = mbedtls_calloc( 1, data_length );
5054 if( prf->seed == NULL )
5055 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005056
Janos Follathd6dce9f2019-07-04 09:11:38 +01005057 memcpy( prf->seed, data, data_length );
5058 prf->seed_length = data_length;
5059 }
Janos Follathf08e2652019-06-13 09:05:41 +01005060
5061 prf->state = TLS12_PRF_STATE_SEED_SET;
5062
5063 return( PSA_SUCCESS );
5064}
5065
Janos Follath81550542019-06-13 14:26:34 +01005066static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5067 psa_algorithm_t hash_alg,
5068 const uint8_t *data,
5069 size_t data_length )
5070{
5071 psa_status_t status;
5072 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5073 return( PSA_ERROR_BAD_STATE );
5074
5075 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5076 if( status != PSA_SUCCESS )
5077 return( status );
5078
5079 prf->state = TLS12_PRF_STATE_KEY_SET;
5080
5081 return( PSA_SUCCESS );
5082}
5083
Janos Follath6660f0e2019-06-17 08:44:03 +01005084static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5085 psa_tls12_prf_key_derivation_t *prf,
5086 psa_algorithm_t hash_alg,
5087 const uint8_t *data,
5088 size_t data_length )
5089{
5090 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005091 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5092 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005093
5094 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5095 return( PSA_ERROR_INVALID_ARGUMENT );
5096
5097 /* Quoting RFC 4279, Section 2:
5098 *
5099 * The premaster secret is formed as follows: if the PSK is N octets
5100 * long, concatenate a uint16 with the value N, N zero octets, a second
5101 * uint16 with the value N, and the PSK itself.
5102 */
5103
Janos Follath40e13932019-06-26 13:22:29 +01005104 *cur++ = ( data_length >> 8 ) & 0xff;
5105 *cur++ = ( data_length >> 0 ) & 0xff;
5106 memset( cur, 0, data_length );
5107 cur += data_length;
5108 *cur++ = pms[0];
5109 *cur++ = pms[1];
5110 memcpy( cur, data, data_length );
5111 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005112
Janos Follath40e13932019-06-26 13:22:29 +01005113 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005114
5115 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5116 return( status );
5117}
5118
Janos Follath63028dd2019-06-13 09:15:47 +01005119static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5120 const uint8_t *data,
5121 size_t data_length )
5122{
5123 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5124 return( PSA_ERROR_BAD_STATE );
5125
Janos Follathd6dce9f2019-07-04 09:11:38 +01005126 if( data_length != 0 )
5127 {
5128 prf->label = mbedtls_calloc( 1, data_length );
5129 if( prf->label == NULL )
5130 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005131
Janos Follathd6dce9f2019-07-04 09:11:38 +01005132 memcpy( prf->label, data, data_length );
5133 prf->label_length = data_length;
5134 }
Janos Follath63028dd2019-06-13 09:15:47 +01005135
5136 prf->state = TLS12_PRF_STATE_LABEL_SET;
5137
5138 return( PSA_SUCCESS );
5139}
5140
Janos Follathb03233e2019-06-11 15:30:30 +01005141static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5142 psa_algorithm_t hash_alg,
5143 psa_key_derivation_step_t step,
5144 const uint8_t *data,
5145 size_t data_length )
5146{
Janos Follathb03233e2019-06-11 15:30:30 +01005147 switch( step )
5148 {
Janos Follathf08e2652019-06-13 09:05:41 +01005149 case PSA_KEY_DERIVATION_INPUT_SEED:
5150 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005151 case PSA_KEY_DERIVATION_INPUT_SECRET:
5152 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005153 case PSA_KEY_DERIVATION_INPUT_LABEL:
5154 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005155 default:
5156 return( PSA_ERROR_INVALID_ARGUMENT );
5157 }
5158}
Janos Follath6660f0e2019-06-17 08:44:03 +01005159
5160static psa_status_t psa_tls12_prf_psk_to_ms_input(
5161 psa_tls12_prf_key_derivation_t *prf,
5162 psa_algorithm_t hash_alg,
5163 psa_key_derivation_step_t step,
5164 const uint8_t *data,
5165 size_t data_length )
5166{
5167 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005168 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005169 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5170 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005171 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005172
5173 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5174}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005175#endif /* MBEDTLS_MD_C */
5176
Janos Follathb80a94e2019-06-12 15:54:46 +01005177static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005178 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005179 psa_key_derivation_step_t step,
5180 const uint8_t *data,
5181 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005182{
5183 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005184 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005185
5186#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005187 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005188 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005189 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005190 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005191 step, data, data_length );
5192 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005193 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005194 {
Janos Follathb03233e2019-06-11 15:30:30 +01005195 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5196 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5197 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005198 }
5199 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5200 {
5201 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5202 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5203 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005204 }
5205 else
5206#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005207 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005208 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005209 return( PSA_ERROR_BAD_STATE );
5210 }
5211
5212 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005213 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005214 return( status );
5215}
5216
Janos Follath51f4a0f2019-06-14 11:35:55 +01005217psa_status_t psa_key_derivation_input_bytes(
5218 psa_key_derivation_operation_t *operation,
5219 psa_key_derivation_step_t step,
5220 const uint8_t *data,
5221 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005222{
Janos Follathc5621512019-06-14 11:27:57 +01005223 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5224 return( PSA_ERROR_INVALID_ARGUMENT );
5225
5226 return( psa_key_derivation_input_internal( operation, step,
5227 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005228}
5229
Janos Follath51f4a0f2019-06-14 11:35:55 +01005230psa_status_t psa_key_derivation_input_key(
5231 psa_key_derivation_operation_t *operation,
5232 psa_key_derivation_step_t step,
5233 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005234{
5235 psa_key_slot_t *slot;
5236 psa_status_t status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02005237 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005238 PSA_KEY_USAGE_DERIVE,
5239 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005240 if( status != PSA_SUCCESS )
5241 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02005242 if( slot->attr.type != PSA_KEY_TYPE_DERIVE )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005243 return( PSA_ERROR_INVALID_ARGUMENT );
5244 /* Don't allow a key to be used as an input that is usually public.
5245 * This is debatable. It's ok from a cryptographic perspective to
5246 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005247 * the material should be dedicated to a particular input step,
5248 * otherwise this may allow the key to be used in an unintended way
5249 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005250 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005251 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005252 return( psa_key_derivation_input_internal( operation,
5253 step,
5254 slot->data.raw.data,
5255 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005256}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005257
5258
5259
5260/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005261/* Key agreement */
5262/****************************************************************/
5263
Gilles Peskinea05219c2018-11-16 16:02:56 +01005264#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005265static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5266 size_t peer_key_length,
5267 const mbedtls_ecp_keypair *our_key,
5268 uint8_t *shared_secret,
5269 size_t shared_secret_size,
5270 size_t *shared_secret_length )
5271{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005272 mbedtls_ecp_keypair *their_key = NULL;
5273 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005274 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005275 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005276
Jaeden Ameroccdce902019-01-10 11:42:27 +00005277 status = psa_import_ec_public_key(
5278 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5279 peer_key, peer_key_length,
5280 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005281 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005282 goto exit;
5283
Jaeden Amero97271b32019-01-10 19:38:51 +00005284 status = mbedtls_to_psa_error(
5285 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5286 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005287 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005288 status = mbedtls_to_psa_error(
5289 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5290 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005291 goto exit;
5292
Jaeden Amero97271b32019-01-10 19:38:51 +00005293 status = mbedtls_to_psa_error(
5294 mbedtls_ecdh_calc_secret( &ecdh,
5295 shared_secret_length,
5296 shared_secret, shared_secret_size,
5297 mbedtls_ctr_drbg_random,
5298 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005299
5300exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005301 mbedtls_ecdh_free( &ecdh );
Jaeden Ameroccdce902019-01-10 11:42:27 +00005302 mbedtls_ecp_keypair_free( their_key );
5303 mbedtls_free( their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005304 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005305}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005306#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005307
Gilles Peskine01d718c2018-09-18 12:01:02 +02005308#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5309
Gilles Peskine0216fe12019-04-11 21:23:21 +02005310static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5311 psa_key_slot_t *private_key,
5312 const uint8_t *peer_key,
5313 size_t peer_key_length,
5314 uint8_t *shared_secret,
5315 size_t shared_secret_size,
5316 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005317{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005318 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005319 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005320#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005321 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005322 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005323 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005324 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5325 private_key->data.ecp,
5326 shared_secret, shared_secret_size,
5327 shared_secret_length ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005328#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005329 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005330 (void) private_key;
5331 (void) peer_key;
5332 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005333 (void) shared_secret;
5334 (void) shared_secret_size;
5335 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005336 return( PSA_ERROR_NOT_SUPPORTED );
5337 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005338}
5339
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005340/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005341 * to potentially free embedded data structures and wipe confidential data.
5342 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005343static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005344 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005345 psa_key_slot_t *private_key,
5346 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005347 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005348{
5349 psa_status_t status;
5350 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5351 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005352 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005353
5354 /* Step 1: run the secret agreement algorithm to generate the shared
5355 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005356 status = psa_key_agreement_raw_internal( ka_alg,
5357 private_key,
5358 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005359 shared_secret,
5360 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005361 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005362 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005363 goto exit;
5364
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005365 /* Step 2: set up the key derivation to generate key material from
5366 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005367 status = psa_key_derivation_input_internal( operation, step,
5368 shared_secret,
5369 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005370
Gilles Peskine12313cd2018-06-20 00:20:32 +02005371exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005372 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005373 return( status );
5374}
5375
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005376psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005377 psa_key_derivation_step_t step,
5378 psa_key_handle_t private_key,
5379 const uint8_t *peer_key,
5380 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005381{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005382 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005383 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005384 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005385 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005386 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005387 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005388 if( status != PSA_SUCCESS )
5389 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005390 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005391 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005392 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005393 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005394 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005395 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005396}
5397
Gilles Peskinebe697d82019-05-16 18:00:41 +02005398psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5399 psa_key_handle_t private_key,
5400 const uint8_t *peer_key,
5401 size_t peer_key_length,
5402 uint8_t *output,
5403 size_t output_size,
5404 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005405{
5406 psa_key_slot_t *slot;
5407 psa_status_t status;
5408
5409 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5410 {
5411 status = PSA_ERROR_INVALID_ARGUMENT;
5412 goto exit;
5413 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005414 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005415 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005416 if( status != PSA_SUCCESS )
5417 goto exit;
5418
5419 status = psa_key_agreement_raw_internal( alg, slot,
5420 peer_key, peer_key_length,
5421 output, output_size,
5422 output_length );
5423
5424exit:
5425 if( status != PSA_SUCCESS )
5426 {
5427 /* If an error happens and is not handled properly, the output
5428 * may be used as a key to protect sensitive data. Arrange for such
5429 * a key to be random, which is likely to result in decryption or
5430 * verification errors. This is better than filling the buffer with
5431 * some constant data such as zeros, which would result in the data
5432 * being protected with a reproducible, easily knowable key.
5433 */
5434 psa_generate_random( output, output_size );
5435 *output_length = output_size;
5436 }
5437 return( status );
5438}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005439
5440
5441/****************************************************************/
5442/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005443/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005444
Gilles Peskine4c317f42018-07-12 01:24:09 +02005445psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005446 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005447{
Gilles Peskine4c317f42018-07-12 01:24:09 +02005448 int ret;
5449 GUARD_MODULE_INITIALIZED;
5450
Gilles Peskinef181eca2019-08-07 13:49:00 +02005451 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5452 {
5453 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5454 output,
5455 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5456 if( ret != 0 )
5457 return( mbedtls_to_psa_error( ret ) );
5458 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5459 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5460 }
5461
Gilles Peskinee59236f2018-01-27 23:32:46 +01005462 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5463 return( mbedtls_to_psa_error( ret ) );
5464}
5465
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005466#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5467#include "mbedtls/entropy_poll.h"
5468
Gilles Peskine7228da22019-07-15 11:06:15 +02005469psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005470 size_t seed_size )
5471{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005472 if( global_data.initialized )
5473 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005474
5475 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5476 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5477 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5478 return( PSA_ERROR_INVALID_ARGUMENT );
5479
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005480 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005481}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005482#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005483
Gilles Peskinee56e8782019-04-26 17:34:02 +02005484#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5485static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5486 size_t domain_parameters_size,
5487 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005488{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005489 size_t i;
5490 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005491
Gilles Peskinee56e8782019-04-26 17:34:02 +02005492 if( domain_parameters_size == 0 )
5493 {
5494 *exponent = 65537;
5495 return( PSA_SUCCESS );
5496 }
5497
5498 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5499 * support values that fit in a 32-bit integer, which is larger than
5500 * int on just about every platform anyway. */
5501 if( domain_parameters_size > sizeof( acc ) )
5502 return( PSA_ERROR_NOT_SUPPORTED );
5503 for( i = 0; i < domain_parameters_size; i++ )
5504 acc = ( acc << 8 ) | domain_parameters[i];
5505 if( acc > INT_MAX )
5506 return( PSA_ERROR_NOT_SUPPORTED );
5507 *exponent = acc;
5508 return( PSA_SUCCESS );
5509}
5510#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5511
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005512static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005513 psa_key_slot_t *slot, size_t bits,
5514 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005515{
Gilles Peskine8e338702019-07-30 20:06:31 +02005516 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005517
Gilles Peskinee56e8782019-04-26 17:34:02 +02005518 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005519 return( PSA_ERROR_INVALID_ARGUMENT );
5520
Gilles Peskinee59236f2018-01-27 23:32:46 +01005521 if( key_type_is_raw_bytes( type ) )
5522 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005523 psa_status_t status;
Michael Thomas1d573ec2020-01-21 04:02:54 +00005524 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
5525 if( status != PSA_SUCCESS )
5526 return( status );
5527 status = psa_generate_random( slot->data.raw.data,
Michael Thomasa8ac0162020-01-23 02:55:53 +00005528 slot->data.raw.bytes );
Michael Thomas1d573ec2020-01-21 04:02:54 +00005529 if( status != PSA_SUCCESS )
5530 return( status );
Michael Thomasa8ac0162020-01-23 02:55:53 +00005531#if defined(MBEDTLS_DES_C)
Michael Thomas1d573ec2020-01-21 04:02:54 +00005532 if( type == PSA_KEY_TYPE_DES )
5533 psa_des_set_key_parity( slot->data.raw.data,
5534 slot->data.raw.bytes );
Michael Thomasa8ac0162020-01-23 02:55:53 +00005535#endif /* MBEDTLS_DES_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005536 }
5537 else
5538
5539#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005540 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005541 {
5542 mbedtls_rsa_context *rsa;
5543 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005544 int exponent;
5545 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005546 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5547 return( PSA_ERROR_NOT_SUPPORTED );
5548 /* Accept only byte-aligned keys, for the same reasons as
5549 * in psa_import_rsa_key(). */
5550 if( bits % 8 != 0 )
5551 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005552 status = psa_read_rsa_exponent( domain_parameters,
5553 domain_parameters_size,
5554 &exponent );
5555 if( status != PSA_SUCCESS )
5556 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005557 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5558 if( rsa == NULL )
5559 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5560 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5561 ret = mbedtls_rsa_gen_key( rsa,
5562 mbedtls_ctr_drbg_random,
5563 &global_data.ctr_drbg,
5564 (unsigned int) bits,
5565 exponent );
5566 if( ret != 0 )
5567 {
5568 mbedtls_rsa_free( rsa );
5569 mbedtls_free( rsa );
5570 return( mbedtls_to_psa_error( ret ) );
5571 }
5572 slot->data.rsa = rsa;
5573 }
5574 else
5575#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5576
5577#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005578 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005579 {
5580 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5581 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5582 const mbedtls_ecp_curve_info *curve_info =
5583 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5584 mbedtls_ecp_keypair *ecp;
5585 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005586 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005587 return( PSA_ERROR_NOT_SUPPORTED );
5588 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5589 return( PSA_ERROR_NOT_SUPPORTED );
5590 if( curve_info->bit_size != bits )
5591 return( PSA_ERROR_INVALID_ARGUMENT );
5592 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5593 if( ecp == NULL )
5594 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5595 mbedtls_ecp_keypair_init( ecp );
5596 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5597 mbedtls_ctr_drbg_random,
5598 &global_data.ctr_drbg );
5599 if( ret != 0 )
5600 {
5601 mbedtls_ecp_keypair_free( ecp );
5602 mbedtls_free( ecp );
5603 return( mbedtls_to_psa_error( ret ) );
5604 }
5605 slot->data.ecp = ecp;
5606 }
5607 else
5608#endif /* MBEDTLS_ECP_C */
5609
5610 return( PSA_ERROR_NOT_SUPPORTED );
5611
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005612 return( PSA_SUCCESS );
5613}
Michael Thomas1d573ec2020-01-21 04:02:54 +00005614// The weakly linked function "psa_generate_key_vendor_weak" which returns "PSA_ERROR_NOT_SUPPORTED" will be linked if
5615// the vendor does not provide a definition for "psa_generate_key_vendor"
5616psa_status_t psa_generate_key_vendor( psa_key_slot_t *slot, size_t bits,
5617 const uint8_t *domain_parameters, size_t domain_parameters_size ) __attribute__ ((weak, alias("psa_generate_key_vendor_weak")));
5618psa_status_t psa_generate_key_vendor_weak( psa_key_slot_t *slot, size_t bits,
5619 const uint8_t *domain_parameters, size_t domain_parameters_size );
5620psa_status_t psa_generate_key_vendor_weak( psa_key_slot_t *slot, size_t bits,
5621 const uint8_t *domain_parameters, size_t domain_parameters_size )
5622{
5623 (void) slot;
5624
5625 return PSA_ERROR_NOT_SUPPORTED;
5626}
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005627psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005628 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005629{
5630 psa_status_t status;
5631 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005632 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02005633
Gilles Peskinedf179142019-07-15 22:02:14 +02005634 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
5635 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005636 if( status != PSA_SUCCESS )
5637 goto exit;
5638
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005639#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5640 if( driver != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00005641 {
Gilles Peskine11792082019-08-06 18:36:36 +02005642 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
5643 size_t pubkey_length = 0; /* We don't support this feature yet */
5644 if( drv->key_management == NULL ||
5645 drv->key_management->p_generate == NULL )
5646 {
5647 status = PSA_ERROR_NOT_SUPPORTED;
5648 goto exit;
5649 }
5650 status = drv->key_management->p_generate(
5651 psa_get_se_driver_context( driver ),
5652 slot->data.se.slot_number, attributes,
5653 NULL, 0, &pubkey_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00005654 }
Gilles Peskine11792082019-08-06 18:36:36 +02005655 else
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005656#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Michael Thomas153cd2f2020-01-22 16:54:38 +00005657 if (PSA_KEY_LIFETIME_IS_VENDOR_DEFINED(slot->attr.lifetime))
Michael Thomas1d573ec2020-01-21 04:02:54 +00005658 {
5659 status = psa_generate_key_vendor(slot, attributes->core.bits,
5660 attributes->domain_parameters, attributes->domain_parameters_size);
5661 }
5662 else
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005663 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005664 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005665 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005666 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005667 }
Gilles Peskine11792082019-08-06 18:36:36 +02005668
5669exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005670 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005671 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005672 if( status != PSA_SUCCESS )
5673 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005674 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005675 *handle = 0;
5676 }
Darryl Green0c6575a2018-11-07 16:05:30 +00005677 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005678}
5679
5680
Gilles Peskinee59236f2018-01-27 23:32:46 +01005681
5682/****************************************************************/
5683/* Module setup */
5684/****************************************************************/
5685
Gilles Peskine5e769522018-11-20 21:59:56 +01005686psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5687 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5688 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5689{
5690 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5691 return( PSA_ERROR_BAD_STATE );
5692 global_data.entropy_init = entropy_init;
5693 global_data.entropy_free = entropy_free;
5694 return( PSA_SUCCESS );
5695}
5696
Gilles Peskinee59236f2018-01-27 23:32:46 +01005697void mbedtls_psa_crypto_free( void )
5698{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005699 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005700 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5701 {
5702 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005703 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005704 }
5705 /* Wipe all remaining data, including configuration.
5706 * In particular, this sets all state indicator to the value
5707 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005708 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005709#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005710 /* Unregister all secure element drivers, so that we restart from
5711 * a pristine state. */
5712 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005713#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005714}
5715
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005716#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5717/** Recover a transaction that was interrupted by a power failure.
5718 *
5719 * This function is called during initialization, before psa_crypto_init()
5720 * returns. If this function returns a failure status, the initialization
5721 * fails.
5722 */
5723static psa_status_t psa_crypto_recover_transaction(
5724 const psa_crypto_transaction_t *transaction )
5725{
5726 switch( transaction->unknown.type )
5727 {
5728 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5729 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005730 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005731 * is implemented.
5732 * https://github.com/ARMmbed/mbed-crypto/issues/218
5733 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005734 default:
5735 /* We found an unsupported transaction in the storage.
5736 * We don't know what state the storage is in. Give up. */
5737 return( PSA_ERROR_STORAGE_FAILURE );
5738 }
5739}
5740#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5741
Gilles Peskinee59236f2018-01-27 23:32:46 +01005742psa_status_t psa_crypto_init( void )
5743{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005744 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005745 const unsigned char drbg_seed[] = "PSA";
5746
Gilles Peskinec6b69072018-11-20 21:42:52 +01005747 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005748 if( global_data.initialized != 0 )
5749 return( PSA_SUCCESS );
5750
Gilles Peskine5e769522018-11-20 21:59:56 +01005751 /* Set default configuration if
5752 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5753 if( global_data.entropy_init == NULL )
5754 global_data.entropy_init = mbedtls_entropy_init;
5755 if( global_data.entropy_free == NULL )
5756 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005757
Gilles Peskinec6b69072018-11-20 21:42:52 +01005758 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005759 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01005760#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5761 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5762 /* The PSA entropy injection feature depends on using NV seed as an entropy
5763 * source. Add NV seed as an entropy source for PSA entropy injection. */
5764 mbedtls_entropy_add_source( &global_data.entropy,
5765 mbedtls_nv_seed_poll, NULL,
5766 MBEDTLS_ENTROPY_BLOCK_SIZE,
5767 MBEDTLS_ENTROPY_SOURCE_STRONG );
5768#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01005769 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005770 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005771 status = mbedtls_to_psa_error(
5772 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5773 mbedtls_entropy_func,
5774 &global_data.entropy,
5775 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5776 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005777 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005778 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005779
Gilles Peskine66fb1262018-12-10 16:29:04 +01005780 status = psa_initialize_key_slots( );
5781 if( status != PSA_SUCCESS )
5782 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005783
Gilles Peskine4b734222019-07-24 15:56:31 +02005784#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005785 status = psa_crypto_load_transaction( );
5786 if( status == PSA_SUCCESS )
5787 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005788 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5789 if( status != PSA_SUCCESS )
5790 goto exit;
5791 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005792 }
5793 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5794 {
5795 /* There's no transaction to complete. It's all good. */
5796 status = PSA_SUCCESS;
5797 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005798#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005799
Gilles Peskinec6b69072018-11-20 21:42:52 +01005800 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005801 global_data.initialized = 1;
5802
5803exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005804 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005805 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005806 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005807}
5808
5809#endif /* MBEDTLS_PSA_CRYPTO_C */