blob: 1add7c3872f79a4087153783d7e966bd6a85816b [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.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"
Janos Follath24eed8d2019-11-22 13:21:35 +000078#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010079#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010080#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010081#include "mbedtls/sha1.h"
82#include "mbedtls/sha256.h"
83#include "mbedtls/sha512.h"
84#include "mbedtls/xtea.h"
85
Gilles Peskine996deb12018-08-01 15:45:45 +020086#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
87
Gilles Peskine9ef733f2018-02-07 21:05:37 +010088/* constant-time buffer comparison */
89static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
90{
91 size_t i;
92 unsigned char diff = 0;
93
94 for( i = 0; i < n; i++ )
95 diff |= a[i] ^ b[i];
96
97 return( diff );
98}
99
100
101
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100102/****************************************************************/
103/* Global data, support functions and library management */
104/****************************************************************/
105
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200106static int key_type_is_raw_bytes( psa_key_type_t type )
107{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200108 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200109}
110
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100111/* Values for psa_global_data_t::rng_state */
112#define RNG_NOT_INITIALIZED 0
113#define RNG_INITIALIZED 1
114#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100115
Gilles Peskine2d277862018-06-18 15:41:12 +0200116typedef struct
117{
Gilles Peskine5e769522018-11-20 21:59:56 +0100118 void (* entropy_init )( mbedtls_entropy_context *ctx );
119 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120 mbedtls_entropy_context entropy;
121 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100122 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100123 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100124} psa_global_data_t;
125
126static psa_global_data_t global_data;
127
itayzafrir0adf0fc2018-09-06 16:24:41 +0300128#define GUARD_MODULE_INITIALIZED \
129 if( global_data.initialized == 0 ) \
130 return( PSA_ERROR_BAD_STATE );
131
Steven Cooreman01164162020-07-20 15:31:37 +0200132psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133{
Gilles Peskinea5905292018-02-07 20:59:33 +0100134 /* If there's both a high-level code and low-level code, dispatch on
135 * the high-level code. */
136 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100137 {
138 case 0:
139 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100140
141 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
142 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
143 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
144 return( PSA_ERROR_NOT_SUPPORTED );
145 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
146 return( PSA_ERROR_HARDWARE_FAILURE );
147
148 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
149 return( PSA_ERROR_HARDWARE_FAILURE );
150
Gilles Peskine9a944802018-06-21 09:35:35 +0200151 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
152 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
153 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
154 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
155 case MBEDTLS_ERR_ASN1_INVALID_DATA:
156 return( PSA_ERROR_INVALID_ARGUMENT );
157 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
158 return( PSA_ERROR_INSUFFICIENT_MEMORY );
159 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
160 return( PSA_ERROR_BUFFER_TOO_SMALL );
161
Jaeden Amero93e21112019-02-20 13:57:28 +0000162#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000163 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000164#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
165 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
166#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
168 return( PSA_ERROR_NOT_SUPPORTED );
169 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
170 return( PSA_ERROR_HARDWARE_FAILURE );
171
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000173 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000174#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
175 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
178 return( PSA_ERROR_NOT_SUPPORTED );
179 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
180 return( PSA_ERROR_HARDWARE_FAILURE );
181
182 case MBEDTLS_ERR_CCM_BAD_INPUT:
183 return( PSA_ERROR_INVALID_ARGUMENT );
184 case MBEDTLS_ERR_CCM_AUTH_FAILED:
185 return( PSA_ERROR_INVALID_SIGNATURE );
186 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
187 return( PSA_ERROR_HARDWARE_FAILURE );
188
Gilles Peskine26869f22019-05-06 15:25:00 +0200189 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
190 return( PSA_ERROR_INVALID_ARGUMENT );
191
192 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
193 return( PSA_ERROR_BAD_STATE );
194 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
195 return( PSA_ERROR_INVALID_SIGNATURE );
196
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
198 return( PSA_ERROR_NOT_SUPPORTED );
199 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
200 return( PSA_ERROR_INVALID_ARGUMENT );
201 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
202 return( PSA_ERROR_INSUFFICIENT_MEMORY );
203 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
204 return( PSA_ERROR_INVALID_PADDING );
205 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200206 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
208 return( PSA_ERROR_INVALID_SIGNATURE );
209 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200210 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
212 return( PSA_ERROR_HARDWARE_FAILURE );
213
214 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
215 return( PSA_ERROR_HARDWARE_FAILURE );
216
217 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
218 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
219 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
220 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
223 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
224
225 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
226 return( PSA_ERROR_NOT_SUPPORTED );
227 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
228 return( PSA_ERROR_HARDWARE_FAILURE );
229
Gilles Peskinee59236f2018-01-27 23:32:46 +0100230 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
231 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
232 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
233 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100234
235 case MBEDTLS_ERR_GCM_AUTH_FAILED:
236 return( PSA_ERROR_INVALID_SIGNATURE );
237 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200238 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100239 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
240 return( PSA_ERROR_HARDWARE_FAILURE );
241
242 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
243 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
244 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
245 return( PSA_ERROR_HARDWARE_FAILURE );
246
247 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
248 return( PSA_ERROR_NOT_SUPPORTED );
249 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_MD_ALLOC_FAILED:
252 return( PSA_ERROR_INSUFFICIENT_MEMORY );
253 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
254 return( PSA_ERROR_STORAGE_FAILURE );
255 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
256 return( PSA_ERROR_HARDWARE_FAILURE );
257
Gilles Peskinef76aa772018-10-29 19:24:33 +0100258 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
259 return( PSA_ERROR_STORAGE_FAILURE );
260 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
261 return( PSA_ERROR_INVALID_ARGUMENT );
262 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
265 return( PSA_ERROR_BUFFER_TOO_SMALL );
266 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
269 return( PSA_ERROR_INVALID_ARGUMENT );
270 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
271 return( PSA_ERROR_INVALID_ARGUMENT );
272 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
274
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100275 case MBEDTLS_ERR_PK_ALLOC_FAILED:
276 return( PSA_ERROR_INSUFFICIENT_MEMORY );
277 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
278 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
279 return( PSA_ERROR_INVALID_ARGUMENT );
280 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100281 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100282 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
283 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
286 return( PSA_ERROR_NOT_SUPPORTED );
287 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
288 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
289 return( PSA_ERROR_NOT_PERMITTED );
290 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
291 return( PSA_ERROR_INVALID_ARGUMENT );
292 case MBEDTLS_ERR_PK_INVALID_ALG:
293 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
294 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
295 return( PSA_ERROR_NOT_SUPPORTED );
296 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
297 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100298 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
299 return( PSA_ERROR_HARDWARE_FAILURE );
300
Gilles Peskineff2d2002019-05-06 15:26:23 +0200301 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
302 return( PSA_ERROR_HARDWARE_FAILURE );
303 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
304 return( PSA_ERROR_NOT_SUPPORTED );
305
Gilles Peskinea5905292018-02-07 20:59:33 +0100306 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
307 return( PSA_ERROR_HARDWARE_FAILURE );
308
309 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
310 return( PSA_ERROR_INVALID_ARGUMENT );
311 case MBEDTLS_ERR_RSA_INVALID_PADDING:
312 return( PSA_ERROR_INVALID_PADDING );
313 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
314 return( PSA_ERROR_HARDWARE_FAILURE );
315 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
316 return( PSA_ERROR_INVALID_ARGUMENT );
317 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
318 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200319 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
321 return( PSA_ERROR_INVALID_SIGNATURE );
322 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
323 return( PSA_ERROR_BUFFER_TOO_SMALL );
324 case MBEDTLS_ERR_RSA_RNG_FAILED:
325 return( PSA_ERROR_INSUFFICIENT_MEMORY );
326 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
327 return( PSA_ERROR_NOT_SUPPORTED );
328 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
329 return( PSA_ERROR_HARDWARE_FAILURE );
330
331 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
332 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
333 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
334 return( PSA_ERROR_HARDWARE_FAILURE );
335
336 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
337 return( PSA_ERROR_INVALID_ARGUMENT );
338 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
339 return( PSA_ERROR_HARDWARE_FAILURE );
340
itayzafrir5c753392018-05-08 11:18:38 +0300341 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300342 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300343 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
345 return( PSA_ERROR_BUFFER_TOO_SMALL );
346 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
347 return( PSA_ERROR_NOT_SUPPORTED );
348 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
349 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
350 return( PSA_ERROR_INVALID_SIGNATURE );
351 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
352 return( PSA_ERROR_INSUFFICIENT_MEMORY );
353 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
354 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000355 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
356 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300357
Gilles Peskinee59236f2018-01-27 23:32:46 +0100358 default:
David Saadab4ecc272019-02-14 13:48:10 +0200359 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100360 }
361}
362
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200363
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200364
365
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100366/****************************************************************/
367/* Key management */
368/****************************************************************/
369
Gilles Peskine73167e12019-07-12 23:44:37 +0200370#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
371static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
372{
Gilles Peskine8e338702019-07-30 20:06:31 +0200373 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200374}
375#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
376
John Durkop07cc04a2020-11-16 22:08:34 -0800377/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
378 * current test driver in key_management.c is using this function
379 * when accelerators are used for ECC key pair and public key.
380 * Once that dependency is resolved these guards can be removed.
381 */
John Durkop9814fa22020-11-04 12:28:15 -0800382#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800383 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
384 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
385 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100386mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100387 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200388{
389 switch( curve )
390 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100391 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 switch( byte_length )
393 {
394 case PSA_BITS_TO_BYTES( 192 ):
395 return( MBEDTLS_ECP_DP_SECP192R1 );
396 case PSA_BITS_TO_BYTES( 224 ):
397 return( MBEDTLS_ECP_DP_SECP224R1 );
398 case PSA_BITS_TO_BYTES( 256 ):
399 return( MBEDTLS_ECP_DP_SECP256R1 );
400 case PSA_BITS_TO_BYTES( 384 ):
401 return( MBEDTLS_ECP_DP_SECP384R1 );
402 case PSA_BITS_TO_BYTES( 521 ):
403 return( MBEDTLS_ECP_DP_SECP521R1 );
404 default:
405 return( MBEDTLS_ECP_DP_NONE );
406 }
407 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100408
Paul Elliott8ff510a2020-06-02 17:19:28 +0100409 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 switch( byte_length )
411 {
412 case PSA_BITS_TO_BYTES( 256 ):
413 return( MBEDTLS_ECP_DP_BP256R1 );
414 case PSA_BITS_TO_BYTES( 384 ):
415 return( MBEDTLS_ECP_DP_BP384R1 );
416 case PSA_BITS_TO_BYTES( 512 ):
417 return( MBEDTLS_ECP_DP_BP512R1 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 255 ):
427 return( MBEDTLS_ECP_DP_CURVE25519 );
428 case PSA_BITS_TO_BYTES( 448 ):
429 return( MBEDTLS_ECP_DP_CURVE448 );
430 default:
431 return( MBEDTLS_ECP_DP_NONE );
432 }
433 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100434
Paul Elliott8ff510a2020-06-02 17:19:28 +0100435 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100436 switch( byte_length )
437 {
438 case PSA_BITS_TO_BYTES( 192 ):
439 return( MBEDTLS_ECP_DP_SECP192K1 );
440 case PSA_BITS_TO_BYTES( 224 ):
441 return( MBEDTLS_ECP_DP_SECP224K1 );
442 case PSA_BITS_TO_BYTES( 256 ):
443 return( MBEDTLS_ECP_DP_SECP256K1 );
444 default:
445 return( MBEDTLS_ECP_DP_NONE );
446 }
447 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100448
Gilles Peskine12313cd2018-06-20 00:20:32 +0200449 default:
450 return( MBEDTLS_ECP_DP_NONE );
451 }
452}
John Durkop9814fa22020-11-04 12:28:15 -0800453#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800454 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
455 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
456 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200457
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200458static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
459 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200460{
461 /* Check that the bit size is acceptable for the key type */
462 switch( type )
463 {
464 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200465 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200466 case PSA_KEY_TYPE_DERIVE:
467 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200468#if defined(MBEDTLS_AES_C)
469 case PSA_KEY_TYPE_AES:
470 if( bits != 128 && bits != 192 && bits != 256 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
472 break;
473#endif
474#if defined(MBEDTLS_CAMELLIA_C)
475 case PSA_KEY_TYPE_CAMELLIA:
476 if( bits != 128 && bits != 192 && bits != 256 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
478 break;
479#endif
480#if defined(MBEDTLS_DES_C)
481 case PSA_KEY_TYPE_DES:
482 if( bits != 64 && bits != 128 && bits != 192 )
483 return( PSA_ERROR_INVALID_ARGUMENT );
484 break;
485#endif
486#if defined(MBEDTLS_ARC4_C)
487 case PSA_KEY_TYPE_ARC4:
488 if( bits < 8 || bits > 2048 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
490 break;
491#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200492#if defined(MBEDTLS_CHACHA20_C)
493 case PSA_KEY_TYPE_CHACHA20:
494 if( bits != 256 )
495 return( PSA_ERROR_INVALID_ARGUMENT );
496 break;
497#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200498 default:
499 return( PSA_ERROR_NOT_SUPPORTED );
500 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200501 if( bits % 8 != 0 )
502 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200503
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200504 return( PSA_SUCCESS );
505}
506
John Durkop0e005192020-10-31 22:06:54 -0700507#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
508 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
509 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
John Durkop9814fa22020-11-04 12:28:15 -0800510 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
511 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
512 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooremana01795d2020-07-24 22:48:15 +0200513
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
Steven Cooreman7f391872020-07-30 14:57:44 +0200536/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200538 * \param[in] type The type of key contained in \p data.
539 * \param[in] data The buffer from which to load the representation.
540 * \param[in] data_length The size in bytes of \p data.
541 * \param[out] p_rsa Returns a pointer to an RSA context on success.
542 * The caller is responsible for freeing both the
543 * contents of the context and the context itself
544 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200545 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200546static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
547 const uint8_t *data,
548 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200549 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200550{
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000551 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200552 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000553 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200554 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555
556 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200557 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200559 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200560 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000561 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200562 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( status != PSA_SUCCESS )
564 goto exit;
565
566 /* We have something that the pkparse module recognizes. If it is a
567 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200569 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000570 status = PSA_ERROR_INVALID_ARGUMENT;
571 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200572 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000573
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000574 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
575 * supports non-byte-aligned key sizes, but not well. For example,
576 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200577 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000578 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
579 {
580 status = PSA_ERROR_NOT_SUPPORTED;
581 goto exit;
582 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200583 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 if( status != PSA_SUCCESS )
585 goto exit;
586
Steven Cooremana2371e52020-07-28 14:30:39 +0200587 /* Copy out the pointer to the RSA context, and reset the PK context
588 * such that pk_free doesn't free the RSA context we just grabbed. */
589 *p_rsa = mbedtls_pk_rsa( ctx );
590 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000591
592exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200593 mbedtls_pk_free( &ctx );
594 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +0200595}
596
John Durkop6ba40d12020-11-10 08:50:04 -0800597#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
598 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
599 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
600 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
601 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
602 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
603
604#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
605 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
606
Steven Cooremana01795d2020-07-24 22:48:15 +0200607/** Export an RSA key to export representation
608 *
609 * \param[in] type The type of key (public/private) to export
610 * \param[in] rsa The internal RSA representation from which to export
611 * \param[out] data The buffer to export to
612 * \param[in] data_size The length of the buffer to export to
613 * \param[out] data_length The amount of bytes written to \p data
614 */
615static psa_status_t psa_export_rsa_key( psa_key_type_t type,
616 mbedtls_rsa_context *rsa,
617 uint8_t *data,
618 size_t data_size,
619 size_t *data_length )
620{
621#if defined(MBEDTLS_PK_WRITE_C)
622 int ret;
623 mbedtls_pk_context pk;
624 uint8_t *pos = data + data_size;
625
626 mbedtls_pk_init( &pk );
627 pk.pk_info = &mbedtls_rsa_info;
628 pk.pk_ctx = rsa;
629
630 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200631 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
632 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200633 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
634 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
635 else
636 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
637
638 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200639 {
640 /* Clean up in case pk_write failed halfway through. */
641 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200642 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200643 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200644
645 /* The mbedtls_pk_xxx functions write to the end of the buffer.
646 * Move the data to the beginning and erase remaining data
647 * at the original location. */
648 if( 2 * (size_t) ret <= data_size )
649 {
650 memcpy( data, data + data_size - ret, ret );
651 memset( data + data_size - ret, 0, ret );
652 }
653 else if( (size_t) ret < data_size )
654 {
655 memmove( data, data + data_size - ret, ret );
656 memset( data + ret, 0, data_size - ret );
657 }
658
659 *data_length = ret;
660 return( PSA_SUCCESS );
661#else
662 (void) type;
663 (void) rsa;
664 (void) data;
665 (void) data_size;
666 (void) data_length;
667 return( PSA_ERROR_NOT_SUPPORTED );
668#endif /* MBEDTLS_PK_WRITE_C */
669}
670
671/** Import an RSA key from import representation to a slot
672 *
673 * \param[in,out] slot The slot where to store the export representation to
674 * \param[in] data The buffer containing the import representation
675 * \param[in] data_length The amount of bytes in \p data
676 */
677static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
678 const uint8_t *data,
679 size_t data_length )
680{
681 psa_status_t status;
682 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200683 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200684
Steven Cooremana01795d2020-07-24 22:48:15 +0200685 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200686 status = psa_load_rsa_representation( slot->attr.type,
687 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200688 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200689 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200690 if( status != PSA_SUCCESS )
691 goto exit;
692
693 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200694 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200695
Steven Cooreman75b74362020-07-28 14:30:13 +0200696 /* Re-export the data to PSA export format, such that we can store export
697 * representation in the key slot. Export representation in case of RSA is
698 * the smallest representation that's allowed as input, so a straight-up
699 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200700 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200701 if( output == NULL )
702 {
703 status = PSA_ERROR_INSUFFICIENT_MEMORY;
704 goto exit;
705 }
706
Steven Cooremana01795d2020-07-24 22:48:15 +0200707 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200708 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200709 output,
710 data_length,
711 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200712exit:
713 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200714 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200715 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200716
717 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000718 if( status != PSA_SUCCESS )
719 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200720 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000721 return( status );
722 }
723
Steven Cooremana01795d2020-07-24 22:48:15 +0200724 /* On success, store the allocated export-formatted key. */
725 slot->data.key.data = output;
726 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000727
728 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200729}
John Durkop6ba40d12020-11-10 08:50:04 -0800730
731#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -0800732 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200733
John Durkop9814fa22020-11-04 12:28:15 -0800734#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800735 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
736 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
737 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) || \
738 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Steven Cooreman7f391872020-07-30 14:57:44 +0200739/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200740 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200741 * \param[in] type The type of key contained in \p data.
742 * \param[in] data The buffer from which to load the representation.
743 * \param[in] data_length The size in bytes of \p data.
744 * \param[out] p_ecp Returns a pointer to an ECP context on success.
745 * The caller is responsible for freeing both the
746 * contents of the context and the context itself
747 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200748 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200749static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
750 const uint8_t *data,
751 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200752 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100753{
754 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200755 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200756 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200757 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100758
Steven Cooreman4fed4552020-08-03 14:46:03 +0200759 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
760 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100761 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200762 /* A Weierstrass public key is represented as:
763 * - The byte 0x04;
764 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
765 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200766 * So its data length is 2m+1 where m is the curve size in bits.
Steven Cooreman4fed4552020-08-03 14:46:03 +0200767 */
768 if( ( data_length & 1 ) == 0 )
769 return( PSA_ERROR_INVALID_ARGUMENT );
770 curve_size = data_length / 2;
771
772 /* Montgomery public keys are represented in compressed format, meaning
773 * their curve_size is equal to the amount of input. */
774
775 /* Private keys are represented in uncompressed private random integer
776 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100777 }
778
Steven Cooreman6d839f02020-07-30 11:36:45 +0200779 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200780 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200781 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200782 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200783 mbedtls_ecp_keypair_init( ecp );
784
Gilles Peskine4cd32772019-12-02 20:49:42 +0100785 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200786 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
787 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100788 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200789 {
790 status = PSA_ERROR_INVALID_ARGUMENT;
791 goto exit;
792 }
793
Steven Cooremanacda8342020-07-24 23:09:52 +0200794 status = mbedtls_to_psa_error(
795 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
796 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200797 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200798
Steven Cooreman6d839f02020-07-30 11:36:45 +0200799 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200800 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200801 {
802 /* Load the public value. */
803 status = mbedtls_to_psa_error(
804 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200805 data,
806 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200807 if( status != PSA_SUCCESS )
808 goto exit;
809
810 /* Check that the point is on the curve. */
811 status = mbedtls_to_psa_error(
812 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
813 if( status != PSA_SUCCESS )
814 goto exit;
815 }
816 else
817 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200818 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200819 status = mbedtls_to_psa_error(
820 mbedtls_ecp_read_key( ecp->grp.id,
821 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200822 data,
823 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200824 if( status != PSA_SUCCESS )
825 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200826 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200827
828 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200829exit:
830 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200831 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200832 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200833 mbedtls_free( ecp );
834 }
835
Steven Cooreman29149862020-08-05 15:43:42 +0200836 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100837}
John Durkop6ba40d12020-11-10 08:50:04 -0800838#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
839 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
840 * defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
841 * defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) ||
842 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Jaeden Ameroccdce902019-01-10 11:42:27 +0000843
John Durkop6ba40d12020-11-10 08:50:04 -0800844#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
845 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman4fed4552020-08-03 14:46:03 +0200846/** Export an ECP key to export representation
847 *
848 * \param[in] type The type of key (public/private) to export
849 * \param[in] ecp The internal ECP representation from which to export
850 * \param[out] data The buffer to export to
851 * \param[in] data_size The length of the buffer to export to
852 * \param[out] data_length The amount of bytes written to \p data
853 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200854static psa_status_t psa_export_ecp_key( psa_key_type_t type,
855 mbedtls_ecp_keypair *ecp,
856 uint8_t *data,
857 size_t data_size,
858 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200859{
Steven Cooremanacda8342020-07-24 23:09:52 +0200860 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000861
Steven Cooremanacda8342020-07-24 23:09:52 +0200862 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200863 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 /* Check whether the public part is loaded */
865 if( mbedtls_ecp_is_zero( &ecp->Q ) )
866 {
867 /* Calculate the public key */
868 status = mbedtls_to_psa_error(
869 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
870 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
871 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200872 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200873 }
874
Steven Cooreman4fed4552020-08-03 14:46:03 +0200875 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200876 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
877 MBEDTLS_ECP_PF_UNCOMPRESSED,
878 data_length,
879 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200880 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200881 if( status != PSA_SUCCESS )
882 memset( data, 0, data_size );
883
Steven Cooreman29149862020-08-05 15:43:42 +0200884 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200885 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200886 else
887 {
Steven Cooreman29149862020-08-05 15:43:42 +0200888 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200889 return( PSA_ERROR_BUFFER_TOO_SMALL );
890
891 status = mbedtls_to_psa_error(
892 mbedtls_ecp_write_key( ecp,
893 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200894 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200896 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200897 else
898 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200899
900 return( status );
901 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200902}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200903
Steven Cooreman4fed4552020-08-03 14:46:03 +0200904/** Import an ECP key from import representation to a slot
905 *
906 * \param[in,out] slot The slot where to store the export representation to
907 * \param[in] data The buffer containing the import representation
908 * \param[in] data_length The amount of bytes in \p data
909 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200910static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
911 const uint8_t *data,
912 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100913{
Steven Cooremanacda8342020-07-24 23:09:52 +0200914 psa_status_t status;
915 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100917
Steven Cooremanacda8342020-07-24 23:09:52 +0200918 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200919 status = psa_load_ecp_representation( slot->attr.type,
920 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200921 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200922 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100923 if( status != PSA_SUCCESS )
924 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100925
Steven Cooremanacda8342020-07-24 23:09:52 +0200926 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200927 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200928 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200929 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200930
Steven Cooremanacda8342020-07-24 23:09:52 +0200931 /* Re-export the data to PSA export format. There is currently no support
932 * for other input formats then the export format, so this is a 1-1
933 * copy operation. */
934 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200935 if( output == NULL )
936 {
937 status = PSA_ERROR_INSUFFICIENT_MEMORY;
938 goto exit;
939 }
940
941 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200942 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200943 output,
944 data_length,
945 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100946exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200947 /* Always free the PK object (will also free contained ECP context) */
948 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200949 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200950
951 /* Free the allocated buffer only on error. */
952 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100953 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200954 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200955 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100956 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200957
958 /* On success, store the allocated export-formatted key. */
959 slot->data.key.data = output;
960 slot->data.key.bytes = data_length;
961
962 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100963}
John Durkop9814fa22020-11-04 12:28:15 -0800964#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
965 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskinef76aa772018-10-29 19:24:33 +0100966
Gilles Peskineb46bef22019-07-30 21:32:04 +0200967/** Return the size of the key in the given slot, in bits.
968 *
969 * \param[in] slot A key slot.
970 *
971 * \return The key size in bits, read from the metadata in the slot.
972 */
973static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
974{
975 return( slot->attr.bits );
976}
977
Steven Cooreman75b74362020-07-28 14:30:13 +0200978/** Try to allocate a buffer to an empty key slot.
979 *
980 * \param[in,out] slot Key slot to attach buffer to.
981 * \param[in] buffer_length Requested size of the buffer.
982 *
983 * \retval #PSA_SUCCESS
984 * The buffer has been successfully allocated.
985 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
986 * Not enough memory was available for allocation.
987 * \retval #PSA_ERROR_ALREADY_EXISTS
988 * Trying to allocate a buffer to a non-empty key slot.
989 */
990static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
991 size_t buffer_length )
992{
993 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200994 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200995
996 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
997 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200998 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200999
1000 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +02001001 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +02001002}
1003
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001004psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
1005 const uint8_t* data,
1006 size_t data_length )
1007{
1008 psa_status_t status = psa_allocate_buffer_to_slot( slot,
1009 data_length );
1010 if( status != PSA_SUCCESS )
1011 return( status );
1012
1013 memcpy( slot->data.key.data, data, data_length );
1014 return( PSA_SUCCESS );
1015}
1016
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001017/** Import key data into a slot.
1018 *
1019 * `slot->type` must have been set previously.
1020 * This function assumes that the slot does not contain any key material yet.
1021 * On failure, the slot content is unchanged.
1022 *
1023 * Persistent storage is not affected.
1024 *
1025 * \param[in,out] slot The key slot to import data into.
1026 * Its `type` field must have previously been set to
1027 * the desired key type.
1028 * It must not contain any key material yet.
1029 * \param[in] data Buffer containing the key material to parse and import.
1030 * \param data_length Size of \p data in bytes.
1031 *
1032 * \retval #PSA_SUCCESS
1033 * \retval #PSA_ERROR_INVALID_ARGUMENT
1034 * \retval #PSA_ERROR_NOT_SUPPORTED
1035 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1036 */
1037static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
1038 const uint8_t *data,
1039 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040{
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001041 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +02001042 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001043
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001044 /* zero-length keys are never supported. */
1045 if( data_length == 0 )
1046 return( PSA_ERROR_NOT_SUPPORTED );
1047
Gilles Peskine8e338702019-07-30 20:06:31 +02001048 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001049 {
Steven Cooreman04524762020-10-13 17:43:44 +02001050 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001051
Steven Cooreman75b74362020-07-28 14:30:13 +02001052 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1053 if( data_length > SIZE_MAX / 8 )
1054 return( PSA_ERROR_NOT_SUPPORTED );
1055
Gilles Peskine1b9505c2019-08-07 10:59:45 +02001056 /* Enforce a size limit, and in particular ensure that the bit
1057 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +02001058 if( bit_size > PSA_MAX_KEY_BITS )
1059 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001060
1061 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001062 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001063 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001064
1065 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001066 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +02001067 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001068 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001069
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001070 /* Write the actual key size to the slot.
1071 * psa_start_key_creation() wrote the size declared by the
1072 * caller, which may be 0 (meaning unspecified) or wrong. */
1073 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +01001074
1075 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001076 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001077 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +02001078 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001079 /* Try validation through accelerators first. */
1080 bit_size = slot->attr.bits;
1081 psa_key_attributes_t attributes = {
1082 .core = slot->attr
1083 };
1084 status = psa_driver_wrapper_validate_key( &attributes,
1085 data,
1086 data_length,
1087 &bit_size );
1088 if( status == PSA_SUCCESS )
1089 {
1090 /* Key has been validated successfully by an accelerator.
1091 * Copy key material into slot. */
1092 status = psa_copy_key_material_into_slot( slot, data, data_length );
1093 if( status != PSA_SUCCESS )
1094 return( status );
1095
1096 slot->attr.bits = (psa_key_bits_t) bit_size;
1097 return( PSA_SUCCESS );
1098 }
1099 else if( status != PSA_ERROR_NOT_SUPPORTED )
1100 return( status );
1101
1102 /* Key format is not supported by any accelerator, try software fallback
1103 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -08001104#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1105 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001106 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1107 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001108 return( psa_import_ecp_key( slot, data, data_length ) );
1109 }
John Durkop9814fa22020-11-04 12:28:15 -08001110#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1111 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -07001112#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1113 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +01001114 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001115 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001116 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001117 }
John Durkop9814fa22020-11-04 12:28:15 -08001118#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1119 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +01001120
1121 /* Fell through the fallback as well, so have nothing else to try. */
1122 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001123 }
1124 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001125 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001126 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001127 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001128 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001129}
1130
Gilles Peskinef603c712019-01-19 13:40:11 +01001131/** Calculate the intersection of two algorithm usage policies.
1132 *
1133 * Return 0 (which allows no operation) on incompatibility.
1134 */
1135static psa_algorithm_t psa_key_policy_algorithm_intersection(
1136 psa_algorithm_t alg1,
1137 psa_algorithm_t alg2 )
1138{
Gilles Peskine549ea862019-05-22 11:45:59 +02001139 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001140 if( alg1 == alg2 )
1141 return( alg1 );
1142 /* If the policies are from the same hash-and-sign family, check
1143 * if one is a wildcard. If so the other has the specific algorithm. */
1144 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1145 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1146 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1147 {
1148 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1149 return( alg2 );
1150 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1151 return( alg1 );
1152 }
1153 /* If the policies are incompatible, allow nothing. */
1154 return( 0 );
1155}
1156
Gilles Peskined6f371b2019-05-10 19:33:38 +02001157static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1158 psa_algorithm_t requested_alg )
1159{
Gilles Peskine549ea862019-05-22 11:45:59 +02001160 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001161 if( requested_alg == policy_alg )
1162 return( 1 );
1163 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001164 * and requested_alg is the same hash-and-sign family with any hash,
1165 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001166 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1167 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1168 {
1169 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1170 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1171 }
Steven Cooremance48e852020-10-05 16:02:45 +02001172 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001173 * a key derivation with that key agreement should also be allowed. This
1174 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001175 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1176 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1177 {
1178 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1179 policy_alg );
1180 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001181 /* If it isn't permitted, it's forbidden. */
1182 return( 0 );
1183}
1184
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001185/** Test whether a policy permits an algorithm.
1186 *
1187 * The caller must test usage flags separately.
1188 */
1189static int psa_key_policy_permits( const psa_key_policy_t *policy,
1190 psa_algorithm_t alg )
1191{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001192 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1193 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001194}
1195
Gilles Peskinef603c712019-01-19 13:40:11 +01001196/** Restrict a key policy based on a constraint.
1197 *
1198 * \param[in,out] policy The policy to restrict.
1199 * \param[in] constraint The policy constraint to apply.
1200 *
1201 * \retval #PSA_SUCCESS
1202 * \c *policy contains the intersection of the original value of
1203 * \c *policy and \c *constraint.
1204 * \retval #PSA_ERROR_INVALID_ARGUMENT
1205 * \c *policy and \c *constraint are incompatible.
1206 * \c *policy is unchanged.
1207 */
1208static psa_status_t psa_restrict_key_policy(
1209 psa_key_policy_t *policy,
1210 const psa_key_policy_t *constraint )
1211{
1212 psa_algorithm_t intersection_alg =
1213 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001214 psa_algorithm_t intersection_alg2 =
1215 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001216 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1217 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001218 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1219 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001220 policy->usage &= constraint->usage;
1221 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001222 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001223 return( PSA_SUCCESS );
1224}
1225
Ronald Cron5c522922020-11-14 16:35:34 +01001226/** Get the description of a key given its identifier and policy constraints
1227 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001228 *
Ronald Cron5c522922020-11-14 16:35:34 +01001229 * The key must have allow all the usage flags set in \p usage. If \p alg is
1230 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +01001231 *
Ronald Cron5c522922020-11-14 16:35:34 +01001232 * In case of a persistent key, the function loads the description of the key
1233 * into a key slot if not already done.
1234 *
1235 * On success, the returned key slot is locked. It is the responsibility of
1236 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001237 */
Ronald Cron5c522922020-11-14 16:35:34 +01001238static psa_status_t psa_get_and_lock_key_slot_with_policy(
1239 mbedtls_svc_key_id_t key,
1240 psa_key_slot_t **p_slot,
1241 psa_key_usage_t usage,
1242 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +01001243{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1245 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001246
Ronald Cron5c522922020-11-14 16:35:34 +01001247 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001248 if( status != PSA_SUCCESS )
1249 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001250 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001251
1252 /* Enforce that usage policy for the key slot contains all the flags
1253 * required by the usage parameter. There is one exception: public
1254 * keys can always be exported, so we treat public key objects as
1255 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001256 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001257 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001258
1259 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +02001260 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001261 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001262
1263 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001264 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001265 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +01001266
Darryl Green06fd18d2018-07-16 11:21:11 +01001267 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001268
1269error:
1270 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001271 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001272
1273 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001274}
Darryl Green940d72c2018-07-13 13:18:51 +01001275
Ronald Cron5c522922020-11-14 16:35:34 +01001276/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001277 *
1278 * A transparent key is a key for which the key material is directly
1279 * available, as opposed to a key in a secure element.
1280 *
Ronald Cron5c522922020-11-14 16:35:34 +01001281 * This is a temporary function to use instead of
1282 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1283 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001284 *
Ronald Cron5c522922020-11-14 16:35:34 +01001285 * On success, the returned key slot is locked. It is the responsibility of the
1286 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001287 */
1288#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001289static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1290 mbedtls_svc_key_id_t key,
1291 psa_key_slot_t **p_slot,
1292 psa_key_usage_t usage,
1293 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001294{
Ronald Cron5c522922020-11-14 16:35:34 +01001295 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1296 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001297 if( status != PSA_SUCCESS )
1298 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001299
Gilles Peskineadad8132019-07-25 11:31:23 +02001300 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001301 {
Ronald Cron5c522922020-11-14 16:35:34 +01001302 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001303 *p_slot = NULL;
1304 return( PSA_ERROR_NOT_SUPPORTED );
1305 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001306
Gilles Peskine28f8f302019-07-24 13:30:31 +02001307 return( PSA_SUCCESS );
1308}
1309#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1310/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001311#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1312 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001313#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1314
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001315/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001316static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001317{
Gilles Peskine73167e12019-07-12 23:44:37 +02001318#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1319 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001320 {
1321 /* No key material to clean. */
1322 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001323 else
1324#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001325 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001326 /* Data pointer will always be either a valid pointer or NULL in an
1327 * initialized slot, so we can just free it. */
1328 if( slot->data.key.data != NULL )
1329 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001330 mbedtls_free( slot->data.key.data );
1331 slot->data.key.data = NULL;
1332 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001333 }
Darryl Green40225ba2018-11-15 14:48:15 +00001334
1335 return( PSA_SUCCESS );
1336}
1337
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001338/** Completely wipe a slot in memory, including its policy.
1339 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001340psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001341{
1342 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001343
1344 /*
1345 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001346 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001347 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1348 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001349 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001350 */
Ronald Cron5c522922020-11-14 16:35:34 +01001351 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001352 {
1353#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001354 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001355#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001356 status = PSA_ERROR_CORRUPTION_DETECTED;
1357 }
1358
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001359 /* Multipart operations may still be using the key. This is safe
1360 * because all multipart operation objects are independent from
1361 * the key slot: if they need to access the key after the setup
1362 * phase, they have a copy of the key. Note that this means that
1363 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001364 /* At this point, key material and other type-specific content has
1365 * been wiped. Clear remaining metadata. We can call memset and not
1366 * zeroize because the metadata is not particularly sensitive. */
1367 memset( slot, 0, sizeof( *slot ) );
1368 return( status );
1369}
1370
Ronald Croncf56a0a2020-08-04 09:51:30 +02001371psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001372{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001373 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001374 psa_status_t status; /* status of the last operation */
1375 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001376#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1377 psa_se_drv_table_entry_t *driver;
1378#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001379
Ronald Croncf56a0a2020-08-04 09:51:30 +02001380 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001381 return( PSA_SUCCESS );
1382
Ronald Cronf2911112020-10-29 17:51:10 +01001383 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001384 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001385 * key, this will load the key description from persistent memory if not
1386 * done yet. We cannot avoid this loading as without it we don't know if
1387 * the key is operated by an SE or not and this information is needed by
1388 * the current implementation.
1389 */
Ronald Cron5c522922020-11-14 16:35:34 +01001390 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001391 if( status != PSA_SUCCESS )
1392 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001393
Ronald Cronf2911112020-10-29 17:51:10 +01001394 /*
1395 * If the key slot containing the key description is under access by the
1396 * library (apart from the present access), the key cannot be destroyed
1397 * yet. For the time being, just return in error. Eventually (to be
1398 * implemented), the key should be destroyed when all accesses have
1399 * stopped.
1400 */
Ronald Cron5c522922020-11-14 16:35:34 +01001401 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001402 {
Ronald Cron5c522922020-11-14 16:35:34 +01001403 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001404 return( PSA_ERROR_GENERIC_ERROR );
1405 }
1406
Gilles Peskine354f7672019-07-12 23:46:38 +02001407#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001408 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001409 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001410 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001411 /* For a key in a secure element, we need to do three things:
1412 * remove the key file in internal storage, destroy the
1413 * key inside the secure element, and update the driver's
1414 * persistent data. Start a transaction that will encompass these
1415 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001416 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001417 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001418 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001419 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001420 status = psa_crypto_save_transaction( );
1421 if( status != PSA_SUCCESS )
1422 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001423 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001424 /* We should still try to destroy the key in the secure
1425 * element and the key metadata in storage. This is especially
1426 * important if the error is that the storage is full.
1427 * But how to do it exactly without risking an inconsistent
1428 * state after a reset?
1429 * https://github.com/ARMmbed/mbed-crypto/issues/215
1430 */
1431 overall_status = status;
1432 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001433 }
1434
Gilles Peskine354f7672019-07-12 23:46:38 +02001435 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001436 if( overall_status == PSA_SUCCESS )
1437 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001438 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001439#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1440
Darryl Greend49a4992018-06-18 17:27:26 +01001441#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001442 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001443 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001444 status = psa_destroy_persistent_key( slot->attr.id );
1445 if( overall_status == PSA_SUCCESS )
1446 overall_status = status;
1447
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001448 /* TODO: other slots may have a copy of the same key. We should
1449 * invalidate them.
1450 * https://github.com/ARMmbed/mbed-crypto/issues/214
1451 */
Darryl Greend49a4992018-06-18 17:27:26 +01001452 }
1453#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001454
Gilles Peskinefc762652019-07-22 19:30:34 +02001455#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1456 if( driver != NULL )
1457 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001458 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001459 if( overall_status == PSA_SUCCESS )
1460 overall_status = status;
1461 status = psa_crypto_stop_transaction( );
1462 if( overall_status == PSA_SUCCESS )
1463 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001464 }
1465#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1466
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001467#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1468exit:
1469#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001470 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001471 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1472 if( overall_status == PSA_SUCCESS )
1473 overall_status = status;
1474 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001475}
1476
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001477void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001478{
Gilles Peskineb699f072019-04-26 16:06:02 +02001479 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001480 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001481}
1482
Gilles Peskineb699f072019-04-26 16:06:02 +02001483psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1484 psa_key_type_t type,
1485 const uint8_t *data,
1486 size_t data_length )
1487{
1488 uint8_t *copy = NULL;
1489
1490 if( data_length != 0 )
1491 {
1492 copy = mbedtls_calloc( 1, data_length );
1493 if( copy == NULL )
1494 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1495 memcpy( copy, data, data_length );
1496 }
1497 /* After this point, this function is guaranteed to succeed, so it
1498 * can start modifying `*attributes`. */
1499
1500 if( attributes->domain_parameters != NULL )
1501 {
1502 mbedtls_free( attributes->domain_parameters );
1503 attributes->domain_parameters = NULL;
1504 attributes->domain_parameters_size = 0;
1505 }
1506
1507 attributes->domain_parameters = copy;
1508 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001509 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001510 return( PSA_SUCCESS );
1511}
1512
1513psa_status_t psa_get_key_domain_parameters(
1514 const psa_key_attributes_t *attributes,
1515 uint8_t *data, size_t data_size, size_t *data_length )
1516{
1517 if( attributes->domain_parameters_size > data_size )
1518 return( PSA_ERROR_BUFFER_TOO_SMALL );
1519 *data_length = attributes->domain_parameters_size;
1520 if( attributes->domain_parameters_size != 0 )
1521 memcpy( data, attributes->domain_parameters,
1522 attributes->domain_parameters_size );
1523 return( PSA_SUCCESS );
1524}
1525
John Durkop07cc04a2020-11-16 22:08:34 -08001526#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001527 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001528static psa_status_t psa_get_rsa_public_exponent(
1529 const mbedtls_rsa_context *rsa,
1530 psa_key_attributes_t *attributes )
1531{
1532 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001534 uint8_t *buffer = NULL;
1535 size_t buflen;
1536 mbedtls_mpi_init( &mpi );
1537
1538 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1539 if( ret != 0 )
1540 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001541 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1542 {
1543 /* It's the default value, which is reported as an empty string,
1544 * so there's nothing to do. */
1545 goto exit;
1546 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001547
1548 buflen = mbedtls_mpi_size( &mpi );
1549 buffer = mbedtls_calloc( 1, buflen );
1550 if( buffer == NULL )
1551 {
1552 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1553 goto exit;
1554 }
1555 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1556 if( ret != 0 )
1557 goto exit;
1558 attributes->domain_parameters = buffer;
1559 attributes->domain_parameters_size = buflen;
1560
1561exit:
1562 mbedtls_mpi_free( &mpi );
1563 if( ret != 0 )
1564 mbedtls_free( buffer );
1565 return( mbedtls_to_psa_error( ret ) );
1566}
John Durkop07cc04a2020-11-16 22:08:34 -08001567#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001568 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001569
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001570/** Retrieve all the publicly-accessible attributes of a key.
1571 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001572psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001573 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001574{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001575 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001576 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001577 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001578
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001579 psa_reset_key_attributes( attributes );
1580
Ronald Cron5c522922020-11-14 16:35:34 +01001581 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001582 if( status != PSA_SUCCESS )
1583 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001584
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001585 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001586 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1587 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1588
1589#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1590 if( psa_key_slot_is_external( slot ) )
1591 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1592#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001593
Gilles Peskine8e338702019-07-30 20:06:31 +02001594 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001595 {
John Durkop07cc04a2020-11-16 22:08:34 -08001596#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001597 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001598 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001599 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001600#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001601 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001602 * is not yet implemented.
1603 * https://github.com/ARMmbed/mbed-crypto/issues/216
1604 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001605 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001606 break;
1607#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001608 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001609 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001610
Steven Cooreman4fed4552020-08-03 14:46:03 +02001611 status = psa_load_rsa_representation( slot->attr.type,
1612 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001613 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001614 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001615 if( status != PSA_SUCCESS )
1616 break;
1617
Steven Cooremana2371e52020-07-28 14:30:39 +02001618 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001619 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001620 mbedtls_rsa_free( rsa );
1621 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001622 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001623 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001624#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001625 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001626 default:
1627 /* Nothing else to do. */
1628 break;
1629 }
1630
1631 if( status != PSA_SUCCESS )
1632 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001633
Ronald Cron5c522922020-11-14 16:35:34 +01001634 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001635
Ronald Cron5c522922020-11-14 16:35:34 +01001636 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001637}
1638
Gilles Peskinec8000c02019-08-02 20:15:51 +02001639#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1640psa_status_t psa_get_key_slot_number(
1641 const psa_key_attributes_t *attributes,
1642 psa_key_slot_number_t *slot_number )
1643{
1644 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1645 {
1646 *slot_number = attributes->slot_number;
1647 return( PSA_SUCCESS );
1648 }
1649 else
1650 return( PSA_ERROR_INVALID_ARGUMENT );
1651}
1652#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1653
Steven Cooremana01795d2020-07-24 22:48:15 +02001654static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1655 uint8_t *data,
1656 size_t data_size,
1657 size_t *data_length )
1658{
1659 if( slot->data.key.bytes > data_size )
1660 return( PSA_ERROR_BUFFER_TOO_SMALL );
1661 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1662 memset( data + slot->data.key.bytes, 0,
1663 data_size - slot->data.key.bytes );
1664 *data_length = slot->data.key.bytes;
1665 return( PSA_SUCCESS );
1666}
1667
Gilles Peskinef603c712019-01-19 13:40:11 +01001668static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1669 uint8_t *data,
1670 size_t data_size,
1671 size_t *data_length,
1672 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001673{
Gilles Peskine5d309672019-07-12 23:47:28 +02001674#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1675 const psa_drv_se_t *drv;
1676 psa_drv_se_context_t *drv_context;
1677#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1678
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001679 *data_length = 0;
1680
Gilles Peskine8e338702019-07-30 20:06:31 +02001681 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001682 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001683
Gilles Peskinef9168942019-09-12 19:20:29 +02001684 /* Reject a zero-length output buffer now, since this can never be a
1685 * valid key representation. This way we know that data must be a valid
1686 * pointer and we can do things like memset(data, ..., data_size). */
1687 if( data_size == 0 )
1688 return( PSA_ERROR_BUFFER_TOO_SMALL );
1689
Gilles Peskine5d309672019-07-12 23:47:28 +02001690#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001691 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001692 {
1693 psa_drv_se_export_key_t method;
1694 if( drv->key_management == NULL )
1695 return( PSA_ERROR_NOT_SUPPORTED );
1696 method = ( export_public_key ?
1697 drv->key_management->p_export_public :
1698 drv->key_management->p_export );
1699 if( method == NULL )
1700 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001701 return( method( drv_context,
1702 slot->data.se.slot_number,
1703 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001704 }
1705#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1706
Gilles Peskine8e338702019-07-30 20:06:31 +02001707 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001708 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001709 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001710 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001711 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1712 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001713 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001714 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001715 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001716 /* Exporting public -> public */
1717 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1718 }
1719 else if( !export_public_key )
1720 {
1721 /* Exporting private -> private */
1722 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1723 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001724
Steven Cooreman560c28a2020-07-24 23:20:24 +02001725 /* Need to export the public part of a private key,
Steven Cooremanb9b84422020-10-14 14:39:20 +02001726 * so conversion is needed. Try the accelerators first. */
1727 psa_status_t status = psa_driver_wrapper_export_public_key( slot,
1728 data,
1729 data_size,
1730 data_length );
1731
1732 if( status != PSA_ERROR_NOT_SUPPORTED ||
1733 psa_key_lifetime_is_external( slot->attr.lifetime ) )
1734 return( status );
1735
Steven Cooreman560c28a2020-07-24 23:20:24 +02001736 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1737 {
John Durkop0e005192020-10-31 22:06:54 -07001738#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1739 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001740 mbedtls_rsa_context *rsa = NULL;
Steven Cooremanb9b84422020-10-14 14:39:20 +02001741 status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001742 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001743 slot->data.key.data,
1744 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001745 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001746 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001747 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001748
Steven Cooreman560c28a2020-07-24 23:20:24 +02001749 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001750 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001751 data,
1752 data_size,
1753 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001754
Steven Cooremana2371e52020-07-28 14:30:39 +02001755 mbedtls_rsa_free( rsa );
1756 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001757
Steven Cooreman560c28a2020-07-24 23:20:24 +02001758 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001759#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001760 /* We don't know how to convert a private RSA key to public. */
1761 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001762#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1763 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001764 }
1765 else
Moran Pekera998bc62018-04-16 18:16:20 +03001766 {
John Durkop6ba40d12020-11-10 08:50:04 -08001767#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1768 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001769 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooremanb9b84422020-10-14 14:39:20 +02001770 status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001771 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001772 slot->data.key.data,
1773 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001774 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001775 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001776 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001777
1778 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1779 PSA_KEY_TYPE_ECC_GET_FAMILY(
1780 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001781 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001782 data,
1783 data_size,
1784 data_length );
1785
Steven Cooremana2371e52020-07-28 14:30:39 +02001786 mbedtls_ecp_keypair_free( ecp );
1787 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001788 return( status );
1789#else
1790 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001791 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001792#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1793 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001794 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001795 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001796 else
1797 {
1798 /* This shouldn't happen in the reference implementation, but
1799 it is valid for a special-purpose implementation to omit
1800 support for exporting certain key types. */
1801 return( PSA_ERROR_NOT_SUPPORTED );
1802 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001803}
1804
Ronald Croncf56a0a2020-08-04 09:51:30 +02001805psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001806 uint8_t *data,
1807 size_t data_size,
1808 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001809{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001810 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001811 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001812 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001813
1814 /* Set the key to empty now, so that even when there are errors, we always
1815 * set data_length to a value between 0 and data_size. On error, setting
1816 * the key to empty is a good choice because an empty key representation is
1817 * unlikely to be accepted anywhere. */
1818 *data_length = 0;
1819
1820 /* Export requires the EXPORT flag. There is an exception for public keys,
Ronald Cron5c522922020-11-14 16:35:34 +01001821 * which don't require any flag, but
1822 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1823 */
1824 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1825 PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001826 if( status != PSA_SUCCESS )
1827 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001828
1829 status = psa_internal_export_key( slot, data, data_size, data_length, 0 );
Ronald Cron5c522922020-11-14 16:35:34 +01001830 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001831
Ronald Cron5c522922020-11-14 16:35:34 +01001832 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001833}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001834
Ronald Croncf56a0a2020-08-04 09:51:30 +02001835psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001836 uint8_t *data,
1837 size_t data_size,
1838 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001839{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001840 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001841 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001842 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001843
1844 /* Set the key to empty now, so that even when there are errors, we always
1845 * set data_length to a value between 0 and data_size. On error, setting
1846 * the key to empty is a good choice because an empty key representation is
1847 * unlikely to be accepted anywhere. */
1848 *data_length = 0;
1849
1850 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001851 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001852 if( status != PSA_SUCCESS )
1853 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001854
1855 status = psa_internal_export_key( slot, data, data_size, data_length, 1 );
Ronald Cron5c522922020-11-14 16:35:34 +01001856 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001857
Ronald Cron5c522922020-11-14 16:35:34 +01001858 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001859}
1860
Gilles Peskine91e8c332019-08-02 19:19:39 +02001861#if defined(static_assert)
1862static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1863 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001864static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001865 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001866static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001867 "One or more key attribute flag is listed as both internal-only and external-only" );
1868#endif
1869
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001870/** Validate that a key policy is internally well-formed.
1871 *
1872 * This function only rejects invalid policies. It does not validate the
1873 * consistency of the policy with respect to other attributes of the key
1874 * such as the key type.
1875 */
1876static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001877{
1878 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001879 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 PSA_KEY_USAGE_ENCRYPT |
1881 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001882 PSA_KEY_USAGE_SIGN_HASH |
1883 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1885 return( PSA_ERROR_INVALID_ARGUMENT );
1886
Gilles Peskine4747d192019-04-17 15:05:45 +02001887 return( PSA_SUCCESS );
1888}
1889
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001890/** Validate the internal consistency of key attributes.
1891 *
1892 * This function only rejects invalid attribute values. If does not
1893 * validate the consistency of the attributes with any key data that may
1894 * be involved in the creation of the key.
1895 *
1896 * Call this function early in the key creation process.
1897 *
1898 * \param[in] attributes Key attributes for the new key.
1899 * \param[out] p_drv On any return, the driver for the key, if any.
1900 * NULL for a transparent key.
1901 *
1902 */
1903static psa_status_t psa_validate_key_attributes(
1904 const psa_key_attributes_t *attributes,
1905 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001906{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001907 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001908 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001909 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001910
Ronald Cron54b90082020-10-29 15:26:43 +01001911 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001912 if( status != PSA_SUCCESS )
1913 return( status );
1914
Ronald Crond2ed4812020-07-17 16:11:30 +02001915 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001916 if( status != PSA_SUCCESS )
1917 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001918
Ronald Cron65f38a32020-10-23 17:11:13 +02001919 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1920 {
1921 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1922 return( PSA_ERROR_INVALID_ARGUMENT );
1923 }
1924 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001925 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001926 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001927 if( status != PSA_SUCCESS )
1928 return( status );
1929 }
1930
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001931 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001932 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001933 return( status );
1934
1935 /* Refuse to create overly large keys.
1936 * Note that this doesn't trigger on import if the attributes don't
1937 * explicitly specify a size (so psa_get_key_bits returns 0), so
1938 * psa_import_key() needs its own checks. */
1939 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1940 return( PSA_ERROR_NOT_SUPPORTED );
1941
Gilles Peskine91e8c332019-08-02 19:19:39 +02001942 /* Reject invalid flags. These should not be reachable through the API. */
1943 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1944 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1945 return( PSA_ERROR_INVALID_ARGUMENT );
1946
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001947 return( PSA_SUCCESS );
1948}
1949
Gilles Peskine4747d192019-04-17 15:05:45 +02001950/** Prepare a key slot to receive key material.
1951 *
1952 * This function allocates a key slot and sets its metadata.
1953 *
1954 * If this function fails, call psa_fail_key_creation().
1955 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001956 * This function is intended to be used as follows:
1957 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001958 * it with the specified attributes, and in case of a volatile key assign it
1959 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001960 * -# Populate the slot with the key material.
1961 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1962 * In case of failure at any step, stop the sequence and call
1963 * psa_fail_key_creation().
1964 *
Ronald Cron5c522922020-11-14 16:35:34 +01001965 * On success, the key slot is locked. It is the responsibility of the caller
1966 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001967 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001968 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001969 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001970 * \param[out] p_slot On success, a pointer to the prepared slot.
1971 * \param[out] p_drv On any return, the driver for the key, if any.
1972 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001973 *
1974 * \retval #PSA_SUCCESS
1975 * The key slot is ready to receive key material.
1976 * \return If this function fails, the key slot is an invalid state.
1977 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001978 */
1979static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001980 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001981 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001982 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001983 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001984{
1985 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001986 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001987 psa_key_slot_t *slot;
1988
Gilles Peskinedf179142019-07-15 22:02:14 +02001989 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001990 *p_drv = NULL;
1991
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001992 status = psa_validate_key_attributes( attributes, p_drv );
1993 if( status != PSA_SUCCESS )
1994 return( status );
1995
Ronald Cronc4d1b512020-07-31 11:26:37 +02001996 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001997 if( status != PSA_SUCCESS )
1998 return( status );
1999 slot = *p_slot;
2000
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002001 /* We're storing the declared bit-size of the key. It's up to each
2002 * creation mechanism to verify that this information is correct.
2003 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02002004 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02002005 * is optional (import, copy). In case of a volatile key, assign it the
2006 * volatile key identifier associated to the slot returned to contain its
2007 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002008
2009 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02002010 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
2011 {
2012#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
2013 slot->attr.id = volatile_key_id;
2014#else
2015 slot->attr.id.key_id = volatile_key_id;
2016#endif
2017 }
Gilles Peskinec744d992019-07-30 17:26:54 +02002018
Gilles Peskine91e8c332019-08-02 19:19:39 +02002019 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02002020 * external-only flags, query `attributes`. Thanks to the check
2021 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02002022 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02002023 * may have set. */
2024 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02002025
Gilles Peskinecbaff462019-07-12 23:46:04 +02002026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002027 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002028 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02002029 * create the key file in internal storage, create the
2030 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002031 * persistent data. This is done by starting a transaction that will
2032 * encompass these three actions.
2033 * For registering a volatile key, we just need to find an appropriate
2034 * slot number inside the SE. Since the key is designated volatile, creating
2035 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02002036 /* The first thing to do is to find a slot number for the new key.
2037 * We save the slot number in persistent storage as part of the
2038 * transaction data. It will be needed to recover if the power
2039 * fails during the key creation process, to clean up on the secure
2040 * element side after restarting. Obtaining a slot number from the
2041 * secure element driver updates its persistent state, but we do not yet
2042 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02002043 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002044 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00002045 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02002046 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02002047 &slot->data.se.slot_number );
2048 if( status != PSA_SUCCESS )
2049 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002050
2051 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02002052 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002053 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
2054 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
2055 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
2056 psa_crypto_transaction.key.id = slot->attr.id;
2057 status = psa_crypto_save_transaction( );
2058 if( status != PSA_SUCCESS )
2059 {
2060 (void) psa_crypto_stop_transaction( );
2061 return( status );
2062 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02002063 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002064 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002065
2066 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
2067 {
2068 /* Key registration only makes sense with a secure element. */
2069 return( PSA_ERROR_INVALID_ARGUMENT );
2070 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02002071#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2072
Ronald Cronc4d1b512020-07-31 11:26:37 +02002073 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00002074}
Gilles Peskine4747d192019-04-17 15:05:45 +02002075
2076/** Finalize the creation of a key once its key material has been set.
2077 *
2078 * This entails writing the key to persistent storage.
2079 *
2080 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002081 * See the documentation of psa_start_key_creation() for the intended use
2082 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002083 *
Ronald Cron5c522922020-11-14 16:35:34 +01002084 * If the finalization succeeds, the function unlocks the key slot (it was
2085 * locked by psa_start_key_creation()) and the key slot cannot be accessed
2086 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01002087 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002088 * \param[in,out] slot Pointer to the slot with key material.
2089 * \param[in] driver The secure element driver for the key,
2090 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01002091 * \param[out] key On success, identifier of the key. Note that the
2092 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002093 *
2094 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002095 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002096 * \return If this function fails, the key slot is an invalid state.
2097 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002098 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002099static psa_status_t psa_finish_key_creation(
2100 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002101 psa_se_drv_table_entry_t *driver,
2102 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002103{
2104 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002105 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002106 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002107
2108#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02002109 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02002110 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002111#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2112 if( driver != NULL )
2113 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002114 psa_se_key_data_storage_t data;
2115#if defined(static_assert)
2116 static_assert( sizeof( slot->data.se.slot_number ) ==
2117 sizeof( data.slot_number ),
2118 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002119#endif
2120 memcpy( &data.slot_number, &slot->data.se.slot_number,
2121 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002122 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002123 (uint8_t*) &data,
2124 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002125 }
2126 else
2127#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2128 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002129 /* Key material is saved in export representation in the slot, so
2130 * just pass the slot buffer for storage. */
2131 status = psa_save_persistent_key( &slot->attr,
2132 slot->data.key.data,
2133 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002134 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002135 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002136#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2137
Gilles Peskinecbaff462019-07-12 23:46:04 +02002138#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002139 /* Finish the transaction for a key creation. This does not
2140 * happen when registering an existing key. Detect this case
2141 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002142 * creation of a persistent key in a secure element requires a transaction,
2143 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002144 if( driver != NULL &&
2145 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002146 {
2147 status = psa_save_se_persistent_data( driver );
2148 if( status != PSA_SUCCESS )
2149 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002150 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002151 return( status );
2152 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002153 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002154 }
2155#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2156
Ronald Cron50972942020-11-14 11:28:25 +01002157 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01002158 {
2159 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01002160 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01002161 if( status != PSA_SUCCESS )
2162 *key = MBEDTLS_SVC_KEY_ID_INIT;
2163 }
Ronald Cron50972942020-11-14 11:28:25 +01002164
Gilles Peskine4747d192019-04-17 15:05:45 +02002165 return( status );
2166}
2167
2168/** Abort the creation of a key.
2169 *
2170 * You may call this function after calling psa_start_key_creation(),
2171 * or after psa_finish_key_creation() fails. In other circumstances, this
2172 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002173 * See the documentation of psa_start_key_creation() for the intended use
2174 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002175 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002176 * \param[in,out] slot Pointer to the slot with key material.
2177 * \param[in] driver The secure element driver for the key,
2178 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002179 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002180static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002181 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002182{
Gilles Peskine011e4282019-06-26 18:34:38 +02002183 (void) driver;
2184
Gilles Peskine4747d192019-04-17 15:05:45 +02002185 if( slot == NULL )
2186 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002187
2188#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002189 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002190 * element, and the failure happened later (when saving metadata
2191 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002192 * element.
2193 * https://github.com/ARMmbed/mbed-crypto/issues/217
2194 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002195
Gilles Peskined7729582019-08-05 15:55:54 +02002196 /* Abort the ongoing transaction if any (there may not be one if
2197 * the creation process failed before starting one, or if the
2198 * key creation is a registration of a key in a secure element).
2199 * Earlier functions must already have done what it takes to undo any
2200 * partial creation. All that's left is to update the transaction data
2201 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002202 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002203#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2204
Gilles Peskine4747d192019-04-17 15:05:45 +02002205 psa_wipe_key_slot( slot );
2206}
2207
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002208/** Validate optional attributes during key creation.
2209 *
2210 * Some key attributes are optional during key creation. If they are
2211 * specified in the attributes structure, check that they are consistent
2212 * with the data in the slot.
2213 *
2214 * This function should be called near the end of key creation, after
2215 * the slot in memory is fully populated but before saving persistent data.
2216 */
2217static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002218 const psa_key_slot_t *slot,
2219 const psa_key_attributes_t *attributes )
2220{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002221 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002222 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002223 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002224 return( PSA_ERROR_INVALID_ARGUMENT );
2225 }
2226
2227 if( attributes->domain_parameters_size != 0 )
2228 {
John Durkop0e005192020-10-31 22:06:54 -07002229#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
2230 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02002231 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002232 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002233 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002234 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002235 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002236
Steven Cooreman7f391872020-07-30 14:57:44 +02002237 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002238 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002239 slot->data.key.data,
2240 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002241 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002242 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002243 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002244
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002245 mbedtls_mpi_init( &actual );
2246 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002247 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002248 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002249 mbedtls_rsa_free( rsa );
2250 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002251 if( ret != 0 )
2252 goto rsa_exit;
2253 ret = mbedtls_mpi_read_binary( &required,
2254 attributes->domain_parameters,
2255 attributes->domain_parameters_size );
2256 if( ret != 0 )
2257 goto rsa_exit;
2258 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2259 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2260 rsa_exit:
2261 mbedtls_mpi_free( &actual );
2262 mbedtls_mpi_free( &required );
2263 if( ret != 0)
2264 return( mbedtls_to_psa_error( ret ) );
2265 }
2266 else
John Durkop9814fa22020-11-04 12:28:15 -08002267#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
2268 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002269 {
2270 return( PSA_ERROR_INVALID_ARGUMENT );
2271 }
2272 }
2273
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002274 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002275 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002276 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002277 return( PSA_ERROR_INVALID_ARGUMENT );
2278 }
2279
2280 return( PSA_SUCCESS );
2281}
2282
Gilles Peskine4747d192019-04-17 15:05:45 +02002283psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002284 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002285 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002286 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002287{
2288 psa_status_t status;
2289 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002290 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002291
Ronald Cron81709fc2020-11-14 12:10:32 +01002292 *key = MBEDTLS_SVC_KEY_ID_INIT;
2293
Gilles Peskine0f84d622019-09-12 19:03:13 +02002294 /* Reject zero-length symmetric keys (including raw data key objects).
2295 * This also rejects any key which might be encoded as an empty string,
2296 * which is never valid. */
2297 if( data_length == 0 )
2298 return( PSA_ERROR_INVALID_ARGUMENT );
2299
Gilles Peskinedf179142019-07-15 22:02:14 +02002300 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002301 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002302 if( status != PSA_SUCCESS )
2303 goto exit;
2304
Gilles Peskine5d309672019-07-12 23:47:28 +02002305#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2306 if( driver != NULL )
2307 {
2308 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002309 /* The driver should set the number of key bits, however in
2310 * case it doesn't, we initialize bits to an invalid value. */
2311 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002312 if( drv->key_management == NULL ||
2313 drv->key_management->p_import == NULL )
2314 {
2315 status = PSA_ERROR_NOT_SUPPORTED;
2316 goto exit;
2317 }
2318 status = drv->key_management->p_import(
2319 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002320 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002321 &bits );
2322 if( status != PSA_SUCCESS )
2323 goto exit;
2324 if( bits > PSA_MAX_KEY_BITS )
2325 {
2326 status = PSA_ERROR_NOT_SUPPORTED;
2327 goto exit;
2328 }
2329 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002330 }
2331 else
2332#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2333 {
2334 status = psa_import_key_into_slot( slot, data, data_length );
2335 if( status != PSA_SUCCESS )
2336 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002337 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002338 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002339 if( status != PSA_SUCCESS )
2340 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002341
Ronald Cron81709fc2020-11-14 12:10:32 +01002342 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002343exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002344 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002345 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002346
Gilles Peskine4747d192019-04-17 15:05:45 +02002347 return( status );
2348}
2349
Gilles Peskined7729582019-08-05 15:55:54 +02002350#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2351psa_status_t mbedtls_psa_register_se_key(
2352 const psa_key_attributes_t *attributes )
2353{
2354 psa_status_t status;
2355 psa_key_slot_t *slot = NULL;
2356 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002357 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002358
2359 /* Leaving attributes unspecified is not currently supported.
2360 * It could make sense to query the key type and size from the
2361 * secure element, but not all secure elements support this
2362 * and the driver HAL doesn't currently support it. */
2363 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2364 return( PSA_ERROR_NOT_SUPPORTED );
2365 if( psa_get_key_bits( attributes ) == 0 )
2366 return( PSA_ERROR_NOT_SUPPORTED );
2367
2368 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002369 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002370 if( status != PSA_SUCCESS )
2371 goto exit;
2372
Ronald Cron81709fc2020-11-14 12:10:32 +01002373 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002374
2375exit:
2376 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002377 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002378
Gilles Peskined7729582019-08-05 15:55:54 +02002379 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002380 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002381 return( status );
2382}
2383#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2384
Gilles Peskinef603c712019-01-19 13:40:11 +01002385static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002386 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002387{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002388 psa_status_t status = psa_copy_key_material_into_slot( target,
2389 source->data.key.data,
2390 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002391 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002392 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002393
Steven Cooreman398aee52020-10-13 14:35:45 +02002394 target->attr.type = source->attr.type;
2395 target->attr.bits = source->attr.bits;
2396
2397 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002398}
2399
Ronald Croncf56a0a2020-08-04 09:51:30 +02002400psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002401 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002402 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002403{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002404 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002405 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002406 psa_key_slot_t *source_slot = NULL;
2407 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002408 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002409 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002410
Ronald Cron81709fc2020-11-14 12:10:32 +01002411 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2412
Ronald Cron5c522922020-11-14 16:35:34 +01002413 status = psa_get_and_lock_transparent_key_slot_with_policy(
2414 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002415 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002416 goto exit;
2417
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002418 status = psa_validate_optional_attributes( source_slot,
2419 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002420 if( status != PSA_SUCCESS )
2421 goto exit;
2422
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002423 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002424 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002425 if( status != PSA_SUCCESS )
2426 goto exit;
2427
Ronald Cron81709fc2020-11-14 12:10:32 +01002428 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2429 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002430 if( status != PSA_SUCCESS )
2431 goto exit;
2432
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002433#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2434 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002435 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002436 /* Copying to a secure element is not implemented yet. */
2437 status = PSA_ERROR_NOT_SUPPORTED;
2438 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002439 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002440#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002441
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002442 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002443 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002444 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002445
Ronald Cron81709fc2020-11-14 12:10:32 +01002446 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002447exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002448 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002449 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002450
Ronald Cron5c522922020-11-14 16:35:34 +01002451 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002452
Ronald Cron5c522922020-11-14 16:35:34 +01002453 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002454}
2455
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002456
2457
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002458/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002459/* Message digests */
2460/****************************************************************/
2461
John Durkop07cc04a2020-11-16 22:08:34 -08002462#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002463 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2464 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002465 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002466static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002467{
2468 switch( alg )
2469 {
John Durkopee4e6602020-11-27 08:48:46 -08002470#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002471 case PSA_ALG_MD2:
2472 return( &mbedtls_md2_info );
2473#endif
John Durkopee4e6602020-11-27 08:48:46 -08002474#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002475 case PSA_ALG_MD4:
2476 return( &mbedtls_md4_info );
2477#endif
John Durkopee4e6602020-11-27 08:48:46 -08002478#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002479 case PSA_ALG_MD5:
2480 return( &mbedtls_md5_info );
2481#endif
John Durkopee4e6602020-11-27 08:48:46 -08002482#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002483 case PSA_ALG_RIPEMD160:
2484 return( &mbedtls_ripemd160_info );
2485#endif
John Durkopee4e6602020-11-27 08:48:46 -08002486#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002487 case PSA_ALG_SHA_1:
2488 return( &mbedtls_sha1_info );
2489#endif
John Durkopee4e6602020-11-27 08:48:46 -08002490#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002491 case PSA_ALG_SHA_224:
2492 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002493#endif
2494#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002495 case PSA_ALG_SHA_256:
2496 return( &mbedtls_sha256_info );
2497#endif
John Durkopee4e6602020-11-27 08:48:46 -08002498#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002499 case PSA_ALG_SHA_384:
2500 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002501#endif
John Durkopee4e6602020-11-27 08:48:46 -08002502#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002503 case PSA_ALG_SHA_512:
2504 return( &mbedtls_sha512_info );
2505#endif
2506 default:
2507 return( NULL );
2508 }
2509}
John Durkop07cc04a2020-11-16 22:08:34 -08002510#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002511 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2512 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2513 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002514
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002515psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2516{
2517 switch( operation->alg )
2518 {
Gilles Peskine81736312018-06-26 15:04:31 +02002519 case 0:
2520 /* The object has (apparently) been initialized but it is not
2521 * in use. It's ok to call abort on such an object, and there's
2522 * nothing to do. */
2523 break;
John Durkopee4e6602020-11-27 08:48:46 -08002524#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002525 case PSA_ALG_MD2:
2526 mbedtls_md2_free( &operation->ctx.md2 );
2527 break;
2528#endif
John Durkopee4e6602020-11-27 08:48:46 -08002529#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002530 case PSA_ALG_MD4:
2531 mbedtls_md4_free( &operation->ctx.md4 );
2532 break;
2533#endif
John Durkopee4e6602020-11-27 08:48:46 -08002534#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002535 case PSA_ALG_MD5:
2536 mbedtls_md5_free( &operation->ctx.md5 );
2537 break;
2538#endif
John Durkopee4e6602020-11-27 08:48:46 -08002539#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002540 case PSA_ALG_RIPEMD160:
2541 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2542 break;
2543#endif
John Durkopee4e6602020-11-27 08:48:46 -08002544#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002545 case PSA_ALG_SHA_1:
2546 mbedtls_sha1_free( &operation->ctx.sha1 );
2547 break;
2548#endif
John Durkop6ca23272020-12-03 06:01:32 -08002549#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002550 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002551 mbedtls_sha256_free( &operation->ctx.sha256 );
2552 break;
2553#endif
2554#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002555 case PSA_ALG_SHA_256:
2556 mbedtls_sha256_free( &operation->ctx.sha256 );
2557 break;
2558#endif
John Durkop6ca23272020-12-03 06:01:32 -08002559#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002560 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002561 mbedtls_sha512_free( &operation->ctx.sha512 );
2562 break;
2563#endif
2564#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002565 case PSA_ALG_SHA_512:
2566 mbedtls_sha512_free( &operation->ctx.sha512 );
2567 break;
2568#endif
2569 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002570 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002571 }
2572 operation->alg = 0;
2573 return( PSA_SUCCESS );
2574}
2575
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002576psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002577 psa_algorithm_t alg )
2578{
Janos Follath24eed8d2019-11-22 13:21:35 +00002579 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002580
2581 /* A context must be freshly initialized before it can be set up. */
2582 if( operation->alg != 0 )
2583 {
2584 return( PSA_ERROR_BAD_STATE );
2585 }
2586
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002587 switch( alg )
2588 {
John Durkopee4e6602020-11-27 08:48:46 -08002589#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002590 case PSA_ALG_MD2:
2591 mbedtls_md2_init( &operation->ctx.md2 );
2592 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2593 break;
2594#endif
John Durkopee4e6602020-11-27 08:48:46 -08002595#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002596 case PSA_ALG_MD4:
2597 mbedtls_md4_init( &operation->ctx.md4 );
2598 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2599 break;
2600#endif
John Durkopee4e6602020-11-27 08:48:46 -08002601#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002602 case PSA_ALG_MD5:
2603 mbedtls_md5_init( &operation->ctx.md5 );
2604 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2605 break;
2606#endif
John Durkopee4e6602020-11-27 08:48:46 -08002607#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002608 case PSA_ALG_RIPEMD160:
2609 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2610 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2611 break;
2612#endif
John Durkopee4e6602020-11-27 08:48:46 -08002613#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002614 case PSA_ALG_SHA_1:
2615 mbedtls_sha1_init( &operation->ctx.sha1 );
2616 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2617 break;
2618#endif
John Durkopee4e6602020-11-27 08:48:46 -08002619#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002620 case PSA_ALG_SHA_224:
2621 mbedtls_sha256_init( &operation->ctx.sha256 );
2622 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2623 break;
John Durkopee4e6602020-11-27 08:48:46 -08002624#endif
2625#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002626 case PSA_ALG_SHA_256:
2627 mbedtls_sha256_init( &operation->ctx.sha256 );
2628 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2629 break;
2630#endif
John Durkopee4e6602020-11-27 08:48:46 -08002631#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002632 case PSA_ALG_SHA_384:
2633 mbedtls_sha512_init( &operation->ctx.sha512 );
2634 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2635 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002636#endif
John Durkopee4e6602020-11-27 08:48:46 -08002637#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002638 case PSA_ALG_SHA_512:
2639 mbedtls_sha512_init( &operation->ctx.sha512 );
2640 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2641 break;
2642#endif
2643 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002644 return( PSA_ALG_IS_HASH( alg ) ?
2645 PSA_ERROR_NOT_SUPPORTED :
2646 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002647 }
2648 if( ret == 0 )
2649 operation->alg = alg;
2650 else
2651 psa_hash_abort( operation );
2652 return( mbedtls_to_psa_error( ret ) );
2653}
2654
2655psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2656 const uint8_t *input,
2657 size_t input_length )
2658{
Janos Follath24eed8d2019-11-22 13:21:35 +00002659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002660
2661 /* Don't require hash implementations to behave correctly on a
2662 * zero-length input, which may have an invalid pointer. */
2663 if( input_length == 0 )
2664 return( PSA_SUCCESS );
2665
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002666 switch( operation->alg )
2667 {
John Durkopee4e6602020-11-27 08:48:46 -08002668#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002669 case PSA_ALG_MD2:
2670 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2671 input, input_length );
2672 break;
2673#endif
John Durkopee4e6602020-11-27 08:48:46 -08002674#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002675 case PSA_ALG_MD4:
2676 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2677 input, input_length );
2678 break;
2679#endif
John Durkopee4e6602020-11-27 08:48:46 -08002680#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002681 case PSA_ALG_MD5:
2682 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2683 input, input_length );
2684 break;
2685#endif
John Durkopee4e6602020-11-27 08:48:46 -08002686#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002687 case PSA_ALG_RIPEMD160:
2688 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2689 input, input_length );
2690 break;
2691#endif
John Durkopee4e6602020-11-27 08:48:46 -08002692#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002693 case PSA_ALG_SHA_1:
2694 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2695 input, input_length );
2696 break;
2697#endif
John Durkop6ca23272020-12-03 06:01:32 -08002698#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002699 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002700 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2701 input, input_length );
2702 break;
2703#endif
2704#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002705 case PSA_ALG_SHA_256:
2706 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2707 input, input_length );
2708 break;
2709#endif
John Durkop6ca23272020-12-03 06:01:32 -08002710#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002711 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002712 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2713 input, input_length );
2714 break;
2715#endif
2716#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002717 case PSA_ALG_SHA_512:
2718 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2719 input, input_length );
2720 break;
2721#endif
2722 default:
John Durkopee4e6602020-11-27 08:48:46 -08002723 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002724 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002725 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002726
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002727 if( ret != 0 )
2728 psa_hash_abort( operation );
2729 return( mbedtls_to_psa_error( ret ) );
2730}
2731
2732psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2733 uint8_t *hash,
2734 size_t hash_size,
2735 size_t *hash_length )
2736{
itayzafrir40835d42018-08-02 13:14:17 +03002737 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002738 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002739 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002740
2741 /* Fill the output buffer with something that isn't a valid hash
2742 * (barring an attack on the hash and deliberately-crafted input),
2743 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002744 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002745 /* If hash_size is 0 then hash may be NULL and then the
2746 * call to memset would have undefined behavior. */
2747 if( hash_size != 0 )
2748 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002749
2750 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002751 {
2752 status = PSA_ERROR_BUFFER_TOO_SMALL;
2753 goto exit;
2754 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002755
2756 switch( operation->alg )
2757 {
John Durkopee4e6602020-11-27 08:48:46 -08002758#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002759 case PSA_ALG_MD2:
2760 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2761 break;
2762#endif
John Durkopee4e6602020-11-27 08:48:46 -08002763#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002764 case PSA_ALG_MD4:
2765 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2766 break;
2767#endif
John Durkopee4e6602020-11-27 08:48:46 -08002768#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002769 case PSA_ALG_MD5:
2770 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2771 break;
2772#endif
John Durkopee4e6602020-11-27 08:48:46 -08002773#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002774 case PSA_ALG_RIPEMD160:
2775 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2776 break;
2777#endif
John Durkopee4e6602020-11-27 08:48:46 -08002778#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002779 case PSA_ALG_SHA_1:
2780 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2781 break;
2782#endif
John Durkop6ca23272020-12-03 06:01:32 -08002783#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002784 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002785 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2786 break;
2787#endif
2788#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002789 case PSA_ALG_SHA_256:
2790 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2791 break;
2792#endif
John Durkop6ca23272020-12-03 06:01:32 -08002793#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002794 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002795 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2796 break;
2797#endif
2798#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002799 case PSA_ALG_SHA_512:
2800 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2801 break;
2802#endif
2803 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002804 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002805 }
itayzafrir40835d42018-08-02 13:14:17 +03002806 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002807
itayzafrir40835d42018-08-02 13:14:17 +03002808exit:
2809 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002810 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002811 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002812 return( psa_hash_abort( operation ) );
2813 }
2814 else
2815 {
2816 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002817 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002818 }
2819}
2820
Gilles Peskine2d277862018-06-18 15:41:12 +02002821psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2822 const uint8_t *hash,
2823 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002824{
2825 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2826 size_t actual_hash_length;
2827 psa_status_t status = psa_hash_finish( operation,
2828 actual_hash, sizeof( actual_hash ),
2829 &actual_hash_length );
2830 if( status != PSA_SUCCESS )
2831 return( status );
2832 if( actual_hash_length != hash_length )
2833 return( PSA_ERROR_INVALID_SIGNATURE );
2834 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2835 return( PSA_ERROR_INVALID_SIGNATURE );
2836 return( PSA_SUCCESS );
2837}
2838
Gilles Peskine0a749c82019-11-28 19:33:58 +01002839psa_status_t psa_hash_compute( psa_algorithm_t alg,
2840 const uint8_t *input, size_t input_length,
2841 uint8_t *hash, size_t hash_size,
2842 size_t *hash_length )
2843{
2844 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2846
2847 *hash_length = hash_size;
2848 status = psa_hash_setup( &operation, alg );
2849 if( status != PSA_SUCCESS )
2850 goto exit;
2851 status = psa_hash_update( &operation, input, input_length );
2852 if( status != PSA_SUCCESS )
2853 goto exit;
2854 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2855 if( status != PSA_SUCCESS )
2856 goto exit;
2857
2858exit:
2859 if( status == PSA_SUCCESS )
2860 status = psa_hash_abort( &operation );
2861 else
2862 psa_hash_abort( &operation );
2863 return( status );
2864}
2865
2866psa_status_t psa_hash_compare( psa_algorithm_t alg,
2867 const uint8_t *input, size_t input_length,
2868 const uint8_t *hash, size_t hash_length )
2869{
2870 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2871 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2872
2873 status = psa_hash_setup( &operation, alg );
2874 if( status != PSA_SUCCESS )
2875 goto exit;
2876 status = psa_hash_update( &operation, input, input_length );
2877 if( status != PSA_SUCCESS )
2878 goto exit;
2879 status = psa_hash_verify( &operation, hash, hash_length );
2880 if( status != PSA_SUCCESS )
2881 goto exit;
2882
2883exit:
2884 if( status == PSA_SUCCESS )
2885 status = psa_hash_abort( &operation );
2886 else
2887 psa_hash_abort( &operation );
2888 return( status );
2889}
2890
Gilles Peskineeb35d782019-01-22 17:56:16 +01002891psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2892 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002893{
2894 if( target_operation->alg != 0 )
2895 return( PSA_ERROR_BAD_STATE );
2896
2897 switch( source_operation->alg )
2898 {
2899 case 0:
2900 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002901#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002902 case PSA_ALG_MD2:
2903 mbedtls_md2_clone( &target_operation->ctx.md2,
2904 &source_operation->ctx.md2 );
2905 break;
2906#endif
John Durkopee4e6602020-11-27 08:48:46 -08002907#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002908 case PSA_ALG_MD4:
2909 mbedtls_md4_clone( &target_operation->ctx.md4,
2910 &source_operation->ctx.md4 );
2911 break;
2912#endif
John Durkopee4e6602020-11-27 08:48:46 -08002913#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002914 case PSA_ALG_MD5:
2915 mbedtls_md5_clone( &target_operation->ctx.md5,
2916 &source_operation->ctx.md5 );
2917 break;
2918#endif
John Durkopee4e6602020-11-27 08:48:46 -08002919#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002920 case PSA_ALG_RIPEMD160:
2921 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2922 &source_operation->ctx.ripemd160 );
2923 break;
2924#endif
John Durkopee4e6602020-11-27 08:48:46 -08002925#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002926 case PSA_ALG_SHA_1:
2927 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2928 &source_operation->ctx.sha1 );
2929 break;
2930#endif
John Durkop6ca23272020-12-03 06:01:32 -08002931#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002932 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002933 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2934 &source_operation->ctx.sha256 );
2935 break;
2936#endif
2937#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002938 case PSA_ALG_SHA_256:
2939 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2940 &source_operation->ctx.sha256 );
2941 break;
2942#endif
John Durkop6ca23272020-12-03 06:01:32 -08002943#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002944 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002945 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2946 &source_operation->ctx.sha512 );
2947 break;
2948#endif
2949#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002950 case PSA_ALG_SHA_512:
2951 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2952 &source_operation->ctx.sha512 );
2953 break;
2954#endif
2955 default:
2956 return( PSA_ERROR_NOT_SUPPORTED );
2957 }
2958
2959 target_operation->alg = source_operation->alg;
2960 return( PSA_SUCCESS );
2961}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002962
2963
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002964/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002965/* MAC */
2966/****************************************************************/
2967
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002968static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002969 psa_algorithm_t alg,
2970 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002971 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002972 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002973{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002974 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002975 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002976
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002977 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002978 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002979
Gilles Peskine8c9def32018-02-08 10:02:12 +01002980 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2981 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002982 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002983 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002984 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002985 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002986 mode = MBEDTLS_MODE_STREAM;
2987 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002988 case PSA_ALG_CTR:
2989 mode = MBEDTLS_MODE_CTR;
2990 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002991 case PSA_ALG_CFB:
2992 mode = MBEDTLS_MODE_CFB;
2993 break;
2994 case PSA_ALG_OFB:
2995 mode = MBEDTLS_MODE_OFB;
2996 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002997 case PSA_ALG_ECB_NO_PADDING:
2998 mode = MBEDTLS_MODE_ECB;
2999 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003000 case PSA_ALG_CBC_NO_PADDING:
3001 mode = MBEDTLS_MODE_CBC;
3002 break;
3003 case PSA_ALG_CBC_PKCS7:
3004 mode = MBEDTLS_MODE_CBC;
3005 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02003006 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01003007 mode = MBEDTLS_MODE_CCM;
3008 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02003009 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01003010 mode = MBEDTLS_MODE_GCM;
3011 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02003012 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
3013 mode = MBEDTLS_MODE_CHACHAPOLY;
3014 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003015 default:
3016 return( NULL );
3017 }
3018 }
3019 else if( alg == PSA_ALG_CMAC )
3020 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003021 else
3022 return( NULL );
3023
3024 switch( key_type )
3025 {
3026 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03003027 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003028 break;
3029 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003030 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
3031 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003032 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03003033 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003034 else
mohammad1603f4f0d612018-06-03 15:04:51 +03003035 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003036 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
3037 * but two-key Triple-DES is functionally three-key Triple-DES
3038 * with K1=K3, so that's how we present it to mbedtls. */
3039 if( key_bits == 128 )
3040 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003041 break;
3042 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03003043 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003044 break;
3045 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03003046 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003047 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02003048 case PSA_KEY_TYPE_CHACHA20:
3049 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
3050 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003051 default:
3052 return( NULL );
3053 }
mohammad1603f4f0d612018-06-03 15:04:51 +03003054 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03003055 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003056
Jaeden Amero23bbb752018-06-26 14:16:54 +01003057 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
3058 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003059}
3060
John Durkop6ba40d12020-11-10 08:50:04 -08003061#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003062static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003063{
Gilles Peskine2d277862018-06-18 15:41:12 +02003064 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003065 {
3066 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003067 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003068 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003069 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003070 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003071 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003072 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003073 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003074 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003075 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003076 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003077 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003078 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003079 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003080 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003081 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003082 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02003083 return( 128 );
3084 default:
3085 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003086 }
3087}
John Durkop07cc04a2020-11-16 22:08:34 -08003088#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03003089
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003090/* Initialize the MAC operation structure. Once this function has been
3091 * called, psa_mac_abort can run and will do the right thing. */
3092static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
3093 psa_algorithm_t alg )
3094{
3095 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
3096
3097 operation->alg = alg;
3098 operation->key_set = 0;
3099 operation->iv_set = 0;
3100 operation->iv_required = 0;
3101 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003102 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003103
3104#if defined(MBEDTLS_CMAC_C)
3105 if( alg == PSA_ALG_CMAC )
3106 {
3107 operation->iv_required = 0;
3108 mbedtls_cipher_init( &operation->ctx.cmac );
3109 status = PSA_SUCCESS;
3110 }
3111 else
3112#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003113#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003114 if( PSA_ALG_IS_HMAC( operation->alg ) )
3115 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02003116 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
3117 operation->ctx.hmac.hash_ctx.alg = 0;
3118 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003119 }
3120 else
John Durkopd0321952020-10-29 21:37:36 -07003121#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003122 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02003123 if( ! PSA_ALG_IS_MAC( alg ) )
3124 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003125 }
3126
3127 if( status != PSA_SUCCESS )
3128 memset( operation, 0, sizeof( *operation ) );
3129 return( status );
3130}
3131
John Durkop6ba40d12020-11-10 08:50:04 -08003132#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003133static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
3134{
Gilles Peskine3f108122018-12-07 18:14:53 +01003135 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003136 return( psa_hash_abort( &hmac->hash_ctx ) );
3137}
John Durkop6ba40d12020-11-10 08:50:04 -08003138#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003139
Gilles Peskine8c9def32018-02-08 10:02:12 +01003140psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
3141{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003142 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003143 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003144 /* The object has (apparently) been initialized but it is not
3145 * in use. It's ok to call abort on such an object, and there's
3146 * nothing to do. */
3147 return( PSA_SUCCESS );
3148 }
3149 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003150#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003151 if( operation->alg == PSA_ALG_CMAC )
3152 {
3153 mbedtls_cipher_free( &operation->ctx.cmac );
3154 }
3155 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003156#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003157#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003158 if( PSA_ALG_IS_HMAC( operation->alg ) )
3159 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003160 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003161 }
3162 else
John Durkopd0321952020-10-29 21:37:36 -07003163#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003164 {
3165 /* Sanity check (shouldn't happen: operation->alg should
3166 * always have been initialized to a valid value). */
3167 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003168 }
Moran Peker41deec42018-04-04 15:43:05 +03003169
Gilles Peskine8c9def32018-02-08 10:02:12 +01003170 operation->alg = 0;
3171 operation->key_set = 0;
3172 operation->iv_set = 0;
3173 operation->iv_required = 0;
3174 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003175 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003176
Gilles Peskine8c9def32018-02-08 10:02:12 +01003177 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003178
3179bad_state:
3180 /* If abort is called on an uninitialized object, we can't trust
3181 * anything. Wipe the object in case it contains confidential data.
3182 * This may result in a memory leak if a pointer gets overwritten,
3183 * but it's too late to do anything about this. */
3184 memset( operation, 0, sizeof( *operation ) );
3185 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003186}
3187
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003188#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003189static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003190 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003191 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003192 const mbedtls_cipher_info_t *cipher_info )
3193{
Janos Follath24eed8d2019-11-22 13:21:35 +00003194 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003195
3196 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003197
3198 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3199 if( ret != 0 )
3200 return( ret );
3201
3202 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003203 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003204 key_bits );
3205 return( ret );
3206}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003207#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003208
John Durkop6ba40d12020-11-10 08:50:04 -08003209#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003210static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3211 const uint8_t *key,
3212 size_t key_length,
3213 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003214{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003215 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003216 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003217 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003218 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003219 psa_status_t status;
3220
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003221 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3222 * overflow below. This should never trigger if the hash algorithm
3223 * is implemented correctly. */
3224 /* The size checks against the ipad and opad buffers cannot be written
3225 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3226 * because that triggers -Wlogical-op on GCC 7.3. */
3227 if( block_size > sizeof( ipad ) )
3228 return( PSA_ERROR_NOT_SUPPORTED );
3229 if( block_size > sizeof( hmac->opad ) )
3230 return( PSA_ERROR_NOT_SUPPORTED );
3231 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003232 return( PSA_ERROR_NOT_SUPPORTED );
3233
Gilles Peskined223b522018-06-11 18:12:58 +02003234 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003235 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003236 status = psa_hash_compute( hash_alg, key, key_length,
3237 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003238 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003239 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003240 }
Gilles Peskine96889972018-07-12 17:07:03 +02003241 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3242 * but it is permitted. It is common when HMAC is used in HKDF, for
3243 * example. Don't call `memcpy` in the 0-length because `key` could be
3244 * an invalid pointer which would make the behavior undefined. */
3245 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003246 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003247
Gilles Peskined223b522018-06-11 18:12:58 +02003248 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3249 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003250 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003251 ipad[i] ^= 0x36;
3252 memset( ipad + key_length, 0x36, block_size - key_length );
3253
3254 /* Copy the key material from ipad to opad, flipping the requisite bits,
3255 * and filling the rest of opad with the requisite constant. */
3256 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003257 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3258 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003259
Gilles Peskine01126fa2018-07-12 17:04:55 +02003260 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003261 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003262 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003263
Gilles Peskine01126fa2018-07-12 17:04:55 +02003264 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003265
3266cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003267 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003268
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003269 return( status );
3270}
John Durkop6ba40d12020-11-10 08:50:04 -08003271#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003272
Gilles Peskine89167cb2018-07-08 20:12:23 +02003273static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003274 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003275 psa_algorithm_t alg,
3276 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003277{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003278 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003279 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003280 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003281 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003282 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003283 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003284 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003285 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003286
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003287 /* A context must be freshly initialized before it can be set up. */
3288 if( operation->alg != 0 )
3289 {
3290 return( PSA_ERROR_BAD_STATE );
3291 }
3292
Gilles Peskined911eb72018-08-14 15:18:45 +02003293 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003294 if( status != PSA_SUCCESS )
3295 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003296 if( is_sign )
3297 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003298
Ronald Cron5c522922020-11-14 16:35:34 +01003299 status = psa_get_and_lock_transparent_key_slot_with_policy(
3300 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003301 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003302 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003303 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003304
Gilles Peskine8c9def32018-02-08 10:02:12 +01003305#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003306 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003307 {
3308 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003309 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003310 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003312 if( cipher_info == NULL )
3313 {
3314 status = PSA_ERROR_NOT_SUPPORTED;
3315 goto exit;
3316 }
3317 operation->mac_size = cipher_info->block_size;
3318 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3319 status = mbedtls_to_psa_error( ret );
3320 }
3321 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003322#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003323#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02003324 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003325 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003326 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003327 if( hash_alg == 0 )
3328 {
3329 status = PSA_ERROR_NOT_SUPPORTED;
3330 goto exit;
3331 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003332
3333 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3334 /* Sanity check. This shouldn't fail on a valid configuration. */
3335 if( operation->mac_size == 0 ||
3336 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3337 {
3338 status = PSA_ERROR_NOT_SUPPORTED;
3339 goto exit;
3340 }
3341
Gilles Peskine8e338702019-07-30 20:06:31 +02003342 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003343 {
3344 status = PSA_ERROR_INVALID_ARGUMENT;
3345 goto exit;
3346 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003347
Gilles Peskine01126fa2018-07-12 17:04:55 +02003348 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003349 slot->data.key.data,
3350 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003351 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003352 }
3353 else
John Durkopd0321952020-10-29 21:37:36 -07003354#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003355 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003356 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003357 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003358 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003359
Gilles Peskined911eb72018-08-14 15:18:45 +02003360 if( truncated == 0 )
3361 {
3362 /* The "normal" case: untruncated algorithm. Nothing to do. */
3363 }
3364 else if( truncated < 4 )
3365 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003366 /* A very short MAC is too short for security since it can be
3367 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3368 * so we make this our minimum, even though 32 bits is still
3369 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003370 status = PSA_ERROR_NOT_SUPPORTED;
3371 }
3372 else if( truncated > operation->mac_size )
3373 {
3374 /* It's impossible to "truncate" to a larger length. */
3375 status = PSA_ERROR_INVALID_ARGUMENT;
3376 }
3377 else
3378 operation->mac_size = truncated;
3379
Gilles Peskinefbfac682018-07-08 20:51:54 +02003380exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003381 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003382 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003383 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003384 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003385 else
3386 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003387 operation->key_set = 1;
3388 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003389
Ronald Cron5c522922020-11-14 16:35:34 +01003390 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003391
Ronald Cron5c522922020-11-14 16:35:34 +01003392 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003393}
3394
Gilles Peskine89167cb2018-07-08 20:12:23 +02003395psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003396 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003397 psa_algorithm_t alg )
3398{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003399 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003400}
3401
3402psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003403 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003404 psa_algorithm_t alg )
3405{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003406 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003407}
3408
Gilles Peskine8c9def32018-02-08 10:02:12 +01003409psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3410 const uint8_t *input,
3411 size_t input_length )
3412{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003413 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003414 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003415 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003416 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003417 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003418 operation->has_input = 1;
3419
Gilles Peskine8c9def32018-02-08 10:02:12 +01003420#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003421 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003422 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003423 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3424 input, input_length );
3425 status = mbedtls_to_psa_error( ret );
3426 }
3427 else
3428#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003429#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003430 if( PSA_ALG_IS_HMAC( operation->alg ) )
3431 {
3432 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3433 input_length );
3434 }
3435 else
John Durkopd0321952020-10-29 21:37:36 -07003436#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003437 {
3438 /* This shouldn't happen if `operation` was initialized by
3439 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003440 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003441 }
3442
Gilles Peskinefbfac682018-07-08 20:51:54 +02003443 if( status != PSA_SUCCESS )
3444 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003445 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003446}
3447
John Durkop6ba40d12020-11-10 08:50:04 -08003448#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003449static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3450 uint8_t *mac,
3451 size_t mac_size )
3452{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003453 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003454 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3455 size_t hash_size = 0;
3456 size_t block_size = psa_get_hash_block_size( hash_alg );
3457 psa_status_t status;
3458
Gilles Peskine01126fa2018-07-12 17:04:55 +02003459 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3460 if( status != PSA_SUCCESS )
3461 return( status );
3462 /* From here on, tmp needs to be wiped. */
3463
3464 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3465 if( status != PSA_SUCCESS )
3466 goto exit;
3467
3468 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3469 if( status != PSA_SUCCESS )
3470 goto exit;
3471
3472 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3473 if( status != PSA_SUCCESS )
3474 goto exit;
3475
Gilles Peskined911eb72018-08-14 15:18:45 +02003476 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3477 if( status != PSA_SUCCESS )
3478 goto exit;
3479
3480 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003481
3482exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003483 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003484 return( status );
3485}
John Durkop6ba40d12020-11-10 08:50:04 -08003486#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003487
mohammad16036df908f2018-04-02 08:34:15 -07003488static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003489 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003490 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003491{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003492 if( ! operation->key_set )
3493 return( PSA_ERROR_BAD_STATE );
3494 if( operation->iv_required && ! operation->iv_set )
3495 return( PSA_ERROR_BAD_STATE );
3496
Gilles Peskine8c9def32018-02-08 10:02:12 +01003497 if( mac_size < operation->mac_size )
3498 return( PSA_ERROR_BUFFER_TOO_SMALL );
3499
Gilles Peskine8c9def32018-02-08 10:02:12 +01003500#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003501 if( operation->alg == PSA_ALG_CMAC )
3502 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003503 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3504 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3505 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003506 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003507 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003508 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003509 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003510 else
3511#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003512#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003513 if( PSA_ALG_IS_HMAC( operation->alg ) )
3514 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003515 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003516 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003517 }
3518 else
John Durkopd0321952020-10-29 21:37:36 -07003519#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003520 {
3521 /* This shouldn't happen if `operation` was initialized by
3522 * a setup function. */
3523 return( PSA_ERROR_BAD_STATE );
3524 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003525}
3526
Gilles Peskineacd4be32018-07-08 19:56:25 +02003527psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3528 uint8_t *mac,
3529 size_t mac_size,
3530 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003531{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003532 psa_status_t status;
3533
Jaeden Amero252ef282019-02-15 14:05:35 +00003534 if( operation->alg == 0 )
3535 {
3536 return( PSA_ERROR_BAD_STATE );
3537 }
3538
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003539 /* Fill the output buffer with something that isn't a valid mac
3540 * (barring an attack on the mac and deliberately-crafted input),
3541 * in case the caller doesn't check the return status properly. */
3542 *mac_length = mac_size;
3543 /* If mac_size is 0 then mac may be NULL and then the
3544 * call to memset would have undefined behavior. */
3545 if( mac_size != 0 )
3546 memset( mac, '!', mac_size );
3547
Gilles Peskine89167cb2018-07-08 20:12:23 +02003548 if( ! operation->is_sign )
3549 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003550 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003551 }
mohammad16036df908f2018-04-02 08:34:15 -07003552
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003553 status = psa_mac_finish_internal( operation, mac, mac_size );
3554
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003555 if( status == PSA_SUCCESS )
3556 {
3557 status = psa_mac_abort( operation );
3558 if( status == PSA_SUCCESS )
3559 *mac_length = operation->mac_size;
3560 else
3561 memset( mac, '!', mac_size );
3562 }
3563 else
3564 psa_mac_abort( operation );
3565 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003566}
3567
Gilles Peskineacd4be32018-07-08 19:56:25 +02003568psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3569 const uint8_t *mac,
3570 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003571{
Gilles Peskine828ed142018-06-18 23:25:51 +02003572 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003573 psa_status_t status;
3574
Jaeden Amero252ef282019-02-15 14:05:35 +00003575 if( operation->alg == 0 )
3576 {
3577 return( PSA_ERROR_BAD_STATE );
3578 }
3579
Gilles Peskine89167cb2018-07-08 20:12:23 +02003580 if( operation->is_sign )
3581 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003582 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003583 }
3584 if( operation->mac_size != mac_length )
3585 {
3586 status = PSA_ERROR_INVALID_SIGNATURE;
3587 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003588 }
mohammad16036df908f2018-04-02 08:34:15 -07003589
3590 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003591 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003592 if( status != PSA_SUCCESS )
3593 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003594
3595 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3596 status = PSA_ERROR_INVALID_SIGNATURE;
3597
3598cleanup:
3599 if( status == PSA_SUCCESS )
3600 status = psa_mac_abort( operation );
3601 else
3602 psa_mac_abort( operation );
3603
Gilles Peskine3f108122018-12-07 18:14:53 +01003604 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003605
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003606 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003607}
3608
3609
Gilles Peskine20035e32018-02-03 22:44:14 +01003610
Gilles Peskine20035e32018-02-03 22:44:14 +01003611/****************************************************************/
3612/* Asymmetric cryptography */
3613/****************************************************************/
3614
John Durkop6ba40d12020-11-10 08:50:04 -08003615#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3616 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003617/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003618 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003619static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3620 size_t hash_length,
3621 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003622{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003623 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003624 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003625 *md_alg = mbedtls_md_get_type( md_info );
3626
3627 /* The Mbed TLS RSA module uses an unsigned int for hash length
3628 * parameters. Validate that it fits so that we don't risk an
3629 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003630#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003631 if( hash_length > UINT_MAX )
3632 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003633#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003634
John Durkop0e005192020-10-31 22:06:54 -07003635#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003636 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3637 * must be correct. */
3638 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3639 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003640 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003641 if( md_info == NULL )
3642 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003643 if( mbedtls_md_get_size( md_info ) != hash_length )
3644 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003645 }
John Durkop0e005192020-10-31 22:06:54 -07003646#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003647
John Durkop0e005192020-10-31 22:06:54 -07003648#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003649 /* PSS requires a hash internally. */
3650 if( PSA_ALG_IS_RSA_PSS( alg ) )
3651 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003652 if( md_info == NULL )
3653 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003654 }
John Durkop0e005192020-10-31 22:06:54 -07003655#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003656
Gilles Peskine61b91d42018-06-08 16:09:36 +02003657 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003658}
3659
Gilles Peskine2b450e32018-06-27 15:42:46 +02003660static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3661 psa_algorithm_t alg,
3662 const uint8_t *hash,
3663 size_t hash_length,
3664 uint8_t *signature,
3665 size_t signature_size,
3666 size_t *signature_length )
3667{
3668 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003669 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003670 mbedtls_md_type_t md_alg;
3671
3672 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3673 if( status != PSA_SUCCESS )
3674 return( status );
3675
Gilles Peskine630a18a2018-06-29 17:49:35 +02003676 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003677 return( PSA_ERROR_BUFFER_TOO_SMALL );
3678
John Durkop0e005192020-10-31 22:06:54 -07003679#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003680 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3681 {
3682 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3683 MBEDTLS_MD_NONE );
3684 ret = mbedtls_rsa_pkcs1_sign( rsa,
3685 mbedtls_ctr_drbg_random,
3686 &global_data.ctr_drbg,
3687 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003688 md_alg,
3689 (unsigned int) hash_length,
3690 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003691 signature );
3692 }
3693 else
John Durkop0e005192020-10-31 22:06:54 -07003694#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3695#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003696 if( PSA_ALG_IS_RSA_PSS( alg ) )
3697 {
3698 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3699 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3700 mbedtls_ctr_drbg_random,
3701 &global_data.ctr_drbg,
3702 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003703 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003704 (unsigned int) hash_length,
3705 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003706 signature );
3707 }
3708 else
John Durkop0e005192020-10-31 22:06:54 -07003709#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003710 {
3711 return( PSA_ERROR_INVALID_ARGUMENT );
3712 }
3713
3714 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003715 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003716 return( mbedtls_to_psa_error( ret ) );
3717}
3718
3719static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3720 psa_algorithm_t alg,
3721 const uint8_t *hash,
3722 size_t hash_length,
3723 const uint8_t *signature,
3724 size_t signature_length )
3725{
3726 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003727 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003728 mbedtls_md_type_t md_alg;
3729
3730 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3731 if( status != PSA_SUCCESS )
3732 return( status );
3733
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003734 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3735 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003736
John Durkop0e005192020-10-31 22:06:54 -07003737#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003738 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3739 {
3740 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3741 MBEDTLS_MD_NONE );
3742 ret = mbedtls_rsa_pkcs1_verify( rsa,
3743 mbedtls_ctr_drbg_random,
3744 &global_data.ctr_drbg,
3745 MBEDTLS_RSA_PUBLIC,
3746 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003747 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003748 hash,
3749 signature );
3750 }
3751 else
John Durkop0e005192020-10-31 22:06:54 -07003752#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3753#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003754 if( PSA_ALG_IS_RSA_PSS( alg ) )
3755 {
3756 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3757 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3758 mbedtls_ctr_drbg_random,
3759 &global_data.ctr_drbg,
3760 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003761 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003762 (unsigned int) hash_length,
3763 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003764 signature );
3765 }
3766 else
John Durkop0e005192020-10-31 22:06:54 -07003767#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003768 {
3769 return( PSA_ERROR_INVALID_ARGUMENT );
3770 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003771
3772 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3773 * the rest of the signature is invalid". This has little use in
3774 * practice and PSA doesn't report this distinction. */
3775 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3776 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003777 return( mbedtls_to_psa_error( ret ) );
3778}
John Durkop6ba40d12020-11-10 08:50:04 -08003779#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3780 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003781
John Durkop6ba40d12020-11-10 08:50:04 -08003782#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3783 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003784/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3785 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3786 * (even though these functions don't modify it). */
3787static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3788 psa_algorithm_t alg,
3789 const uint8_t *hash,
3790 size_t hash_length,
3791 uint8_t *signature,
3792 size_t signature_size,
3793 size_t *signature_length )
3794{
Janos Follath24eed8d2019-11-22 13:21:35 +00003795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003796 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003797 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003798 mbedtls_mpi_init( &r );
3799 mbedtls_mpi_init( &s );
3800
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003801 if( signature_size < 2 * curve_bytes )
3802 {
3803 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3804 goto cleanup;
3805 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003806
John Durkop0ea39e02020-10-13 19:58:20 -07003807#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003808 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3809 {
3810 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3811 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3812 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003813 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3814 &ecp->d, hash,
3815 hash_length, md_alg,
3816 mbedtls_ctr_drbg_random,
3817 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003818 }
3819 else
John Durkop0ea39e02020-10-13 19:58:20 -07003820#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003821 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003822 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003823 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3824 hash, hash_length,
3825 mbedtls_ctr_drbg_random,
3826 &global_data.ctr_drbg ) );
3827 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003828
3829 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3830 signature,
3831 curve_bytes ) );
3832 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3833 signature + curve_bytes,
3834 curve_bytes ) );
3835
3836cleanup:
3837 mbedtls_mpi_free( &r );
3838 mbedtls_mpi_free( &s );
3839 if( ret == 0 )
3840 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003841 return( mbedtls_to_psa_error( ret ) );
3842}
3843
3844static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3845 const uint8_t *hash,
3846 size_t hash_length,
3847 const uint8_t *signature,
3848 size_t signature_length )
3849{
Janos Follath24eed8d2019-11-22 13:21:35 +00003850 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003851 mbedtls_mpi r, s;
3852 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3853 mbedtls_mpi_init( &r );
3854 mbedtls_mpi_init( &s );
3855
3856 if( signature_length != 2 * curve_bytes )
3857 return( PSA_ERROR_INVALID_SIGNATURE );
3858
3859 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3860 signature,
3861 curve_bytes ) );
3862 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3863 signature + curve_bytes,
3864 curve_bytes ) );
3865
Steven Cooremanacda8342020-07-24 23:09:52 +02003866 /* Check whether the public part is loaded. If not, load it. */
3867 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3868 {
3869 MBEDTLS_MPI_CHK(
3870 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3871 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3872 }
3873
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003874 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3875 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003876
3877cleanup:
3878 mbedtls_mpi_free( &r );
3879 mbedtls_mpi_free( &s );
3880 return( mbedtls_to_psa_error( ret ) );
3881}
John Durkop6ba40d12020-11-10 08:50:04 -08003882#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3883 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003884
Ronald Croncf56a0a2020-08-04 09:51:30 +02003885psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003886 psa_algorithm_t alg,
3887 const uint8_t *hash,
3888 size_t hash_length,
3889 uint8_t *signature,
3890 size_t signature_size,
3891 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003892{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003894 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003895 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003896
3897 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003898 /* Immediately reject a zero-length signature buffer. This guarantees
3899 * that signature must be a valid pointer. (On the other hand, the hash
3900 * buffer can in principle be empty since it doesn't actually have
3901 * to be a hash.) */
3902 if( signature_size == 0 )
3903 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003904
Ronald Cron5c522922020-11-14 16:35:34 +01003905 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3906 PSA_KEY_USAGE_SIGN_HASH,
3907 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003908 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003909 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003910 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003911 {
3912 status = PSA_ERROR_INVALID_ARGUMENT;
3913 goto exit;
3914 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003915
Steven Cooremancd84cb42020-07-16 20:28:36 +02003916 /* Try any of the available accelerators first */
3917 status = psa_driver_wrapper_sign_hash( slot,
3918 alg,
3919 hash,
3920 hash_length,
3921 signature,
3922 signature_size,
3923 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003924 if( status != PSA_ERROR_NOT_SUPPORTED ||
3925 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003926 goto exit;
3927
Steven Cooreman7a250572020-07-17 16:43:05 +02003928 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003929#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3930 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003931 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003932 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003933 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003934
Steven Cooreman4fed4552020-08-03 14:46:03 +02003935 status = psa_load_rsa_representation( slot->attr.type,
3936 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003937 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003938 &rsa );
3939 if( status != PSA_SUCCESS )
3940 goto exit;
3941
Steven Cooremana2371e52020-07-28 14:30:39 +02003942 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003943 alg,
3944 hash, hash_length,
3945 signature, signature_size,
3946 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003947
Steven Cooremana2371e52020-07-28 14:30:39 +02003948 mbedtls_rsa_free( rsa );
3949 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003950 }
3951 else
John Durkop6ba40d12020-11-10 08:50:04 -08003952#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3953 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003954 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003955 {
John Durkop9814fa22020-11-04 12:28:15 -08003956#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3957 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003958 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003959#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003960 PSA_ALG_IS_ECDSA( alg )
3961#else
3962 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3963#endif
3964 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003965 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003966 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003967 status = psa_load_ecp_representation( slot->attr.type,
3968 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003969 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003970 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003971 if( status != PSA_SUCCESS )
3972 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003973 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003974 alg,
3975 hash, hash_length,
3976 signature, signature_size,
3977 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003978 mbedtls_ecp_keypair_free( ecp );
3979 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003980 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003981 else
John Durkop9814fa22020-11-04 12:28:15 -08003982#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3983 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003984 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003985 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003986 }
itayzafrir5c753392018-05-08 11:18:38 +03003987 }
3988 else
itayzafrir5c753392018-05-08 11:18:38 +03003989 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003990 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003991 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003992
3993exit:
3994 /* Fill the unused part of the output buffer (the whole buffer on error,
3995 * the trailing part on success) with something that isn't a valid mac
3996 * (barring an attack on the mac and deliberately-crafted input),
3997 * in case the caller doesn't check the return status properly. */
3998 if( status == PSA_SUCCESS )
3999 memset( signature + *signature_length, '!',
4000 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02004001 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02004002 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004003 /* If signature_size is 0 then we have nothing to do. We must not call
4004 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02004005
Ronald Cron5c522922020-11-14 16:35:34 +01004006 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004007
Ronald Cron5c522922020-11-14 16:35:34 +01004008 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03004009}
4010
Ronald Croncf56a0a2020-08-04 09:51:30 +02004011psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004012 psa_algorithm_t alg,
4013 const uint8_t *hash,
4014 size_t hash_length,
4015 const uint8_t *signature,
4016 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03004017{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004018 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004019 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004020 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02004021
Ronald Cron5c522922020-11-14 16:35:34 +01004022 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
4023 PSA_KEY_USAGE_VERIFY_HASH,
4024 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004025 if( status != PSA_SUCCESS )
4026 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03004027
Steven Cooreman55ae2172020-07-17 19:46:15 +02004028 /* Try any of the available accelerators first */
4029 status = psa_driver_wrapper_verify_hash( slot,
4030 alg,
4031 hash,
4032 hash_length,
4033 signature,
4034 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02004035 if( status != PSA_ERROR_NOT_SUPPORTED ||
4036 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004037 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02004038
John Durkop6ba40d12020-11-10 08:50:04 -08004039#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
4040 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02004041 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004042 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004043 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02004044
Steven Cooreman4fed4552020-08-03 14:46:03 +02004045 status = psa_load_rsa_representation( slot->attr.type,
4046 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004047 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004048 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004049 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004050 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004051
Steven Cooremana2371e52020-07-28 14:30:39 +02004052 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02004053 alg,
4054 hash, hash_length,
4055 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004056 mbedtls_rsa_free( rsa );
4057 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004058 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004059 }
4060 else
John Durkop6ba40d12020-11-10 08:50:04 -08004061#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
4062 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02004063 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03004064 {
John Durkop9814fa22020-11-04 12:28:15 -08004065#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4066 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004067 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02004068 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004069 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004070 status = psa_load_ecp_representation( slot->attr.type,
4071 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004072 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004073 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004074 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004075 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004076 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004077 hash, hash_length,
4078 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004079 mbedtls_ecp_keypair_free( ecp );
4080 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004081 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02004082 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004083 else
John Durkop9814fa22020-11-04 12:28:15 -08004084#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4085 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004086 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004087 status = PSA_ERROR_INVALID_ARGUMENT;
4088 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004089 }
itayzafrir5c753392018-05-08 11:18:38 +03004090 }
Gilles Peskine20035e32018-02-03 22:44:14 +01004091 else
Gilles Peskine20035e32018-02-03 22:44:14 +01004092 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004093 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01004094 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004095
4096exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004097 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004098
Ronald Cron5c522922020-11-14 16:35:34 +01004099 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01004100}
4101
John Durkop0e005192020-10-31 22:06:54 -07004102#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02004103static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
4104 mbedtls_rsa_context *rsa )
4105{
4106 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
4107 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
4108 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
4109 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
4110}
John Durkop0e005192020-10-31 22:06:54 -07004111#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02004112
Ronald Croncf56a0a2020-08-04 09:51:30 +02004113psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004114 psa_algorithm_t alg,
4115 const uint8_t *input,
4116 size_t input_length,
4117 const uint8_t *salt,
4118 size_t salt_length,
4119 uint8_t *output,
4120 size_t output_size,
4121 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004122{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004123 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004124 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004125 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004126
Darryl Green5cc689a2018-07-24 15:34:10 +01004127 (void) input;
4128 (void) input_length;
4129 (void) salt;
4130 (void) output;
4131 (void) output_size;
4132
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004133 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004134
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004135 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4136 return( PSA_ERROR_INVALID_ARGUMENT );
4137
Ronald Cron5c522922020-11-14 16:35:34 +01004138 status = psa_get_and_lock_transparent_key_slot_with_policy(
4139 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004140 if( status != PSA_SUCCESS )
4141 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004142 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4143 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004144 {
4145 status = PSA_ERROR_INVALID_ARGUMENT;
4146 goto exit;
4147 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004148
John Durkop6ba40d12020-11-10 08:50:04 -08004149#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4150 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004151 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004152 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004153 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004154 status = psa_load_rsa_representation( slot->attr.type,
4155 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004156 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004157 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004158 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004159 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004160
4161 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004162 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004163 status = PSA_ERROR_BUFFER_TOO_SMALL;
4164 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004165 }
John Durkop0e005192020-10-31 22:06:54 -07004166#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004167 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004168 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004169 status = mbedtls_to_psa_error(
4170 mbedtls_rsa_pkcs1_encrypt( rsa,
4171 mbedtls_ctr_drbg_random,
4172 &global_data.ctr_drbg,
4173 MBEDTLS_RSA_PUBLIC,
4174 input_length,
4175 input,
4176 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004177 }
4178 else
John Durkop0e005192020-10-31 22:06:54 -07004179#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4180#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004181 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004182 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004183 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004184 status = mbedtls_to_psa_error(
4185 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
4186 mbedtls_ctr_drbg_random,
4187 &global_data.ctr_drbg,
4188 MBEDTLS_RSA_PUBLIC,
4189 salt, salt_length,
4190 input_length,
4191 input,
4192 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004193 }
4194 else
John Durkop0e005192020-10-31 22:06:54 -07004195#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004196 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004197 status = PSA_ERROR_INVALID_ARGUMENT;
4198 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004199 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004200rsa_exit:
4201 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004202 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004203
Steven Cooremana2371e52020-07-28 14:30:39 +02004204 mbedtls_rsa_free( rsa );
4205 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004206 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004207 else
John Durkop9814fa22020-11-04 12:28:15 -08004208#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08004209 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004210 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004211 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004212 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004213
4214exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004215 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004216
Ronald Cron5c522922020-11-14 16:35:34 +01004217 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004218}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004219
Ronald Croncf56a0a2020-08-04 09:51:30 +02004220psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004221 psa_algorithm_t alg,
4222 const uint8_t *input,
4223 size_t input_length,
4224 const uint8_t *salt,
4225 size_t salt_length,
4226 uint8_t *output,
4227 size_t output_size,
4228 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004229{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004231 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004232 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004233
Darryl Green5cc689a2018-07-24 15:34:10 +01004234 (void) input;
4235 (void) input_length;
4236 (void) salt;
4237 (void) output;
4238 (void) output_size;
4239
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004240 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004241
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004242 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4243 return( PSA_ERROR_INVALID_ARGUMENT );
4244
Ronald Cron5c522922020-11-14 16:35:34 +01004245 status = psa_get_and_lock_transparent_key_slot_with_policy(
4246 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004247 if( status != PSA_SUCCESS )
4248 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004249 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004250 {
4251 status = PSA_ERROR_INVALID_ARGUMENT;
4252 goto exit;
4253 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004254
John Durkop6ba40d12020-11-10 08:50:04 -08004255#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4256 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004257 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004258 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004259 mbedtls_rsa_context *rsa = NULL;
4260 status = psa_load_rsa_representation( slot->attr.type,
4261 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004262 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004263 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004264 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004265 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004266
Steven Cooremana2371e52020-07-28 14:30:39 +02004267 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004268 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004269 status = PSA_ERROR_INVALID_ARGUMENT;
4270 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004271 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004272
John Durkop0e005192020-10-31 22:06:54 -07004273#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004274 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004275 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004276 status = mbedtls_to_psa_error(
4277 mbedtls_rsa_pkcs1_decrypt( rsa,
4278 mbedtls_ctr_drbg_random,
4279 &global_data.ctr_drbg,
4280 MBEDTLS_RSA_PRIVATE,
4281 output_length,
4282 input,
4283 output,
4284 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004285 }
4286 else
John Durkop0e005192020-10-31 22:06:54 -07004287#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4288#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004289 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004290 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004291 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004292 status = mbedtls_to_psa_error(
4293 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4294 mbedtls_ctr_drbg_random,
4295 &global_data.ctr_drbg,
4296 MBEDTLS_RSA_PRIVATE,
4297 salt, salt_length,
4298 output_length,
4299 input,
4300 output,
4301 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004302 }
4303 else
John Durkop0e005192020-10-31 22:06:54 -07004304#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004305 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004306 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004307 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004308
Steven Cooreman4fed4552020-08-03 14:46:03 +02004309rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004310 mbedtls_rsa_free( rsa );
4311 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004312 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004313 else
John Durkop6ba40d12020-11-10 08:50:04 -08004314#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
4315 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004316 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004317 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004318 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004319
4320exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004321 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004322
Ronald Cron5c522922020-11-14 16:35:34 +01004323 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004324}
Gilles Peskine20035e32018-02-03 22:44:14 +01004325
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004326
4327
mohammad1603503973b2018-03-12 15:59:30 +02004328/****************************************************************/
4329/* Symmetric cryptography */
4330/****************************************************************/
4331
Gilles Peskinee553c652018-06-04 16:22:46 +02004332static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004333 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004334 psa_algorithm_t alg,
4335 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004336{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004337 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004338 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004339 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004340 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004341 size_t key_bits;
4342 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004343 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4344 PSA_KEY_USAGE_ENCRYPT :
4345 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004346
Steven Cooremand3feccd2020-09-01 15:56:14 +02004347 /* A context must be freshly initialized before it can be set up. */
4348 if( operation->alg != 0 )
4349 return( PSA_ERROR_BAD_STATE );
4350
Steven Cooremana07b9972020-09-10 14:54:14 +02004351 /* The requested algorithm must be one that can be processed by cipher. */
4352 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004353 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004354
Steven Cooremanef8575e2020-09-11 11:44:50 +02004355 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004356 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004357 if( status != PSA_SUCCESS )
4358 goto exit;
4359
4360 /* Initialize the operation struct members, except for alg. The alg member
4361 * is used to indicate to psa_cipher_abort that there are resources to free,
4362 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004363 operation->key_set = 0;
4364 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004365 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004366 operation->iv_size = 0;
4367 operation->block_size = 0;
4368 if( alg == PSA_ALG_ECB_NO_PADDING )
4369 operation->iv_required = 0;
4370 else
4371 operation->iv_required = 1;
4372
Steven Cooremana07b9972020-09-10 14:54:14 +02004373 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004374 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004375 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004376 slot,
4377 alg );
4378 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004379 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004380 slot,
4381 alg );
4382
Steven Cooremanef8575e2020-09-11 11:44:50 +02004383 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004384 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004385 /* Once the driver context is initialised, it needs to be freed using
4386 * psa_cipher_abort. Indicate this through setting alg. */
4387 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004388 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004389
Steven Cooremand3feccd2020-09-01 15:56:14 +02004390 if( status != PSA_ERROR_NOT_SUPPORTED ||
4391 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4392 goto exit;
4393
Steven Cooremana07b9972020-09-10 14:54:14 +02004394 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004395 * available for the given algorithm & key. */
4396 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004397
Steven Cooremana07b9972020-09-10 14:54:14 +02004398 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004399 * psa_cipher_abort. Indicate there is something to be freed through setting
4400 * alg, and indicate the operation is being done using mbedtls crypto through
4401 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004402 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004403 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004404
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004405 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004406 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004407 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004408 {
4409 status = PSA_ERROR_NOT_SUPPORTED;
4410 goto exit;
4411 }
mohammad1603503973b2018-03-12 15:59:30 +02004412
mohammad1603503973b2018-03-12 15:59:30 +02004413 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004414 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004415 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004416
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004417#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004418 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004419 {
4420 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004421 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004422 memcpy( keys, slot->data.key.data, 16 );
4423 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004424 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4425 keys,
4426 192, cipher_operation );
4427 }
4428 else
4429#endif
4430 {
4431 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004432 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004433 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004434 }
Moran Peker41deec42018-04-04 15:43:05 +03004435 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004436 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004437
mohammad16038481e742018-03-18 13:57:31 +02004438#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004439 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004440 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004441 case PSA_ALG_CBC_NO_PADDING:
4442 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4443 MBEDTLS_PADDING_NONE );
4444 break;
4445 case PSA_ALG_CBC_PKCS7:
4446 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4447 MBEDTLS_PADDING_PKCS7 );
4448 break;
4449 default:
4450 /* The algorithm doesn't involve padding. */
4451 ret = 0;
4452 break;
4453 }
4454 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004455 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004456#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4457
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004458 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004459 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004460 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4461 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004462 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004463 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004464 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004465#if defined(MBEDTLS_CHACHA20_C)
4466 else
4467 if( alg == PSA_ALG_CHACHA20 )
4468 operation->iv_size = 12;
4469#endif
mohammad1603503973b2018-03-12 15:59:30 +02004470
Steven Cooreman7df02922020-09-09 15:28:49 +02004471 status = PSA_SUCCESS;
4472
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004473exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004474 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004475 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004476 if( status == PSA_SUCCESS )
4477 {
4478 /* Update operation flags for both driver and software implementations */
4479 operation->key_set = 1;
4480 }
4481 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004482 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004483
Ronald Cron5c522922020-11-14 16:35:34 +01004484 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004485
Ronald Cron5c522922020-11-14 16:35:34 +01004486 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004487}
4488
Gilles Peskinefe119512018-07-08 21:39:34 +02004489psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004490 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004491 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004492{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004493 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004494}
4495
Gilles Peskinefe119512018-07-08 21:39:34 +02004496psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004497 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004498 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004499{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004500 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004501}
4502
Gilles Peskinefe119512018-07-08 21:39:34 +02004503psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004504 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004505 size_t iv_size,
4506 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004507{
itayzafrir534bd7c2018-08-02 13:56:32 +03004508 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004509 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004510 if( operation->iv_set || ! operation->iv_required )
4511 {
4512 return( PSA_ERROR_BAD_STATE );
4513 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004514
Steven Cooremanef8575e2020-09-11 11:44:50 +02004515 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004516 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004517 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004518 iv,
4519 iv_size,
4520 iv_length );
4521 goto exit;
4522 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004523
Moran Peker41deec42018-04-04 15:43:05 +03004524 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004525 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004526 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004527 goto exit;
4528 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004529 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4530 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004531 if( ret != 0 )
4532 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004533 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004534 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004535 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004536
mohammad16038481e742018-03-18 13:57:31 +02004537 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004538 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004539
Moran Peker395db872018-05-31 14:07:14 +03004540exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004541 if( status == PSA_SUCCESS )
4542 operation->iv_set = 1;
4543 else
Moran Peker395db872018-05-31 14:07:14 +03004544 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004545 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004546}
4547
Gilles Peskinefe119512018-07-08 21:39:34 +02004548psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004549 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004550 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004551{
itayzafrir534bd7c2018-08-02 13:56:32 +03004552 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004553 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004554 if( operation->iv_set || ! operation->iv_required )
4555 {
4556 return( PSA_ERROR_BAD_STATE );
4557 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004558
Steven Cooremanef8575e2020-09-11 11:44:50 +02004559 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004560 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004561 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004562 iv,
4563 iv_length );
4564 goto exit;
4565 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004566
Moran Pekera28258c2018-05-29 16:25:04 +03004567 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004568 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004569 status = PSA_ERROR_INVALID_ARGUMENT;
4570 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004571 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004572 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4573 status = mbedtls_to_psa_error( ret );
4574exit:
4575 if( status == PSA_SUCCESS )
4576 operation->iv_set = 1;
4577 else
mohammad1603503973b2018-03-12 15:59:30 +02004578 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004579 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004580}
4581
Steven Cooreman177deba2020-09-07 17:14:14 +02004582/* Process input for which the algorithm is set to ECB mode. This requires
4583 * manual processing, since the PSA API is defined as being able to process
4584 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4585 * underlying mbedtls_cipher_update only takes full blocks. */
4586static psa_status_t psa_cipher_update_ecb_internal(
4587 mbedtls_cipher_context_t *ctx,
4588 const uint8_t *input,
4589 size_t input_length,
4590 uint8_t *output,
4591 size_t output_size,
4592 size_t *output_length )
4593{
4594 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4595 size_t block_size = ctx->cipher_info->block_size;
4596 size_t internal_output_length = 0;
4597 *output_length = 0;
4598
4599 if( input_length == 0 )
4600 {
4601 status = PSA_SUCCESS;
4602 goto exit;
4603 }
4604
4605 if( ctx->unprocessed_len > 0 )
4606 {
4607 /* Fill up to block size, and run the block if there's a full one. */
4608 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4609
4610 if( input_length < bytes_to_copy )
4611 bytes_to_copy = input_length;
4612
4613 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4614 input, bytes_to_copy );
4615 input_length -= bytes_to_copy;
4616 input += bytes_to_copy;
4617 ctx->unprocessed_len += bytes_to_copy;
4618
4619 if( ctx->unprocessed_len == block_size )
4620 {
4621 status = mbedtls_to_psa_error(
4622 mbedtls_cipher_update( ctx,
4623 ctx->unprocessed_data,
4624 block_size,
4625 output, &internal_output_length ) );
4626
4627 if( status != PSA_SUCCESS )
4628 goto exit;
4629
4630 output += internal_output_length;
4631 output_size -= internal_output_length;
4632 *output_length += internal_output_length;
4633 ctx->unprocessed_len = 0;
4634 }
4635 }
4636
4637 while( input_length >= block_size )
4638 {
4639 /* Run all full blocks we have, one by one */
4640 status = mbedtls_to_psa_error(
4641 mbedtls_cipher_update( ctx, input,
4642 block_size,
4643 output, &internal_output_length ) );
4644
4645 if( status != PSA_SUCCESS )
4646 goto exit;
4647
4648 input_length -= block_size;
4649 input += block_size;
4650
4651 output += internal_output_length;
4652 output_size -= internal_output_length;
4653 *output_length += internal_output_length;
4654 }
4655
4656 if( input_length > 0 )
4657 {
4658 /* Save unprocessed bytes for later processing */
4659 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4660 input, input_length );
4661 ctx->unprocessed_len += input_length;
4662 }
4663
4664 status = PSA_SUCCESS;
4665
4666exit:
4667 return( status );
4668}
4669
Gilles Peskinee553c652018-06-04 16:22:46 +02004670psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4671 const uint8_t *input,
4672 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004673 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004674 size_t output_size,
4675 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004676{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004677 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004678 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004679 if( operation->alg == 0 )
4680 {
4681 return( PSA_ERROR_BAD_STATE );
4682 }
4683 if( operation->iv_required && ! operation->iv_set )
4684 {
4685 return( PSA_ERROR_BAD_STATE );
4686 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004687
Steven Cooremanef8575e2020-09-11 11:44:50 +02004688 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004689 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004690 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004691 input,
4692 input_length,
4693 output,
4694 output_size,
4695 output_length );
4696 goto exit;
4697 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004698
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004699 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004700 {
4701 /* Take the unprocessed partial block left over from previous
4702 * update calls, if any, plus the input to this call. Remove
4703 * the last partial block, if any. You get the data that will be
4704 * output in this call. */
4705 expected_output_size =
4706 ( operation->ctx.cipher.unprocessed_len + input_length )
4707 / operation->block_size * operation->block_size;
4708 }
4709 else
4710 {
4711 expected_output_size = input_length;
4712 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004713
Gilles Peskine89d789c2018-06-04 17:17:16 +02004714 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004715 {
4716 status = PSA_ERROR_BUFFER_TOO_SMALL;
4717 goto exit;
4718 }
mohammad160382759612018-03-12 18:16:40 +02004719
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004720 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4721 {
4722 /* mbedtls_cipher_update has an API inconsistency: it will only
4723 * process a single block at a time in ECB mode. Abstract away that
4724 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004725 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4726 input,
4727 input_length,
4728 output,
4729 output_size,
4730 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004731 }
4732 else
4733 {
4734 status = mbedtls_to_psa_error(
4735 mbedtls_cipher_update( &operation->ctx.cipher, input,
4736 input_length, output, output_length ) );
4737 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004738exit:
4739 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004740 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004741 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004742}
4743
Gilles Peskinee553c652018-06-04 16:22:46 +02004744psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4745 uint8_t *output,
4746 size_t output_size,
4747 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004748{
David Saadab4ecc272019-02-14 13:48:10 +02004749 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004750 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004751 if( operation->alg == 0 )
4752 {
4753 return( PSA_ERROR_BAD_STATE );
4754 }
4755 if( operation->iv_required && ! operation->iv_set )
4756 {
4757 return( PSA_ERROR_BAD_STATE );
4758 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004759
Steven Cooremanef8575e2020-09-11 11:44:50 +02004760 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004761 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004762 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004763 output,
4764 output_size,
4765 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004766 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004767 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004768
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004769 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004770 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004771 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004772 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004773 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004774 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004775 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004776 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004777 }
4778
Steven Cooremanef8575e2020-09-11 11:44:50 +02004779 status = mbedtls_to_psa_error(
4780 mbedtls_cipher_finish( &operation->ctx.cipher,
4781 temp_output_buffer,
4782 output_length ) );
4783 if( status != PSA_SUCCESS )
4784 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004785
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004786 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004787 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004788 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004789 memcpy( output, temp_output_buffer, *output_length );
4790 else
Janos Follath315b51c2018-07-09 16:04:51 +01004791 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004792
Steven Cooremanef8575e2020-09-11 11:44:50 +02004793exit:
4794 if( operation->mbedtls_in_use == 1 )
4795 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004796
Steven Cooremanef8575e2020-09-11 11:44:50 +02004797 if( status == PSA_SUCCESS )
4798 return( psa_cipher_abort( operation ) );
4799 else
4800 {
4801 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004802 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004803
Steven Cooremanef8575e2020-09-11 11:44:50 +02004804 return( status );
4805 }
mohammad1603503973b2018-03-12 15:59:30 +02004806}
4807
Gilles Peskinee553c652018-06-04 16:22:46 +02004808psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4809{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004810 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004811 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004812 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004813 * in use. It's ok to call abort on such an object, and there's
4814 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004815 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004816 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004817
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004818 /* Sanity check (shouldn't happen: operation->alg should
4819 * always have been initialized to a valid value). */
4820 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4821 return( PSA_ERROR_BAD_STATE );
4822
Steven Cooremanef8575e2020-09-11 11:44:50 +02004823 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004824 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004825 else
4826 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004827
Moran Peker41deec42018-04-04 15:43:05 +03004828 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004829 operation->key_set = 0;
4830 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004831 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004832 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004833 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004834 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004835
Moran Peker395db872018-05-31 14:07:14 +03004836 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004837}
4838
Gilles Peskinea0655c32018-04-30 17:06:50 +02004839
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004840
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004841
mohammad16035955c982018-04-26 00:53:03 +03004842/****************************************************************/
4843/* AEAD */
4844/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004845
Gilles Peskineedf9a652018-08-17 18:11:56 +02004846typedef struct
4847{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004848 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004849 const mbedtls_cipher_info_t *cipher_info;
4850 union
4851 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004852 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004853#if defined(MBEDTLS_CCM_C)
4854 mbedtls_ccm_context ccm;
4855#endif /* MBEDTLS_CCM_C */
4856#if defined(MBEDTLS_GCM_C)
4857 mbedtls_gcm_context gcm;
4858#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004859#if defined(MBEDTLS_CHACHAPOLY_C)
4860 mbedtls_chachapoly_context chachapoly;
4861#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004862 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004863 psa_algorithm_t core_alg;
4864 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004865 uint8_t tag_length;
4866} aead_operation_t;
4867
Ronald Cronf95a2b12020-10-22 15:24:49 +02004868#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4869
Gilles Peskine30a9e412019-01-14 18:36:12 +01004870static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004871{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004872 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004873 {
4874#if defined(MBEDTLS_CCM_C)
4875 case PSA_ALG_CCM:
4876 mbedtls_ccm_free( &operation->ctx.ccm );
4877 break;
4878#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004879#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004880 case PSA_ALG_GCM:
4881 mbedtls_gcm_free( &operation->ctx.gcm );
4882 break;
4883#endif /* MBEDTLS_GCM_C */
4884 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004885
Ronald Cron5c522922020-11-14 16:35:34 +01004886 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004887}
4888
4889static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004890 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004891 psa_key_usage_t usage,
4892 psa_algorithm_t alg )
4893{
4894 psa_status_t status;
4895 size_t key_bits;
4896 mbedtls_cipher_id_t cipher_id;
4897
Ronald Cron5c522922020-11-14 16:35:34 +01004898 status = psa_get_and_lock_transparent_key_slot_with_policy(
4899 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004900 if( status != PSA_SUCCESS )
4901 return( status );
4902
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004903 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004904
4905 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004906 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004907 &cipher_id );
4908 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004909 {
4910 status = PSA_ERROR_NOT_SUPPORTED;
4911 goto cleanup;
4912 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004913
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004914 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004915 {
4916#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004917 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4918 operation->core_alg = PSA_ALG_CCM;
4919 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004920 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4921 * The call to mbedtls_ccm_encrypt_and_tag or
4922 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004923 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004924 {
4925 status = PSA_ERROR_INVALID_ARGUMENT;
4926 goto cleanup;
4927 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004928 mbedtls_ccm_init( &operation->ctx.ccm );
4929 status = mbedtls_to_psa_error(
4930 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004931 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004932 (unsigned int) key_bits ) );
4933 if( status != 0 )
4934 goto cleanup;
4935 break;
4936#endif /* MBEDTLS_CCM_C */
4937
4938#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004939 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4940 operation->core_alg = PSA_ALG_GCM;
4941 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004942 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4943 * The call to mbedtls_gcm_crypt_and_tag or
4944 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004945 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004946 {
4947 status = PSA_ERROR_INVALID_ARGUMENT;
4948 goto cleanup;
4949 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004950 mbedtls_gcm_init( &operation->ctx.gcm );
4951 status = mbedtls_to_psa_error(
4952 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004953 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004954 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004955 if( status != 0 )
4956 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004957 break;
4958#endif /* MBEDTLS_GCM_C */
4959
Gilles Peskine26869f22019-05-06 15:25:00 +02004960#if defined(MBEDTLS_CHACHAPOLY_C)
4961 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4962 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4963 operation->full_tag_length = 16;
4964 /* We only support the default tag length. */
4965 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004966 {
4967 status = PSA_ERROR_NOT_SUPPORTED;
4968 goto cleanup;
4969 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004970 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4971 status = mbedtls_to_psa_error(
4972 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004973 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004974 if( status != 0 )
4975 goto cleanup;
4976 break;
4977#endif /* MBEDTLS_CHACHAPOLY_C */
4978
Gilles Peskineedf9a652018-08-17 18:11:56 +02004979 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004980 status = PSA_ERROR_NOT_SUPPORTED;
4981 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004982 }
4983
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004984 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4985 {
4986 status = PSA_ERROR_INVALID_ARGUMENT;
4987 goto cleanup;
4988 }
4989 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004990
Gilles Peskineedf9a652018-08-17 18:11:56 +02004991 return( PSA_SUCCESS );
4992
4993cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004994 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004995 return( status );
4996}
4997
Ronald Croncf56a0a2020-08-04 09:51:30 +02004998psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004999 psa_algorithm_t alg,
5000 const uint8_t *nonce,
5001 size_t nonce_length,
5002 const uint8_t *additional_data,
5003 size_t additional_data_length,
5004 const uint8_t *plaintext,
5005 size_t plaintext_length,
5006 uint8_t *ciphertext,
5007 size_t ciphertext_size,
5008 size_t *ciphertext_length )
5009{
mohammad16035955c982018-04-26 00:53:03 +03005010 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005011 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03005012 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02005013
mohammad1603f08a5502018-06-03 15:05:47 +03005014 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07005015
Ronald Croncf56a0a2020-08-04 09:51:30 +02005016 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005017 if( status != PSA_SUCCESS )
5018 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005019
Gilles Peskineedf9a652018-08-17 18:11:56 +02005020 /* For all currently supported modes, the tag is at the end of the
5021 * ciphertext. */
5022 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
5023 {
5024 status = PSA_ERROR_BUFFER_TOO_SMALL;
5025 goto exit;
5026 }
5027 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03005028
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005029#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005030 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005031 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005032 status = mbedtls_to_psa_error(
5033 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
5034 MBEDTLS_GCM_ENCRYPT,
5035 plaintext_length,
5036 nonce, nonce_length,
5037 additional_data, additional_data_length,
5038 plaintext, ciphertext,
5039 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03005040 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005041 else
5042#endif /* MBEDTLS_GCM_C */
5043#if defined(MBEDTLS_CCM_C)
5044 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005045 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005046 status = mbedtls_to_psa_error(
5047 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
5048 plaintext_length,
5049 nonce, nonce_length,
5050 additional_data,
5051 additional_data_length,
5052 plaintext, ciphertext,
5053 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005054 }
mohammad16035c8845f2018-05-09 05:40:09 -07005055 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005056#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005057#if defined(MBEDTLS_CHACHAPOLY_C)
5058 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5059 {
5060 if( nonce_length != 12 || operation.tag_length != 16 )
5061 {
5062 status = PSA_ERROR_NOT_SUPPORTED;
5063 goto exit;
5064 }
5065 status = mbedtls_to_psa_error(
5066 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
5067 plaintext_length,
5068 nonce,
5069 additional_data,
5070 additional_data_length,
5071 plaintext,
5072 ciphertext,
5073 tag ) );
5074 }
5075 else
5076#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07005077 {
mohammad1603554faad2018-06-03 15:07:38 +03005078 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07005079 }
Gilles Peskine2d277862018-06-18 15:41:12 +02005080
Gilles Peskineedf9a652018-08-17 18:11:56 +02005081 if( status != PSA_SUCCESS && ciphertext_size != 0 )
5082 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02005083
Gilles Peskineedf9a652018-08-17 18:11:56 +02005084exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005085 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005086 if( status == PSA_SUCCESS )
5087 *ciphertext_length = plaintext_length + operation.tag_length;
5088 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005089}
5090
Gilles Peskineee652a32018-06-01 19:23:52 +02005091/* Locate the tag in a ciphertext buffer containing the encrypted data
5092 * followed by the tag. Return the length of the part preceding the tag in
5093 * *plaintext_length. This is the size of the plaintext in modes where
5094 * the encrypted data has the same size as the plaintext, such as
5095 * CCM and GCM. */
5096static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
5097 const uint8_t *ciphertext,
5098 size_t ciphertext_length,
5099 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02005100 const uint8_t **p_tag )
5101{
5102 size_t payload_length;
5103 if( tag_length > ciphertext_length )
5104 return( PSA_ERROR_INVALID_ARGUMENT );
5105 payload_length = ciphertext_length - tag_length;
5106 if( payload_length > plaintext_size )
5107 return( PSA_ERROR_BUFFER_TOO_SMALL );
5108 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02005109 return( PSA_SUCCESS );
5110}
5111
Ronald Croncf56a0a2020-08-04 09:51:30 +02005112psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03005113 psa_algorithm_t alg,
5114 const uint8_t *nonce,
5115 size_t nonce_length,
5116 const uint8_t *additional_data,
5117 size_t additional_data_length,
5118 const uint8_t *ciphertext,
5119 size_t ciphertext_length,
5120 uint8_t *plaintext,
5121 size_t plaintext_size,
5122 size_t *plaintext_length )
5123{
mohammad16035955c982018-04-26 00:53:03 +03005124 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005125 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02005126 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02005127
Gilles Peskineee652a32018-06-01 19:23:52 +02005128 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005129
Ronald Croncf56a0a2020-08-04 09:51:30 +02005130 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005131 if( status != PSA_SUCCESS )
5132 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005133
Gilles Peskinef7e7b012019-05-06 15:27:16 +02005134 status = psa_aead_unpadded_locate_tag( operation.tag_length,
5135 ciphertext, ciphertext_length,
5136 plaintext_size, &tag );
5137 if( status != PSA_SUCCESS )
5138 goto exit;
5139
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005140#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005141 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005142 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005143 status = mbedtls_to_psa_error(
5144 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5145 ciphertext_length - operation.tag_length,
5146 nonce, nonce_length,
5147 additional_data,
5148 additional_data_length,
5149 tag, operation.tag_length,
5150 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005151 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005152 else
5153#endif /* MBEDTLS_GCM_C */
5154#if defined(MBEDTLS_CCM_C)
5155 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005156 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005157 status = mbedtls_to_psa_error(
5158 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5159 ciphertext_length - operation.tag_length,
5160 nonce, nonce_length,
5161 additional_data,
5162 additional_data_length,
5163 ciphertext, plaintext,
5164 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005165 }
mohammad160339574652018-06-01 04:39:53 -07005166 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005167#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005168#if defined(MBEDTLS_CHACHAPOLY_C)
5169 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5170 {
5171 if( nonce_length != 12 || operation.tag_length != 16 )
5172 {
5173 status = PSA_ERROR_NOT_SUPPORTED;
5174 goto exit;
5175 }
5176 status = mbedtls_to_psa_error(
5177 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5178 ciphertext_length - operation.tag_length,
5179 nonce,
5180 additional_data,
5181 additional_data_length,
5182 tag,
5183 ciphertext,
5184 plaintext ) );
5185 }
5186 else
5187#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005188 {
mohammad1603554faad2018-06-03 15:07:38 +03005189 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005190 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005191
Gilles Peskineedf9a652018-08-17 18:11:56 +02005192 if( status != PSA_SUCCESS && plaintext_size != 0 )
5193 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005194
Gilles Peskineedf9a652018-08-17 18:11:56 +02005195exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005196 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005197 if( status == PSA_SUCCESS )
5198 *plaintext_length = ciphertext_length - operation.tag_length;
5199 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005200}
5201
Gilles Peskinea0655c32018-04-30 17:06:50 +02005202
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005203
Gilles Peskine20035e32018-02-03 22:44:14 +01005204/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005205/* Generators */
5206/****************************************************************/
5207
John Durkop07cc04a2020-11-16 22:08:34 -08005208#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
5209 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5210 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5211#define AT_LEAST_ONE_BUILTIN_KDF
5212#endif
5213
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005214#define HKDF_STATE_INIT 0 /* no input yet */
5215#define HKDF_STATE_STARTED 1 /* got salt */
5216#define HKDF_STATE_KEYED 2 /* got key */
5217#define HKDF_STATE_OUTPUT 3 /* output started */
5218
Gilles Peskinecbe66502019-05-16 16:59:18 +02005219static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005220 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005221{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005222 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5223 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005224 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005225 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005226}
5227
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005228psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005229{
5230 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005231 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005232 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005233 {
5234 /* The object has (apparently) been initialized but it is not
5235 * in use. It's ok to call abort on such an object, and there's
5236 * nothing to do. */
5237 }
5238 else
John Durkopd0321952020-10-29 21:37:36 -07005239#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005240 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005241 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 mbedtls_free( operation->ctx.hkdf.info );
5243 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005244 }
John Durkop07cc04a2020-11-16 22:08:34 -08005245 else
5246#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5247#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5248 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5249 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005250 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005251 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005252 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005253 if( operation->ctx.tls12_prf.seed != NULL )
5254 {
5255 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5256 operation->ctx.tls12_prf.seed_length );
5257 mbedtls_free( operation->ctx.tls12_prf.seed );
5258 }
5259
5260 if( operation->ctx.tls12_prf.label != NULL )
5261 {
5262 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5263 operation->ctx.tls12_prf.label_length );
5264 mbedtls_free( operation->ctx.tls12_prf.label );
5265 }
5266
5267 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5268
5269 /* We leave the fields Ai and output_block to be erased safely by the
5270 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005271 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005272 else
John Durkop07cc04a2020-11-16 22:08:34 -08005273#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5274 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005275 {
5276 status = PSA_ERROR_BAD_STATE;
5277 }
Janos Follath083036a2019-06-11 10:22:26 +01005278 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005279 return( status );
5280}
5281
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005282psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005283 size_t *capacity)
5284{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005285 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005286 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005287 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005288 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005289 }
5290
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005291 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005292 return( PSA_SUCCESS );
5293}
5294
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005295psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005296 size_t capacity )
5297{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005298 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005299 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005300 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005301 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005302 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005303 return( PSA_SUCCESS );
5304}
5305
John Durkopd0321952020-10-29 21:37:36 -07005306#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005307/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005308 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005309static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005310 psa_algorithm_t hash_alg,
5311 uint8_t *output,
5312 size_t output_length )
5313{
5314 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5315 psa_status_t status;
5316
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005317 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5318 return( PSA_ERROR_BAD_STATE );
5319 hkdf->state = HKDF_STATE_OUTPUT;
5320
Gilles Peskinebef7f142018-07-12 17:22:21 +02005321 while( output_length != 0 )
5322 {
5323 /* Copy what remains of the current block */
5324 uint8_t n = hash_length - hkdf->offset_in_block;
5325 if( n > output_length )
5326 n = (uint8_t) output_length;
5327 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5328 output += n;
5329 output_length -= n;
5330 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005331 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005332 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005333 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005334 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005335 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005336 * object was corrupted or if this function is called directly
5337 * inside the library. */
5338 if( hkdf->block_number == 0xff )
5339 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005340
5341 /* We need a new block */
5342 ++hkdf->block_number;
5343 hkdf->offset_in_block = 0;
5344 status = psa_hmac_setup_internal( &hkdf->hmac,
5345 hkdf->prk, hash_length,
5346 hash_alg );
5347 if( status != PSA_SUCCESS )
5348 return( status );
5349 if( hkdf->block_number != 1 )
5350 {
5351 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5352 hkdf->output_block,
5353 hash_length );
5354 if( status != PSA_SUCCESS )
5355 return( status );
5356 }
5357 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5358 hkdf->info,
5359 hkdf->info_length );
5360 if( status != PSA_SUCCESS )
5361 return( status );
5362 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5363 &hkdf->block_number, 1 );
5364 if( status != PSA_SUCCESS )
5365 return( status );
5366 status = psa_hmac_finish_internal( &hkdf->hmac,
5367 hkdf->output_block,
5368 sizeof( hkdf->output_block ) );
5369 if( status != PSA_SUCCESS )
5370 return( status );
5371 }
5372
5373 return( PSA_SUCCESS );
5374}
John Durkop07cc04a2020-11-16 22:08:34 -08005375#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005376
John Durkop07cc04a2020-11-16 22:08:34 -08005377#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5378 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005379static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5380 psa_tls12_prf_key_derivation_t *tls12_prf,
5381 psa_algorithm_t alg )
5382{
5383 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5384 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005385 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5386 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005387
Janos Follath7742fee2019-06-17 12:58:10 +01005388 /* We can't be wanting more output after block 0xff, otherwise
5389 * the capacity check in psa_key_derivation_output_bytes() would have
5390 * prevented this call. It could happen only if the operation
5391 * object was corrupted or if this function is called directly
5392 * inside the library. */
5393 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005394 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005395
5396 /* We need a new block */
5397 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005398 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005399
5400 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5401 *
5402 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5403 *
5404 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5405 * HMAC_hash(secret, A(2) + seed) +
5406 * HMAC_hash(secret, A(3) + seed) + ...
5407 *
5408 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005409 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005410 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005411 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005412 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005413 * is currently extracted as `output_block` and where i is
5414 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005415 */
5416
Janos Follathea29bfb2019-06-19 12:21:20 +01005417 /* Save the hash context before using it, to preserve the hash state with
5418 * only the inner padding in it. We need this, because inner padding depends
5419 * on the key (secret in the RFC's terminology). */
5420 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5421 if( status != PSA_SUCCESS )
5422 goto cleanup;
5423
5424 /* Calculate A(i) where i = tls12_prf->block_number. */
5425 if( tls12_prf->block_number == 1 )
5426 {
5427 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5428 * the variable seed and in this instance means it in the context of the
5429 * P_hash function, where seed = label + seed.) */
5430 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5431 tls12_prf->label, tls12_prf->label_length );
5432 if( status != PSA_SUCCESS )
5433 goto cleanup;
5434 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5435 tls12_prf->seed, tls12_prf->seed_length );
5436 if( status != PSA_SUCCESS )
5437 goto cleanup;
5438 }
5439 else
5440 {
5441 /* A(i) = HMAC_hash(secret, A(i-1)) */
5442 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5443 tls12_prf->Ai, hash_length );
5444 if( status != PSA_SUCCESS )
5445 goto cleanup;
5446 }
5447
5448 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5449 tls12_prf->Ai, hash_length );
5450 if( status != PSA_SUCCESS )
5451 goto cleanup;
5452 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5453 if( status != PSA_SUCCESS )
5454 goto cleanup;
5455
5456 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5457 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5458 tls12_prf->Ai, hash_length );
5459 if( status != PSA_SUCCESS )
5460 goto cleanup;
5461 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5462 tls12_prf->label, tls12_prf->label_length );
5463 if( status != PSA_SUCCESS )
5464 goto cleanup;
5465 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5466 tls12_prf->seed, tls12_prf->seed_length );
5467 if( status != PSA_SUCCESS )
5468 goto cleanup;
5469 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5470 tls12_prf->output_block, hash_length );
5471 if( status != PSA_SUCCESS )
5472 goto cleanup;
5473 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5474 if( status != PSA_SUCCESS )
5475 goto cleanup;
5476
Janos Follath7742fee2019-06-17 12:58:10 +01005477
5478cleanup:
5479
Janos Follathea29bfb2019-06-19 12:21:20 +01005480 cleanup_status = psa_hash_abort( &backup );
5481 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5482 status = cleanup_status;
5483
5484 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005485}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005486
Janos Follath844eb0e2019-06-19 12:10:49 +01005487static psa_status_t psa_key_derivation_tls12_prf_read(
5488 psa_tls12_prf_key_derivation_t *tls12_prf,
5489 psa_algorithm_t alg,
5490 uint8_t *output,
5491 size_t output_length )
5492{
5493 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5494 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5495 psa_status_t status;
5496 uint8_t offset, length;
5497
5498 while( output_length != 0 )
5499 {
5500 /* Check if we have fully processed the current block. */
5501 if( tls12_prf->left_in_block == 0 )
5502 {
5503 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5504 alg );
5505 if( status != PSA_SUCCESS )
5506 return( status );
5507
5508 continue;
5509 }
5510
5511 if( tls12_prf->left_in_block > output_length )
5512 length = (uint8_t) output_length;
5513 else
5514 length = tls12_prf->left_in_block;
5515
5516 offset = hash_length - tls12_prf->left_in_block;
5517 memcpy( output, tls12_prf->output_block + offset, length );
5518 output += length;
5519 output_length -= length;
5520 tls12_prf->left_in_block -= length;
5521 }
5522
5523 return( PSA_SUCCESS );
5524}
John Durkop07cc04a2020-11-16 22:08:34 -08005525#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5526 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005527
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005528psa_status_t psa_key_derivation_output_bytes(
5529 psa_key_derivation_operation_t *operation,
5530 uint8_t *output,
5531 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005532{
5533 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005534 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005535
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005536 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005537 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005538 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005539 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005540 }
5541
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005542 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005543 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005544 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005545 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005546 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005547 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005548 goto exit;
5549 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005550 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005551 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005552 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005553 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005554 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5555 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005556 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005557 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005558 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005559 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005560 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005561
John Durkopd0321952020-10-29 21:37:36 -07005562#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005563 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005564 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005565 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005566 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005567 output, output_length );
5568 }
Janos Follathadbec812019-06-14 11:05:39 +01005569 else
John Durkop07cc04a2020-11-16 22:08:34 -08005570#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5571#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5572 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005573 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005574 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005575 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005576 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005577 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005578 output_length );
5579 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005580 else
John Durkop07cc04a2020-11-16 22:08:34 -08005581#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5582 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005583 {
5584 return( PSA_ERROR_BAD_STATE );
5585 }
5586
5587exit:
5588 if( status != PSA_SUCCESS )
5589 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005590 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005591 * This allows us to differentiate between exhausted operations and
5592 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5593 * operations. */
5594 psa_algorithm_t alg = operation->alg;
5595 psa_key_derivation_abort( operation );
5596 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005597 memset( output, '!', output_length );
5598 }
5599 return( status );
5600}
5601
Gilles Peskine08542d82018-07-19 17:05:42 +02005602#if defined(MBEDTLS_DES_C)
5603static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5604{
5605 if( data_size >= 8 )
5606 mbedtls_des_key_set_parity( data );
5607 if( data_size >= 16 )
5608 mbedtls_des_key_set_parity( data + 8 );
5609 if( data_size >= 24 )
5610 mbedtls_des_key_set_parity( data + 16 );
5611}
5612#endif /* MBEDTLS_DES_C */
5613
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005614static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005615 psa_key_slot_t *slot,
5616 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005617 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005618{
5619 uint8_t *data = NULL;
5620 size_t bytes = PSA_BITS_TO_BYTES( bits );
5621 psa_status_t status;
5622
Gilles Peskine8e338702019-07-30 20:06:31 +02005623 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005624 return( PSA_ERROR_INVALID_ARGUMENT );
5625 if( bits % 8 != 0 )
5626 return( PSA_ERROR_INVALID_ARGUMENT );
5627 data = mbedtls_calloc( 1, bytes );
5628 if( data == NULL )
5629 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5630
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005631 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005632 if( status != PSA_SUCCESS )
5633 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005634#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005635 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005636 psa_des_set_key_parity( data, bytes );
5637#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005638 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005639
5640exit:
5641 mbedtls_free( data );
5642 return( status );
5643}
5644
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005645psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005646 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005647 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005648{
5649 psa_status_t status;
5650 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005651 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005652
Ronald Cron81709fc2020-11-14 12:10:32 +01005653 *key = MBEDTLS_SVC_KEY_ID_INIT;
5654
Gilles Peskine0f84d622019-09-12 19:03:13 +02005655 /* Reject any attempt to create a zero-length key so that we don't
5656 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5657 if( psa_get_key_bits( attributes ) == 0 )
5658 return( PSA_ERROR_INVALID_ARGUMENT );
5659
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005660 if( ! operation->can_output_key )
5661 return( PSA_ERROR_NOT_PERMITTED );
5662
Ronald Cron81709fc2020-11-14 12:10:32 +01005663 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5664 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005665#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5666 if( driver != NULL )
5667 {
5668 /* Deriving a key in a secure element is not implemented yet. */
5669 status = PSA_ERROR_NOT_SUPPORTED;
5670 }
5671#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005672 if( status == PSA_SUCCESS )
5673 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005674 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005675 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005676 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005677 }
5678 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005679 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005680 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005681 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005682
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005683 return( status );
5684}
5685
Gilles Peskineeab56e42018-07-12 17:12:33 +02005686
5687
5688/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005689/* Key derivation */
5690/****************************************************************/
5691
John Durkop07cc04a2020-11-16 22:08:34 -08005692#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005693static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005694 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005695 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005696{
John Durkop07cc04a2020-11-16 22:08:34 -08005697 int is_kdf_alg_supported;
5698
Janos Follath5fe19732019-06-20 15:09:30 +01005699 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5700 * initialisers for this union leave some bytes unspecified.) */
5701 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5702
Gilles Peskine969c5d62019-01-16 15:53:06 +01005703 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005704#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005705 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5706 is_kdf_alg_supported = 1;
5707 else
5708#endif
5709#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5710 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5711 is_kdf_alg_supported = 1;
5712 else
5713#endif
5714#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5715 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5716 is_kdf_alg_supported = 1;
5717 else
5718#endif
5719 is_kdf_alg_supported = 0;
5720
5721 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005722 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005723 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005724 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5725 if( hash_size == 0 )
5726 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005727 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5728 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005729 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005730 {
5731 return( PSA_ERROR_NOT_SUPPORTED );
5732 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005733 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005734 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005735 }
John Durkop07cc04a2020-11-16 22:08:34 -08005736
5737 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005738}
John Durkop07cc04a2020-11-16 22:08:34 -08005739#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005740
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005741psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005742 psa_algorithm_t alg )
5743{
5744 psa_status_t status;
5745
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005746 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005747 return( PSA_ERROR_BAD_STATE );
5748
Gilles Peskine6843c292019-01-18 16:44:49 +01005749 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5750 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005751#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005752 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005753 {
5754 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005755 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005756 }
5757 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5758 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005759 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005760 }
John Durkop07cc04a2020-11-16 22:08:34 -08005761#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005762 else
5763 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005764
5765 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005766 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005767 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005768}
5769
John Durkopd0321952020-10-29 21:37:36 -07005770#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005771static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005772 psa_algorithm_t hash_alg,
5773 psa_key_derivation_step_t step,
5774 const uint8_t *data,
5775 size_t data_length )
5776{
5777 psa_status_t status;
5778 switch( step )
5779 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005780 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005781 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005782 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005783 status = psa_hmac_setup_internal( &hkdf->hmac,
5784 data, data_length,
5785 hash_alg );
5786 if( status != PSA_SUCCESS )
5787 return( status );
5788 hkdf->state = HKDF_STATE_STARTED;
5789 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005790 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005791 /* If no salt was provided, use an empty salt. */
5792 if( hkdf->state == HKDF_STATE_INIT )
5793 {
5794 status = psa_hmac_setup_internal( &hkdf->hmac,
5795 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005796 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005797 if( status != PSA_SUCCESS )
5798 return( status );
5799 hkdf->state = HKDF_STATE_STARTED;
5800 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005801 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005802 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005803 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5804 data, data_length );
5805 if( status != PSA_SUCCESS )
5806 return( status );
5807 status = psa_hmac_finish_internal( &hkdf->hmac,
5808 hkdf->prk,
5809 sizeof( hkdf->prk ) );
5810 if( status != PSA_SUCCESS )
5811 return( status );
5812 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5813 hkdf->block_number = 0;
5814 hkdf->state = HKDF_STATE_KEYED;
5815 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005816 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005817 if( hkdf->state == HKDF_STATE_OUTPUT )
5818 return( PSA_ERROR_BAD_STATE );
5819 if( hkdf->info_set )
5820 return( PSA_ERROR_BAD_STATE );
5821 hkdf->info_length = data_length;
5822 if( data_length != 0 )
5823 {
5824 hkdf->info = mbedtls_calloc( 1, data_length );
5825 if( hkdf->info == NULL )
5826 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5827 memcpy( hkdf->info, data, data_length );
5828 }
5829 hkdf->info_set = 1;
5830 return( PSA_SUCCESS );
5831 default:
5832 return( PSA_ERROR_INVALID_ARGUMENT );
5833 }
5834}
John Durkop07cc04a2020-11-16 22:08:34 -08005835#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005836
John Durkop07cc04a2020-11-16 22:08:34 -08005837#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5838 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005839static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5840 const uint8_t *data,
5841 size_t data_length )
5842{
5843 if( prf->state != TLS12_PRF_STATE_INIT )
5844 return( PSA_ERROR_BAD_STATE );
5845
Janos Follathd6dce9f2019-07-04 09:11:38 +01005846 if( data_length != 0 )
5847 {
5848 prf->seed = mbedtls_calloc( 1, data_length );
5849 if( prf->seed == NULL )
5850 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005851
Janos Follathd6dce9f2019-07-04 09:11:38 +01005852 memcpy( prf->seed, data, data_length );
5853 prf->seed_length = data_length;
5854 }
Janos Follathf08e2652019-06-13 09:05:41 +01005855
5856 prf->state = TLS12_PRF_STATE_SEED_SET;
5857
5858 return( PSA_SUCCESS );
5859}
5860
Janos Follath81550542019-06-13 14:26:34 +01005861static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5862 psa_algorithm_t hash_alg,
5863 const uint8_t *data,
5864 size_t data_length )
5865{
5866 psa_status_t status;
5867 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5868 return( PSA_ERROR_BAD_STATE );
5869
5870 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5871 if( status != PSA_SUCCESS )
5872 return( status );
5873
5874 prf->state = TLS12_PRF_STATE_KEY_SET;
5875
5876 return( PSA_SUCCESS );
5877}
5878
Janos Follath63028dd2019-06-13 09:15:47 +01005879static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5880 const uint8_t *data,
5881 size_t data_length )
5882{
5883 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5884 return( PSA_ERROR_BAD_STATE );
5885
Janos Follathd6dce9f2019-07-04 09:11:38 +01005886 if( data_length != 0 )
5887 {
5888 prf->label = mbedtls_calloc( 1, data_length );
5889 if( prf->label == NULL )
5890 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005891
Janos Follathd6dce9f2019-07-04 09:11:38 +01005892 memcpy( prf->label, data, data_length );
5893 prf->label_length = data_length;
5894 }
Janos Follath63028dd2019-06-13 09:15:47 +01005895
5896 prf->state = TLS12_PRF_STATE_LABEL_SET;
5897
5898 return( PSA_SUCCESS );
5899}
5900
Janos Follathb03233e2019-06-11 15:30:30 +01005901static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5902 psa_algorithm_t hash_alg,
5903 psa_key_derivation_step_t step,
5904 const uint8_t *data,
5905 size_t data_length )
5906{
Janos Follathb03233e2019-06-11 15:30:30 +01005907 switch( step )
5908 {
Janos Follathf08e2652019-06-13 09:05:41 +01005909 case PSA_KEY_DERIVATION_INPUT_SEED:
5910 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005911 case PSA_KEY_DERIVATION_INPUT_SECRET:
5912 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005913 case PSA_KEY_DERIVATION_INPUT_LABEL:
5914 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005915 default:
5916 return( PSA_ERROR_INVALID_ARGUMENT );
5917 }
5918}
John Durkop07cc04a2020-11-16 22:08:34 -08005919#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5920 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5921
5922#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5923static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5924 psa_tls12_prf_key_derivation_t *prf,
5925 psa_algorithm_t hash_alg,
5926 const uint8_t *data,
5927 size_t data_length )
5928{
5929 psa_status_t status;
5930 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5931 uint8_t *cur = pms;
5932
5933 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5934 return( PSA_ERROR_INVALID_ARGUMENT );
5935
5936 /* Quoting RFC 4279, Section 2:
5937 *
5938 * The premaster secret is formed as follows: if the PSK is N octets
5939 * long, concatenate a uint16 with the value N, N zero octets, a second
5940 * uint16 with the value N, and the PSK itself.
5941 */
5942
5943 *cur++ = ( data_length >> 8 ) & 0xff;
5944 *cur++ = ( data_length >> 0 ) & 0xff;
5945 memset( cur, 0, data_length );
5946 cur += data_length;
5947 *cur++ = pms[0];
5948 *cur++ = pms[1];
5949 memcpy( cur, data, data_length );
5950 cur += data_length;
5951
5952 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5953
5954 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5955 return( status );
5956}
Janos Follath6660f0e2019-06-17 08:44:03 +01005957
5958static psa_status_t psa_tls12_prf_psk_to_ms_input(
5959 psa_tls12_prf_key_derivation_t *prf,
5960 psa_algorithm_t hash_alg,
5961 psa_key_derivation_step_t step,
5962 const uint8_t *data,
5963 size_t data_length )
5964{
5965 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005966 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005967 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5968 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005969 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005970
5971 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5972}
John Durkop07cc04a2020-11-16 22:08:34 -08005973#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005974
Gilles Peskineb8965192019-09-24 16:21:10 +02005975/** Check whether the given key type is acceptable for the given
5976 * input step of a key derivation.
5977 *
5978 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5979 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5980 * Both secret and non-secret inputs can alternatively have the type
5981 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5982 * that the input was passed as a buffer rather than via a key object.
5983 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005984static int psa_key_derivation_check_input_type(
5985 psa_key_derivation_step_t step,
5986 psa_key_type_t key_type )
5987{
5988 switch( step )
5989 {
5990 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005991 if( key_type == PSA_KEY_TYPE_DERIVE )
5992 return( PSA_SUCCESS );
5993 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005994 return( PSA_SUCCESS );
5995 break;
5996 case PSA_KEY_DERIVATION_INPUT_LABEL:
5997 case PSA_KEY_DERIVATION_INPUT_SALT:
5998 case PSA_KEY_DERIVATION_INPUT_INFO:
5999 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02006000 if( key_type == PSA_KEY_TYPE_RAW_DATA )
6001 return( PSA_SUCCESS );
6002 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02006003 return( PSA_SUCCESS );
6004 break;
6005 }
6006 return( PSA_ERROR_INVALID_ARGUMENT );
6007}
6008
Janos Follathb80a94e2019-06-12 15:54:46 +01006009static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006010 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006011 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006012 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006013 const uint8_t *data,
6014 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006015{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006016 psa_status_t status;
6017 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
6018
6019 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02006020 if( status != PSA_SUCCESS )
6021 goto exit;
6022
John Durkopd0321952020-10-29 21:37:36 -07006023#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006024 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006025 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006026 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006027 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006028 step, data, data_length );
6029 }
John Durkop07cc04a2020-11-16 22:08:34 -08006030 else
6031#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
6032#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
6033 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006034 {
Janos Follathb03233e2019-06-11 15:30:30 +01006035 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
6036 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
6037 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01006038 }
John Durkop07cc04a2020-11-16 22:08:34 -08006039 else
6040#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6041#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6042 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01006043 {
6044 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
6045 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
6046 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006047 }
6048 else
John Durkop07cc04a2020-11-16 22:08:34 -08006049#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006050 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006051 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006052 return( PSA_ERROR_BAD_STATE );
6053 }
6054
Gilles Peskine224b0d62019-09-23 18:13:17 +02006055exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006056 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006057 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006058 return( status );
6059}
6060
Janos Follath51f4a0f2019-06-14 11:35:55 +01006061psa_status_t psa_key_derivation_input_bytes(
6062 psa_key_derivation_operation_t *operation,
6063 psa_key_derivation_step_t step,
6064 const uint8_t *data,
6065 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006066{
Gilles Peskineb8965192019-09-24 16:21:10 +02006067 return( psa_key_derivation_input_internal( operation, step,
6068 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01006069 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006070}
6071
Janos Follath51f4a0f2019-06-14 11:35:55 +01006072psa_status_t psa_key_derivation_input_key(
6073 psa_key_derivation_operation_t *operation,
6074 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006075 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006076{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006078 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006079 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006080
Ronald Cron5c522922020-11-14 16:35:34 +01006081 status = psa_get_and_lock_transparent_key_slot_with_policy(
6082 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006083 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02006084 {
6085 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006086 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02006087 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006088
6089 /* Passing a key object as a SECRET input unlocks the permission
6090 * to output to a key object. */
6091 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6092 operation->can_output_key = 1;
6093
Ronald Cronf95a2b12020-10-22 15:24:49 +02006094 status = psa_key_derivation_input_internal( operation,
6095 step, slot->attr.type,
6096 slot->data.key.data,
6097 slot->data.key.bytes );
6098
Ronald Cron5c522922020-11-14 16:35:34 +01006099 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006100
Ronald Cron5c522922020-11-14 16:35:34 +01006101 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006102}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006103
6104
6105
6106/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006107/* Key agreement */
6108/****************************************************************/
6109
John Durkop6ba40d12020-11-10 08:50:04 -08006110#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006111static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
6112 size_t peer_key_length,
6113 const mbedtls_ecp_keypair *our_key,
6114 uint8_t *shared_secret,
6115 size_t shared_secret_size,
6116 size_t *shared_secret_length )
6117{
Steven Cooremand4867872020-08-05 16:31:39 +02006118 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006119 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00006120 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006121 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01006122 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006123 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006124
Steven Cooreman4fed4552020-08-03 14:46:03 +02006125 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
6126 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02006127 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02006128 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00006129 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006130 goto exit;
6131
Jaeden Amero97271b32019-01-10 19:38:51 +00006132 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02006133 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00006134 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006135 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00006136 status = mbedtls_to_psa_error(
6137 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
6138 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006139 goto exit;
6140
Jaeden Amero97271b32019-01-10 19:38:51 +00006141 status = mbedtls_to_psa_error(
6142 mbedtls_ecdh_calc_secret( &ecdh,
6143 shared_secret_length,
6144 shared_secret, shared_secret_size,
6145 mbedtls_ctr_drbg_random,
6146 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006147 if( status != PSA_SUCCESS )
6148 goto exit;
6149 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
6150 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006151
6152exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01006153 if( status != PSA_SUCCESS )
6154 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006155 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02006156 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02006157 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02006158
Jaeden Amero97271b32019-01-10 19:38:51 +00006159 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006160}
John Durkop6ba40d12020-11-10 08:50:04 -08006161#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006162
Gilles Peskine01d718c2018-09-18 12:01:02 +02006163#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6164
Gilles Peskine0216fe12019-04-11 21:23:21 +02006165static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6166 psa_key_slot_t *private_key,
6167 const uint8_t *peer_key,
6168 size_t peer_key_length,
6169 uint8_t *shared_secret,
6170 size_t shared_secret_size,
6171 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006172{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006173 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006174 {
John Durkop6ba40d12020-11-10 08:50:04 -08006175#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006176 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006177 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006178 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006179 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02006180 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02006181 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02006182 private_key->data.key.data,
6183 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02006184 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006185 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006186 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006187 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006188 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006189 shared_secret, shared_secret_size,
6190 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006191 mbedtls_ecp_keypair_free( ecp );
6192 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006193 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08006194#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006195 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006196 (void) private_key;
6197 (void) peer_key;
6198 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006199 (void) shared_secret;
6200 (void) shared_secret_size;
6201 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006202 return( PSA_ERROR_NOT_SUPPORTED );
6203 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006204}
6205
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006206/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006207 * to potentially free embedded data structures and wipe confidential data.
6208 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006209static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006210 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006211 psa_key_slot_t *private_key,
6212 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006213 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006214{
6215 psa_status_t status;
6216 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6217 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006218 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006219
6220 /* Step 1: run the secret agreement algorithm to generate the shared
6221 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006222 status = psa_key_agreement_raw_internal( ka_alg,
6223 private_key,
6224 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006225 shared_secret,
6226 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006227 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006228 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006229 goto exit;
6230
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006231 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006232 * the shared secret. A shared secret is permitted wherever a key
6233 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006234 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006235 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006236 shared_secret,
6237 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006238exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006239 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006240 return( status );
6241}
6242
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006243psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006244 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006245 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006246 const uint8_t *peer_key,
6247 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006248{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006249 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006250 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006251 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006252
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006253 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006254 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01006255 status = psa_get_and_lock_transparent_key_slot_with_policy(
6256 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006257 if( status != PSA_SUCCESS )
6258 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006259 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006260 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006261 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006262 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006263 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006264 else
6265 {
6266 /* If a private key has been added as SECRET, we allow the derived
6267 * key material to be used as a key in PSA Crypto. */
6268 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6269 operation->can_output_key = 1;
6270 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006271
Ronald Cron5c522922020-11-14 16:35:34 +01006272 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006273
Ronald Cron5c522922020-11-14 16:35:34 +01006274 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006275}
6276
Gilles Peskinebe697d82019-05-16 18:00:41 +02006277psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006278 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006279 const uint8_t *peer_key,
6280 size_t peer_key_length,
6281 uint8_t *output,
6282 size_t output_size,
6283 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006284{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006285 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006286 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006287 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006288
6289 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6290 {
6291 status = PSA_ERROR_INVALID_ARGUMENT;
6292 goto exit;
6293 }
Ronald Cron5c522922020-11-14 16:35:34 +01006294 status = psa_get_and_lock_transparent_key_slot_with_policy(
6295 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006296 if( status != PSA_SUCCESS )
6297 goto exit;
6298
6299 status = psa_key_agreement_raw_internal( alg, slot,
6300 peer_key, peer_key_length,
6301 output, output_size,
6302 output_length );
6303
6304exit:
6305 if( status != PSA_SUCCESS )
6306 {
6307 /* If an error happens and is not handled properly, the output
6308 * may be used as a key to protect sensitive data. Arrange for such
6309 * a key to be random, which is likely to result in decryption or
6310 * verification errors. This is better than filling the buffer with
6311 * some constant data such as zeros, which would result in the data
6312 * being protected with a reproducible, easily knowable key.
6313 */
6314 psa_generate_random( output, output_size );
6315 *output_length = output_size;
6316 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006317
Ronald Cron5c522922020-11-14 16:35:34 +01006318 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006319
Ronald Cron5c522922020-11-14 16:35:34 +01006320 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006321}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006322
6323
6324/****************************************************************/
6325/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006326/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006327
Gilles Peskine4c317f42018-07-12 01:24:09 +02006328psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006329 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006330{
Janos Follath24eed8d2019-11-22 13:21:35 +00006331 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006332 GUARD_MODULE_INITIALIZED;
6333
Gilles Peskinef181eca2019-08-07 13:49:00 +02006334 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6335 {
6336 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6337 output,
6338 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6339 if( ret != 0 )
6340 return( mbedtls_to_psa_error( ret ) );
6341 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6342 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6343 }
6344
Gilles Peskinee59236f2018-01-27 23:32:46 +01006345 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6346 return( mbedtls_to_psa_error( ret ) );
6347}
6348
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006349#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6350#include "mbedtls/entropy_poll.h"
6351
Gilles Peskine7228da22019-07-15 11:06:15 +02006352psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006353 size_t seed_size )
6354{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006355 if( global_data.initialized )
6356 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006357
6358 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6359 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6360 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6361 return( PSA_ERROR_INVALID_ARGUMENT );
6362
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006363 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006364}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006365#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006366
John Durkop07cc04a2020-11-16 22:08:34 -08006367#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006368static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6369 size_t domain_parameters_size,
6370 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006371{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006372 size_t i;
6373 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006374
Gilles Peskinee56e8782019-04-26 17:34:02 +02006375 if( domain_parameters_size == 0 )
6376 {
6377 *exponent = 65537;
6378 return( PSA_SUCCESS );
6379 }
6380
6381 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6382 * support values that fit in a 32-bit integer, which is larger than
6383 * int on just about every platform anyway. */
6384 if( domain_parameters_size > sizeof( acc ) )
6385 return( PSA_ERROR_NOT_SUPPORTED );
6386 for( i = 0; i < domain_parameters_size; i++ )
6387 acc = ( acc << 8 ) | domain_parameters[i];
6388 if( acc > INT_MAX )
6389 return( PSA_ERROR_NOT_SUPPORTED );
6390 *exponent = acc;
6391 return( PSA_SUCCESS );
6392}
John Durkop07cc04a2020-11-16 22:08:34 -08006393#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006394
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006395static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006396 psa_key_slot_t *slot, size_t bits,
6397 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006398{
Gilles Peskine8e338702019-07-30 20:06:31 +02006399 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006400
Gilles Peskinee56e8782019-04-26 17:34:02 +02006401 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006402 return( PSA_ERROR_INVALID_ARGUMENT );
6403
Gilles Peskinee59236f2018-01-27 23:32:46 +01006404 if( key_type_is_raw_bytes( type ) )
6405 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006406 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006407
6408 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006409 if( status != PSA_SUCCESS )
6410 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006411
6412 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006413 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6414 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006415 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006416
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006417 status = psa_generate_random( slot->data.key.data,
6418 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006419 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006420 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006421
6422 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006423#if defined(MBEDTLS_DES_C)
6424 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006425 psa_des_set_key_parity( slot->data.key.data,
6426 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006427#endif /* MBEDTLS_DES_C */
6428 }
6429 else
6430
John Durkop07cc04a2020-11-16 22:08:34 -08006431#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006432 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006433 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006434 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006435 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006436 int exponent;
6437 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006438 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6439 return( PSA_ERROR_NOT_SUPPORTED );
6440 /* Accept only byte-aligned keys, for the same reasons as
6441 * in psa_import_rsa_key(). */
6442 if( bits % 8 != 0 )
6443 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006444 status = psa_read_rsa_exponent( domain_parameters,
6445 domain_parameters_size,
6446 &exponent );
6447 if( status != PSA_SUCCESS )
6448 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006449 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6450 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006451 mbedtls_ctr_drbg_random,
6452 &global_data.ctr_drbg,
6453 (unsigned int) bits,
6454 exponent );
6455 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006456 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006457
6458 /* Make sure to always have an export representation available */
6459 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6460
Steven Cooreman75b74362020-07-28 14:30:13 +02006461 status = psa_allocate_buffer_to_slot( slot, bytes );
6462 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006463 {
6464 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006465 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006466 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006467
6468 status = psa_export_rsa_key( type,
6469 &rsa,
6470 slot->data.key.data,
6471 bytes,
6472 &slot->data.key.bytes );
6473 mbedtls_rsa_free( &rsa );
6474 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006475 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006476 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006477 }
6478 else
John Durkop07cc04a2020-11-16 22:08:34 -08006479#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006480
John Durkop9814fa22020-11-04 12:28:15 -08006481#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006482 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006483 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006484 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006485 mbedtls_ecp_group_id grp_id =
6486 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006487 const mbedtls_ecp_curve_info *curve_info =
6488 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006489 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006490 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006491 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006492 return( PSA_ERROR_NOT_SUPPORTED );
6493 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6494 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006495 mbedtls_ecp_keypair_init( &ecp );
6496 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006497 mbedtls_ctr_drbg_random,
6498 &global_data.ctr_drbg );
6499 if( ret != 0 )
6500 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006501 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006502 return( mbedtls_to_psa_error( ret ) );
6503 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006504
6505
6506 /* Make sure to always have an export representation available */
6507 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006508 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6509 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006510 {
6511 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006512 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006513 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006514
6515 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006516 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6517
6518 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006519 if( status != PSA_SUCCESS ) {
6520 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006521 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006522 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006523 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006524 }
6525 else
John Durkop9814fa22020-11-04 12:28:15 -08006526#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006527 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006528 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006529 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006530
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006531 return( PSA_SUCCESS );
6532}
Darryl Green0c6575a2018-11-07 16:05:30 +00006533
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006534psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006535 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006536{
6537 psa_status_t status;
6538 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006539 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006540
Ronald Cron81709fc2020-11-14 12:10:32 +01006541 *key = MBEDTLS_SVC_KEY_ID_INIT;
6542
Gilles Peskine0f84d622019-09-12 19:03:13 +02006543 /* Reject any attempt to create a zero-length key so that we don't
6544 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6545 if( psa_get_key_bits( attributes ) == 0 )
6546 return( PSA_ERROR_INVALID_ARGUMENT );
6547
Ronald Cron81709fc2020-11-14 12:10:32 +01006548 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6549 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006550 if( status != PSA_SUCCESS )
6551 goto exit;
6552
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006553 status = psa_driver_wrapper_generate_key( attributes,
6554 slot );
6555 if( status != PSA_ERROR_NOT_SUPPORTED ||
6556 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6557 goto exit;
6558
6559 status = psa_generate_key_internal(
6560 slot, attributes->core.bits,
6561 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006562
6563exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006564 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006565 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006566 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006567 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006568
Darryl Green0c6575a2018-11-07 16:05:30 +00006569 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006570}
6571
6572
Gilles Peskinee59236f2018-01-27 23:32:46 +01006573
6574/****************************************************************/
6575/* Module setup */
6576/****************************************************************/
6577
Gilles Peskine5e769522018-11-20 21:59:56 +01006578psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6579 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6580 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6581{
6582 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6583 return( PSA_ERROR_BAD_STATE );
6584 global_data.entropy_init = entropy_init;
6585 global_data.entropy_free = entropy_free;
6586 return( PSA_SUCCESS );
6587}
6588
Gilles Peskinee59236f2018-01-27 23:32:46 +01006589void mbedtls_psa_crypto_free( void )
6590{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006591 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006592 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6593 {
6594 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006595 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006596 }
6597 /* Wipe all remaining data, including configuration.
6598 * In particular, this sets all state indicator to the value
6599 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006600 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006601#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006602 /* Unregister all secure element drivers, so that we restart from
6603 * a pristine state. */
6604 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006605#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006606}
6607
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006608#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6609/** Recover a transaction that was interrupted by a power failure.
6610 *
6611 * This function is called during initialization, before psa_crypto_init()
6612 * returns. If this function returns a failure status, the initialization
6613 * fails.
6614 */
6615static psa_status_t psa_crypto_recover_transaction(
6616 const psa_crypto_transaction_t *transaction )
6617{
6618 switch( transaction->unknown.type )
6619 {
6620 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6621 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006622 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006623 * is implemented.
6624 * https://github.com/ARMmbed/mbed-crypto/issues/218
6625 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006626 default:
6627 /* We found an unsupported transaction in the storage.
6628 * We don't know what state the storage is in. Give up. */
6629 return( PSA_ERROR_STORAGE_FAILURE );
6630 }
6631}
6632#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6633
Gilles Peskinee59236f2018-01-27 23:32:46 +01006634psa_status_t psa_crypto_init( void )
6635{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006636 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006637 const unsigned char drbg_seed[] = "PSA";
6638
Gilles Peskinec6b69072018-11-20 21:42:52 +01006639 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006640 if( global_data.initialized != 0 )
6641 return( PSA_SUCCESS );
6642
Gilles Peskine5e769522018-11-20 21:59:56 +01006643 /* Set default configuration if
6644 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6645 if( global_data.entropy_init == NULL )
6646 global_data.entropy_init = mbedtls_entropy_init;
6647 if( global_data.entropy_free == NULL )
6648 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006649
Gilles Peskinec6b69072018-11-20 21:42:52 +01006650 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006651 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006652#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6653 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6654 /* The PSA entropy injection feature depends on using NV seed as an entropy
6655 * source. Add NV seed as an entropy source for PSA entropy injection. */
6656 mbedtls_entropy_add_source( &global_data.entropy,
6657 mbedtls_nv_seed_poll, NULL,
6658 MBEDTLS_ENTROPY_BLOCK_SIZE,
6659 MBEDTLS_ENTROPY_SOURCE_STRONG );
6660#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006661 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006662 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006663 status = mbedtls_to_psa_error(
6664 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6665 mbedtls_entropy_func,
6666 &global_data.entropy,
6667 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6668 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006669 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006670 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006671
Gilles Peskine66fb1262018-12-10 16:29:04 +01006672 status = psa_initialize_key_slots( );
6673 if( status != PSA_SUCCESS )
6674 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006675
Gilles Peskined9348f22019-10-01 15:22:29 +02006676#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6677 status = psa_init_all_se_drivers( );
6678 if( status != PSA_SUCCESS )
6679 goto exit;
6680#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6681
Gilles Peskine4b734222019-07-24 15:56:31 +02006682#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006683 status = psa_crypto_load_transaction( );
6684 if( status == PSA_SUCCESS )
6685 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006686 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6687 if( status != PSA_SUCCESS )
6688 goto exit;
6689 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006690 }
6691 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6692 {
6693 /* There's no transaction to complete. It's all good. */
6694 status = PSA_SUCCESS;
6695 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006696#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006697
Gilles Peskinec6b69072018-11-20 21:42:52 +01006698 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006699 global_data.initialized = 1;
6700
6701exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006702 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006703 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006704 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006705}
6706
6707#endif /* MBEDTLS_PSA_CRYPTO_C */