blob: a32ce94e4191f7f6d968d13620cacceeb6462f2e [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 Peskine90edc992020-11-13 15:39:19 +010043#include "psa_crypto_random.h"
44
Gilles Peskineb46bef22019-07-30 21:32:04 +020045#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010046#include <stdlib.h>
47#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020049#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010050#define mbedtls_calloc calloc
51#define mbedtls_free free
52#endif
53
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010054#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010055#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020056#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000057#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020058#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010059#include "mbedtls/blowfish.h"
60#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020061#include "mbedtls/chacha20.h"
62#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/cipher.h"
64#include "mbedtls/ccm.h"
65#include "mbedtls/cmac.h"
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010066#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010067#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020068#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010070#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010071#include "mbedtls/error.h"
72#include "mbedtls/gcm.h"
73#include "mbedtls/md2.h"
74#include "mbedtls/md4.h"
75#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
77#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010079#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
87#include "mbedtls/xtea.h"
88
Gilles Peskine996deb12018-08-01 15:45:45 +020089#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
90
Gilles Peskine9ef733f2018-02-07 21:05:37 +010091/* constant-time buffer comparison */
92static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
93{
94 size_t i;
95 unsigned char diff = 0;
96
97 for( i = 0; i < n; i++ )
98 diff |= a[i] ^ b[i];
99
100 return( diff );
101}
102
103
104
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100105/****************************************************************/
106/* Global data, support functions and library management */
107/****************************************************************/
108
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200109static int key_type_is_raw_bytes( psa_key_type_t type )
110{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200111 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200112}
113
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100114/* Values for psa_global_data_t::rng_state */
115#define RNG_NOT_INITIALIZED 0
116#define RNG_INITIALIZED 1
117#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100118
Gilles Peskine2d277862018-06-18 15:41:12 +0200119typedef struct
120{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100121 mbedtls_psa_random_context_t rng;
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,
Gilles Peskine30524eb2020-11-13 17:02:26 +0100870 mbedtls_psa_get_random, mbedtls_psa_random_state( &global_data.rng ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200871 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 {
2470#if defined(MBEDTLS_MD2_C)
2471 case PSA_ALG_MD2:
2472 return( &mbedtls_md2_info );
2473#endif
2474#if defined(MBEDTLS_MD4_C)
2475 case PSA_ALG_MD4:
2476 return( &mbedtls_md4_info );
2477#endif
2478#if defined(MBEDTLS_MD5_C)
2479 case PSA_ALG_MD5:
2480 return( &mbedtls_md5_info );
2481#endif
2482#if defined(MBEDTLS_RIPEMD160_C)
2483 case PSA_ALG_RIPEMD160:
2484 return( &mbedtls_ripemd160_info );
2485#endif
2486#if defined(MBEDTLS_SHA1_C)
2487 case PSA_ALG_SHA_1:
2488 return( &mbedtls_sha1_info );
2489#endif
2490#if defined(MBEDTLS_SHA256_C)
2491 case PSA_ALG_SHA_224:
2492 return( &mbedtls_sha224_info );
2493 case PSA_ALG_SHA_256:
2494 return( &mbedtls_sha256_info );
2495#endif
2496#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002497#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002498 case PSA_ALG_SHA_384:
2499 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002500#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002501 case PSA_ALG_SHA_512:
2502 return( &mbedtls_sha512_info );
2503#endif
2504 default:
2505 return( NULL );
2506 }
2507}
John Durkop07cc04a2020-11-16 22:08:34 -08002508#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002509 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2510 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2511 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002512
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002513psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2514{
2515 switch( operation->alg )
2516 {
Gilles Peskine81736312018-06-26 15:04:31 +02002517 case 0:
2518 /* The object has (apparently) been initialized but it is not
2519 * in use. It's ok to call abort on such an object, and there's
2520 * nothing to do. */
2521 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002522#if defined(MBEDTLS_MD2_C)
2523 case PSA_ALG_MD2:
2524 mbedtls_md2_free( &operation->ctx.md2 );
2525 break;
2526#endif
2527#if defined(MBEDTLS_MD4_C)
2528 case PSA_ALG_MD4:
2529 mbedtls_md4_free( &operation->ctx.md4 );
2530 break;
2531#endif
2532#if defined(MBEDTLS_MD5_C)
2533 case PSA_ALG_MD5:
2534 mbedtls_md5_free( &operation->ctx.md5 );
2535 break;
2536#endif
2537#if defined(MBEDTLS_RIPEMD160_C)
2538 case PSA_ALG_RIPEMD160:
2539 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2540 break;
2541#endif
2542#if defined(MBEDTLS_SHA1_C)
2543 case PSA_ALG_SHA_1:
2544 mbedtls_sha1_free( &operation->ctx.sha1 );
2545 break;
2546#endif
2547#if defined(MBEDTLS_SHA256_C)
2548 case PSA_ALG_SHA_224:
2549 case PSA_ALG_SHA_256:
2550 mbedtls_sha256_free( &operation->ctx.sha256 );
2551 break;
2552#endif
2553#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002554#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002555 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002556#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002557 case PSA_ALG_SHA_512:
2558 mbedtls_sha512_free( &operation->ctx.sha512 );
2559 break;
2560#endif
2561 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002562 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002563 }
2564 operation->alg = 0;
2565 return( PSA_SUCCESS );
2566}
2567
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002568psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002569 psa_algorithm_t alg )
2570{
Janos Follath24eed8d2019-11-22 13:21:35 +00002571 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002572
2573 /* A context must be freshly initialized before it can be set up. */
2574 if( operation->alg != 0 )
2575 {
2576 return( PSA_ERROR_BAD_STATE );
2577 }
2578
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002579 switch( alg )
2580 {
2581#if defined(MBEDTLS_MD2_C)
2582 case PSA_ALG_MD2:
2583 mbedtls_md2_init( &operation->ctx.md2 );
2584 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2585 break;
2586#endif
2587#if defined(MBEDTLS_MD4_C)
2588 case PSA_ALG_MD4:
2589 mbedtls_md4_init( &operation->ctx.md4 );
2590 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2591 break;
2592#endif
2593#if defined(MBEDTLS_MD5_C)
2594 case PSA_ALG_MD5:
2595 mbedtls_md5_init( &operation->ctx.md5 );
2596 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2597 break;
2598#endif
2599#if defined(MBEDTLS_RIPEMD160_C)
2600 case PSA_ALG_RIPEMD160:
2601 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2602 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2603 break;
2604#endif
2605#if defined(MBEDTLS_SHA1_C)
2606 case PSA_ALG_SHA_1:
2607 mbedtls_sha1_init( &operation->ctx.sha1 );
2608 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2609 break;
2610#endif
2611#if defined(MBEDTLS_SHA256_C)
2612 case PSA_ALG_SHA_224:
2613 mbedtls_sha256_init( &operation->ctx.sha256 );
2614 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2615 break;
2616 case PSA_ALG_SHA_256:
2617 mbedtls_sha256_init( &operation->ctx.sha256 );
2618 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2619 break;
2620#endif
2621#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002622#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002623 case PSA_ALG_SHA_384:
2624 mbedtls_sha512_init( &operation->ctx.sha512 );
2625 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2626 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002627#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002628 case PSA_ALG_SHA_512:
2629 mbedtls_sha512_init( &operation->ctx.sha512 );
2630 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2631 break;
2632#endif
2633 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002634 return( PSA_ALG_IS_HASH( alg ) ?
2635 PSA_ERROR_NOT_SUPPORTED :
2636 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002637 }
2638 if( ret == 0 )
2639 operation->alg = alg;
2640 else
2641 psa_hash_abort( operation );
2642 return( mbedtls_to_psa_error( ret ) );
2643}
2644
2645psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2646 const uint8_t *input,
2647 size_t input_length )
2648{
Janos Follath24eed8d2019-11-22 13:21:35 +00002649 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002650
2651 /* Don't require hash implementations to behave correctly on a
2652 * zero-length input, which may have an invalid pointer. */
2653 if( input_length == 0 )
2654 return( PSA_SUCCESS );
2655
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002656 switch( operation->alg )
2657 {
2658#if defined(MBEDTLS_MD2_C)
2659 case PSA_ALG_MD2:
2660 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2661 input, input_length );
2662 break;
2663#endif
2664#if defined(MBEDTLS_MD4_C)
2665 case PSA_ALG_MD4:
2666 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2667 input, input_length );
2668 break;
2669#endif
2670#if defined(MBEDTLS_MD5_C)
2671 case PSA_ALG_MD5:
2672 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2673 input, input_length );
2674 break;
2675#endif
2676#if defined(MBEDTLS_RIPEMD160_C)
2677 case PSA_ALG_RIPEMD160:
2678 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2679 input, input_length );
2680 break;
2681#endif
2682#if defined(MBEDTLS_SHA1_C)
2683 case PSA_ALG_SHA_1:
2684 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2685 input, input_length );
2686 break;
2687#endif
2688#if defined(MBEDTLS_SHA256_C)
2689 case PSA_ALG_SHA_224:
2690 case PSA_ALG_SHA_256:
2691 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2692 input, input_length );
2693 break;
2694#endif
2695#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002696#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002697 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002698#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002699 case PSA_ALG_SHA_512:
2700 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2701 input, input_length );
2702 break;
2703#endif
2704 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002705 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002706 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002707
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002708 if( ret != 0 )
2709 psa_hash_abort( operation );
2710 return( mbedtls_to_psa_error( ret ) );
2711}
2712
2713psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2714 uint8_t *hash,
2715 size_t hash_size,
2716 size_t *hash_length )
2717{
itayzafrir40835d42018-08-02 13:14:17 +03002718 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002719 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002720 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002721
2722 /* Fill the output buffer with something that isn't a valid hash
2723 * (barring an attack on the hash and deliberately-crafted input),
2724 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002725 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002726 /* If hash_size is 0 then hash may be NULL and then the
2727 * call to memset would have undefined behavior. */
2728 if( hash_size != 0 )
2729 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002730
2731 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002732 {
2733 status = PSA_ERROR_BUFFER_TOO_SMALL;
2734 goto exit;
2735 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002736
2737 switch( operation->alg )
2738 {
2739#if defined(MBEDTLS_MD2_C)
2740 case PSA_ALG_MD2:
2741 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2742 break;
2743#endif
2744#if defined(MBEDTLS_MD4_C)
2745 case PSA_ALG_MD4:
2746 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2747 break;
2748#endif
2749#if defined(MBEDTLS_MD5_C)
2750 case PSA_ALG_MD5:
2751 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2752 break;
2753#endif
2754#if defined(MBEDTLS_RIPEMD160_C)
2755 case PSA_ALG_RIPEMD160:
2756 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2757 break;
2758#endif
2759#if defined(MBEDTLS_SHA1_C)
2760 case PSA_ALG_SHA_1:
2761 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2762 break;
2763#endif
2764#if defined(MBEDTLS_SHA256_C)
2765 case PSA_ALG_SHA_224:
2766 case PSA_ALG_SHA_256:
2767 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2768 break;
2769#endif
2770#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002771#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002772 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002773#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002774 case PSA_ALG_SHA_512:
2775 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2776 break;
2777#endif
2778 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002779 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002780 }
itayzafrir40835d42018-08-02 13:14:17 +03002781 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002782
itayzafrir40835d42018-08-02 13:14:17 +03002783exit:
2784 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002785 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002786 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002787 return( psa_hash_abort( operation ) );
2788 }
2789 else
2790 {
2791 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002792 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002793 }
2794}
2795
Gilles Peskine2d277862018-06-18 15:41:12 +02002796psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2797 const uint8_t *hash,
2798 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002799{
2800 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2801 size_t actual_hash_length;
2802 psa_status_t status = psa_hash_finish( operation,
2803 actual_hash, sizeof( actual_hash ),
2804 &actual_hash_length );
2805 if( status != PSA_SUCCESS )
2806 return( status );
2807 if( actual_hash_length != hash_length )
2808 return( PSA_ERROR_INVALID_SIGNATURE );
2809 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2810 return( PSA_ERROR_INVALID_SIGNATURE );
2811 return( PSA_SUCCESS );
2812}
2813
Gilles Peskine0a749c82019-11-28 19:33:58 +01002814psa_status_t psa_hash_compute( psa_algorithm_t alg,
2815 const uint8_t *input, size_t input_length,
2816 uint8_t *hash, size_t hash_size,
2817 size_t *hash_length )
2818{
2819 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2820 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2821
2822 *hash_length = hash_size;
2823 status = psa_hash_setup( &operation, alg );
2824 if( status != PSA_SUCCESS )
2825 goto exit;
2826 status = psa_hash_update( &operation, input, input_length );
2827 if( status != PSA_SUCCESS )
2828 goto exit;
2829 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2830 if( status != PSA_SUCCESS )
2831 goto exit;
2832
2833exit:
2834 if( status == PSA_SUCCESS )
2835 status = psa_hash_abort( &operation );
2836 else
2837 psa_hash_abort( &operation );
2838 return( status );
2839}
2840
2841psa_status_t psa_hash_compare( psa_algorithm_t alg,
2842 const uint8_t *input, size_t input_length,
2843 const uint8_t *hash, size_t hash_length )
2844{
2845 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2847
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_verify( &operation, hash, 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
Gilles Peskineeb35d782019-01-22 17:56:16 +01002866psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2867 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002868{
2869 if( target_operation->alg != 0 )
2870 return( PSA_ERROR_BAD_STATE );
2871
2872 switch( source_operation->alg )
2873 {
2874 case 0:
2875 return( PSA_ERROR_BAD_STATE );
2876#if defined(MBEDTLS_MD2_C)
2877 case PSA_ALG_MD2:
2878 mbedtls_md2_clone( &target_operation->ctx.md2,
2879 &source_operation->ctx.md2 );
2880 break;
2881#endif
2882#if defined(MBEDTLS_MD4_C)
2883 case PSA_ALG_MD4:
2884 mbedtls_md4_clone( &target_operation->ctx.md4,
2885 &source_operation->ctx.md4 );
2886 break;
2887#endif
2888#if defined(MBEDTLS_MD5_C)
2889 case PSA_ALG_MD5:
2890 mbedtls_md5_clone( &target_operation->ctx.md5,
2891 &source_operation->ctx.md5 );
2892 break;
2893#endif
2894#if defined(MBEDTLS_RIPEMD160_C)
2895 case PSA_ALG_RIPEMD160:
2896 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2897 &source_operation->ctx.ripemd160 );
2898 break;
2899#endif
2900#if defined(MBEDTLS_SHA1_C)
2901 case PSA_ALG_SHA_1:
2902 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2903 &source_operation->ctx.sha1 );
2904 break;
2905#endif
2906#if defined(MBEDTLS_SHA256_C)
2907 case PSA_ALG_SHA_224:
2908 case PSA_ALG_SHA_256:
2909 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2910 &source_operation->ctx.sha256 );
2911 break;
2912#endif
2913#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002914#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002915 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002916#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002917 case PSA_ALG_SHA_512:
2918 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2919 &source_operation->ctx.sha512 );
2920 break;
2921#endif
2922 default:
2923 return( PSA_ERROR_NOT_SUPPORTED );
2924 }
2925
2926 target_operation->alg = source_operation->alg;
2927 return( PSA_SUCCESS );
2928}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002929
2930
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002931/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932/* MAC */
2933/****************************************************************/
2934
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002935static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002936 psa_algorithm_t alg,
2937 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002938 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002939 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002940{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002941 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002942 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002943
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002944 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002945 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002946
Gilles Peskine8c9def32018-02-08 10:02:12 +01002947 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2948 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002949 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002950 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002951 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002952 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002953 mode = MBEDTLS_MODE_STREAM;
2954 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002955 case PSA_ALG_CTR:
2956 mode = MBEDTLS_MODE_CTR;
2957 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002958 case PSA_ALG_CFB:
2959 mode = MBEDTLS_MODE_CFB;
2960 break;
2961 case PSA_ALG_OFB:
2962 mode = MBEDTLS_MODE_OFB;
2963 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002964 case PSA_ALG_ECB_NO_PADDING:
2965 mode = MBEDTLS_MODE_ECB;
2966 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002967 case PSA_ALG_CBC_NO_PADDING:
2968 mode = MBEDTLS_MODE_CBC;
2969 break;
2970 case PSA_ALG_CBC_PKCS7:
2971 mode = MBEDTLS_MODE_CBC;
2972 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002973 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002974 mode = MBEDTLS_MODE_CCM;
2975 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002976 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002977 mode = MBEDTLS_MODE_GCM;
2978 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002979 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2980 mode = MBEDTLS_MODE_CHACHAPOLY;
2981 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002982 default:
2983 return( NULL );
2984 }
2985 }
2986 else if( alg == PSA_ALG_CMAC )
2987 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002988 else
2989 return( NULL );
2990
2991 switch( key_type )
2992 {
2993 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002994 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002995 break;
2996 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002997 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2998 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002999 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03003000 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003001 else
mohammad1603f4f0d612018-06-03 15:04:51 +03003002 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003003 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
3004 * but two-key Triple-DES is functionally three-key Triple-DES
3005 * with K1=K3, so that's how we present it to mbedtls. */
3006 if( key_bits == 128 )
3007 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003008 break;
3009 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03003010 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003011 break;
3012 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03003013 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003014 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02003015 case PSA_KEY_TYPE_CHACHA20:
3016 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
3017 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003018 default:
3019 return( NULL );
3020 }
mohammad1603f4f0d612018-06-03 15:04:51 +03003021 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03003022 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003023
Jaeden Amero23bbb752018-06-26 14:16:54 +01003024 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
3025 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003026}
3027
John Durkop6ba40d12020-11-10 08:50:04 -08003028#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003029static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003030{
Gilles Peskine2d277862018-06-18 15:41:12 +02003031 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003032 {
3033 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003034 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003035 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003036 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003037 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003038 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003039 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003040 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003041 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003042 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003043 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003044 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003045 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003046 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003047 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003048 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003049 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02003050 return( 128 );
3051 default:
3052 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003053 }
3054}
John Durkop07cc04a2020-11-16 22:08:34 -08003055#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03003056
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003057/* Initialize the MAC operation structure. Once this function has been
3058 * called, psa_mac_abort can run and will do the right thing. */
3059static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
3060 psa_algorithm_t alg )
3061{
3062 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
3063
3064 operation->alg = alg;
3065 operation->key_set = 0;
3066 operation->iv_set = 0;
3067 operation->iv_required = 0;
3068 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003069 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003070
3071#if defined(MBEDTLS_CMAC_C)
3072 if( alg == PSA_ALG_CMAC )
3073 {
3074 operation->iv_required = 0;
3075 mbedtls_cipher_init( &operation->ctx.cmac );
3076 status = PSA_SUCCESS;
3077 }
3078 else
3079#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003080#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003081 if( PSA_ALG_IS_HMAC( operation->alg ) )
3082 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02003083 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
3084 operation->ctx.hmac.hash_ctx.alg = 0;
3085 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003086 }
3087 else
John Durkopd0321952020-10-29 21:37:36 -07003088#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003089 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02003090 if( ! PSA_ALG_IS_MAC( alg ) )
3091 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003092 }
3093
3094 if( status != PSA_SUCCESS )
3095 memset( operation, 0, sizeof( *operation ) );
3096 return( status );
3097}
3098
John Durkop6ba40d12020-11-10 08:50:04 -08003099#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003100static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
3101{
Gilles Peskine3f108122018-12-07 18:14:53 +01003102 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003103 return( psa_hash_abort( &hmac->hash_ctx ) );
3104}
John Durkop6ba40d12020-11-10 08:50:04 -08003105#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003106
Gilles Peskine8c9def32018-02-08 10:02:12 +01003107psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
3108{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003109 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003110 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003111 /* The object has (apparently) been initialized but it is not
3112 * in use. It's ok to call abort on such an object, and there's
3113 * nothing to do. */
3114 return( PSA_SUCCESS );
3115 }
3116 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003117#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003118 if( operation->alg == PSA_ALG_CMAC )
3119 {
3120 mbedtls_cipher_free( &operation->ctx.cmac );
3121 }
3122 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003123#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003124#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003125 if( PSA_ALG_IS_HMAC( operation->alg ) )
3126 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003127 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003128 }
3129 else
John Durkopd0321952020-10-29 21:37:36 -07003130#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003131 {
3132 /* Sanity check (shouldn't happen: operation->alg should
3133 * always have been initialized to a valid value). */
3134 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003135 }
Moran Peker41deec42018-04-04 15:43:05 +03003136
Gilles Peskine8c9def32018-02-08 10:02:12 +01003137 operation->alg = 0;
3138 operation->key_set = 0;
3139 operation->iv_set = 0;
3140 operation->iv_required = 0;
3141 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003142 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003143
Gilles Peskine8c9def32018-02-08 10:02:12 +01003144 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003145
3146bad_state:
3147 /* If abort is called on an uninitialized object, we can't trust
3148 * anything. Wipe the object in case it contains confidential data.
3149 * This may result in a memory leak if a pointer gets overwritten,
3150 * but it's too late to do anything about this. */
3151 memset( operation, 0, sizeof( *operation ) );
3152 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003153}
3154
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003155#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003156static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003157 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003158 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003159 const mbedtls_cipher_info_t *cipher_info )
3160{
Janos Follath24eed8d2019-11-22 13:21:35 +00003161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003162
3163 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003164
3165 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3166 if( ret != 0 )
3167 return( ret );
3168
3169 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003170 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003171 key_bits );
3172 return( ret );
3173}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003174#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003175
John Durkop6ba40d12020-11-10 08:50:04 -08003176#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003177static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3178 const uint8_t *key,
3179 size_t key_length,
3180 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003181{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003182 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003183 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003184 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003185 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003186 psa_status_t status;
3187
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003188 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3189 * overflow below. This should never trigger if the hash algorithm
3190 * is implemented correctly. */
3191 /* The size checks against the ipad and opad buffers cannot be written
3192 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3193 * because that triggers -Wlogical-op on GCC 7.3. */
3194 if( block_size > sizeof( ipad ) )
3195 return( PSA_ERROR_NOT_SUPPORTED );
3196 if( block_size > sizeof( hmac->opad ) )
3197 return( PSA_ERROR_NOT_SUPPORTED );
3198 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003199 return( PSA_ERROR_NOT_SUPPORTED );
3200
Gilles Peskined223b522018-06-11 18:12:58 +02003201 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003202 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003203 status = psa_hash_compute( hash_alg, key, key_length,
3204 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003205 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003206 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003207 }
Gilles Peskine96889972018-07-12 17:07:03 +02003208 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3209 * but it is permitted. It is common when HMAC is used in HKDF, for
3210 * example. Don't call `memcpy` in the 0-length because `key` could be
3211 * an invalid pointer which would make the behavior undefined. */
3212 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003213 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003214
Gilles Peskined223b522018-06-11 18:12:58 +02003215 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3216 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003217 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003218 ipad[i] ^= 0x36;
3219 memset( ipad + key_length, 0x36, block_size - key_length );
3220
3221 /* Copy the key material from ipad to opad, flipping the requisite bits,
3222 * and filling the rest of opad with the requisite constant. */
3223 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003224 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3225 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003226
Gilles Peskine01126fa2018-07-12 17:04:55 +02003227 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003228 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003229 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003230
Gilles Peskine01126fa2018-07-12 17:04:55 +02003231 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003232
3233cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003234 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003235
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003236 return( status );
3237}
John Durkop6ba40d12020-11-10 08:50:04 -08003238#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003239
Gilles Peskine89167cb2018-07-08 20:12:23 +02003240static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003241 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003242 psa_algorithm_t alg,
3243 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003244{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003246 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003247 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003248 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003249 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003250 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003251 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003252 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003253
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003254 /* A context must be freshly initialized before it can be set up. */
3255 if( operation->alg != 0 )
3256 {
3257 return( PSA_ERROR_BAD_STATE );
3258 }
3259
Gilles Peskined911eb72018-08-14 15:18:45 +02003260 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003261 if( status != PSA_SUCCESS )
3262 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003263 if( is_sign )
3264 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003265
Ronald Cron5c522922020-11-14 16:35:34 +01003266 status = psa_get_and_lock_transparent_key_slot_with_policy(
3267 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003268 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003269 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003270 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003271
Gilles Peskine8c9def32018-02-08 10:02:12 +01003272#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003273 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003274 {
3275 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003276 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003277 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003278 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003279 if( cipher_info == NULL )
3280 {
3281 status = PSA_ERROR_NOT_SUPPORTED;
3282 goto exit;
3283 }
3284 operation->mac_size = cipher_info->block_size;
3285 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3286 status = mbedtls_to_psa_error( ret );
3287 }
3288 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003289#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003290#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02003291 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003292 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003293 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003294 if( hash_alg == 0 )
3295 {
3296 status = PSA_ERROR_NOT_SUPPORTED;
3297 goto exit;
3298 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003299
3300 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3301 /* Sanity check. This shouldn't fail on a valid configuration. */
3302 if( operation->mac_size == 0 ||
3303 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3304 {
3305 status = PSA_ERROR_NOT_SUPPORTED;
3306 goto exit;
3307 }
3308
Gilles Peskine8e338702019-07-30 20:06:31 +02003309 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003310 {
3311 status = PSA_ERROR_INVALID_ARGUMENT;
3312 goto exit;
3313 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003314
Gilles Peskine01126fa2018-07-12 17:04:55 +02003315 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003316 slot->data.key.data,
3317 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003318 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003319 }
3320 else
John Durkopd0321952020-10-29 21:37:36 -07003321#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003322 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003323 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003324 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003325 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003326
Gilles Peskined911eb72018-08-14 15:18:45 +02003327 if( truncated == 0 )
3328 {
3329 /* The "normal" case: untruncated algorithm. Nothing to do. */
3330 }
3331 else if( truncated < 4 )
3332 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003333 /* A very short MAC is too short for security since it can be
3334 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3335 * so we make this our minimum, even though 32 bits is still
3336 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003337 status = PSA_ERROR_NOT_SUPPORTED;
3338 }
3339 else if( truncated > operation->mac_size )
3340 {
3341 /* It's impossible to "truncate" to a larger length. */
3342 status = PSA_ERROR_INVALID_ARGUMENT;
3343 }
3344 else
3345 operation->mac_size = truncated;
3346
Gilles Peskinefbfac682018-07-08 20:51:54 +02003347exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003348 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003349 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003350 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003351 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003352 else
3353 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003354 operation->key_set = 1;
3355 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003356
Ronald Cron5c522922020-11-14 16:35:34 +01003357 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003358
Ronald Cron5c522922020-11-14 16:35:34 +01003359 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003360}
3361
Gilles Peskine89167cb2018-07-08 20:12:23 +02003362psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003363 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003364 psa_algorithm_t alg )
3365{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003366 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003367}
3368
3369psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003370 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003371 psa_algorithm_t alg )
3372{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003373 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003374}
3375
Gilles Peskine8c9def32018-02-08 10:02:12 +01003376psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3377 const uint8_t *input,
3378 size_t input_length )
3379{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003380 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003381 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003382 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003383 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003384 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003385 operation->has_input = 1;
3386
Gilles Peskine8c9def32018-02-08 10:02:12 +01003387#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003388 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003389 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003390 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3391 input, input_length );
3392 status = mbedtls_to_psa_error( ret );
3393 }
3394 else
3395#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003396#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003397 if( PSA_ALG_IS_HMAC( operation->alg ) )
3398 {
3399 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3400 input_length );
3401 }
3402 else
John Durkopd0321952020-10-29 21:37:36 -07003403#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003404 {
3405 /* This shouldn't happen if `operation` was initialized by
3406 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003407 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003408 }
3409
Gilles Peskinefbfac682018-07-08 20:51:54 +02003410 if( status != PSA_SUCCESS )
3411 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003412 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003413}
3414
John Durkop6ba40d12020-11-10 08:50:04 -08003415#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003416static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3417 uint8_t *mac,
3418 size_t mac_size )
3419{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003420 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003421 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3422 size_t hash_size = 0;
3423 size_t block_size = psa_get_hash_block_size( hash_alg );
3424 psa_status_t status;
3425
Gilles Peskine01126fa2018-07-12 17:04:55 +02003426 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3427 if( status != PSA_SUCCESS )
3428 return( status );
3429 /* From here on, tmp needs to be wiped. */
3430
3431 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3432 if( status != PSA_SUCCESS )
3433 goto exit;
3434
3435 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3436 if( status != PSA_SUCCESS )
3437 goto exit;
3438
3439 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3440 if( status != PSA_SUCCESS )
3441 goto exit;
3442
Gilles Peskined911eb72018-08-14 15:18:45 +02003443 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3444 if( status != PSA_SUCCESS )
3445 goto exit;
3446
3447 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003448
3449exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003450 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003451 return( status );
3452}
John Durkop6ba40d12020-11-10 08:50:04 -08003453#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003454
mohammad16036df908f2018-04-02 08:34:15 -07003455static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003456 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003457 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003458{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003459 if( ! operation->key_set )
3460 return( PSA_ERROR_BAD_STATE );
3461 if( operation->iv_required && ! operation->iv_set )
3462 return( PSA_ERROR_BAD_STATE );
3463
Gilles Peskine8c9def32018-02-08 10:02:12 +01003464 if( mac_size < operation->mac_size )
3465 return( PSA_ERROR_BUFFER_TOO_SMALL );
3466
Gilles Peskine8c9def32018-02-08 10:02:12 +01003467#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003468 if( operation->alg == PSA_ALG_CMAC )
3469 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003470 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3471 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3472 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003473 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003474 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003475 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003476 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003477 else
3478#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003479#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003480 if( PSA_ALG_IS_HMAC( operation->alg ) )
3481 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003482 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003483 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003484 }
3485 else
John Durkopd0321952020-10-29 21:37:36 -07003486#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003487 {
3488 /* This shouldn't happen if `operation` was initialized by
3489 * a setup function. */
3490 return( PSA_ERROR_BAD_STATE );
3491 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003492}
3493
Gilles Peskineacd4be32018-07-08 19:56:25 +02003494psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3495 uint8_t *mac,
3496 size_t mac_size,
3497 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003498{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003499 psa_status_t status;
3500
Jaeden Amero252ef282019-02-15 14:05:35 +00003501 if( operation->alg == 0 )
3502 {
3503 return( PSA_ERROR_BAD_STATE );
3504 }
3505
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003506 /* Fill the output buffer with something that isn't a valid mac
3507 * (barring an attack on the mac and deliberately-crafted input),
3508 * in case the caller doesn't check the return status properly. */
3509 *mac_length = mac_size;
3510 /* If mac_size is 0 then mac may be NULL and then the
3511 * call to memset would have undefined behavior. */
3512 if( mac_size != 0 )
3513 memset( mac, '!', mac_size );
3514
Gilles Peskine89167cb2018-07-08 20:12:23 +02003515 if( ! operation->is_sign )
3516 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003517 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003518 }
mohammad16036df908f2018-04-02 08:34:15 -07003519
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003520 status = psa_mac_finish_internal( operation, mac, mac_size );
3521
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003522 if( status == PSA_SUCCESS )
3523 {
3524 status = psa_mac_abort( operation );
3525 if( status == PSA_SUCCESS )
3526 *mac_length = operation->mac_size;
3527 else
3528 memset( mac, '!', mac_size );
3529 }
3530 else
3531 psa_mac_abort( operation );
3532 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003533}
3534
Gilles Peskineacd4be32018-07-08 19:56:25 +02003535psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3536 const uint8_t *mac,
3537 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003538{
Gilles Peskine828ed142018-06-18 23:25:51 +02003539 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003540 psa_status_t status;
3541
Jaeden Amero252ef282019-02-15 14:05:35 +00003542 if( operation->alg == 0 )
3543 {
3544 return( PSA_ERROR_BAD_STATE );
3545 }
3546
Gilles Peskine89167cb2018-07-08 20:12:23 +02003547 if( operation->is_sign )
3548 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003549 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003550 }
3551 if( operation->mac_size != mac_length )
3552 {
3553 status = PSA_ERROR_INVALID_SIGNATURE;
3554 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003555 }
mohammad16036df908f2018-04-02 08:34:15 -07003556
3557 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003558 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003559 if( status != PSA_SUCCESS )
3560 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003561
3562 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3563 status = PSA_ERROR_INVALID_SIGNATURE;
3564
3565cleanup:
3566 if( status == PSA_SUCCESS )
3567 status = psa_mac_abort( operation );
3568 else
3569 psa_mac_abort( operation );
3570
Gilles Peskine3f108122018-12-07 18:14:53 +01003571 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003572
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003573 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003574}
3575
3576
Gilles Peskine20035e32018-02-03 22:44:14 +01003577
Gilles Peskine20035e32018-02-03 22:44:14 +01003578/****************************************************************/
3579/* Asymmetric cryptography */
3580/****************************************************************/
3581
John Durkop6ba40d12020-11-10 08:50:04 -08003582#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3583 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003584/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003585 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003586static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3587 size_t hash_length,
3588 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003589{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003590 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003591 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003592 *md_alg = mbedtls_md_get_type( md_info );
3593
3594 /* The Mbed TLS RSA module uses an unsigned int for hash length
3595 * parameters. Validate that it fits so that we don't risk an
3596 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003597#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003598 if( hash_length > UINT_MAX )
3599 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003600#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003601
John Durkop0e005192020-10-31 22:06:54 -07003602#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003603 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3604 * must be correct. */
3605 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3606 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003607 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003608 if( md_info == NULL )
3609 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003610 if( mbedtls_md_get_size( md_info ) != hash_length )
3611 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003612 }
John Durkop0e005192020-10-31 22:06:54 -07003613#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003614
John Durkop0e005192020-10-31 22:06:54 -07003615#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003616 /* PSS requires a hash internally. */
3617 if( PSA_ALG_IS_RSA_PSS( alg ) )
3618 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003619 if( md_info == NULL )
3620 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003621 }
John Durkop0e005192020-10-31 22:06:54 -07003622#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003623
Gilles Peskine61b91d42018-06-08 16:09:36 +02003624 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003625}
3626
Gilles Peskine2b450e32018-06-27 15:42:46 +02003627static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3628 psa_algorithm_t alg,
3629 const uint8_t *hash,
3630 size_t hash_length,
3631 uint8_t *signature,
3632 size_t signature_size,
3633 size_t *signature_length )
3634{
3635 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003636 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003637 mbedtls_md_type_t md_alg;
3638
3639 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3640 if( status != PSA_SUCCESS )
3641 return( status );
3642
Gilles Peskine630a18a2018-06-29 17:49:35 +02003643 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003644 return( PSA_ERROR_BUFFER_TOO_SMALL );
3645
John Durkop0e005192020-10-31 22:06:54 -07003646#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003647 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3648 {
3649 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3650 MBEDTLS_MD_NONE );
3651 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003652 mbedtls_psa_get_random,
3653 mbedtls_psa_random_state( &global_data.rng ),
Gilles Peskine2b450e32018-06-27 15:42:46 +02003654 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003655 md_alg,
3656 (unsigned int) hash_length,
3657 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003658 signature );
3659 }
3660 else
John Durkop0e005192020-10-31 22:06:54 -07003661#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3662#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003663 if( PSA_ALG_IS_RSA_PSS( alg ) )
3664 {
3665 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3666 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003667 mbedtls_psa_get_random,
3668 mbedtls_psa_random_state( &global_data.rng ),
Gilles Peskine2b450e32018-06-27 15:42:46 +02003669 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003670 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003671 (unsigned int) hash_length,
3672 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003673 signature );
3674 }
3675 else
John Durkop0e005192020-10-31 22:06:54 -07003676#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003677 {
3678 return( PSA_ERROR_INVALID_ARGUMENT );
3679 }
3680
3681 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003682 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003683 return( mbedtls_to_psa_error( ret ) );
3684}
3685
3686static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3687 psa_algorithm_t alg,
3688 const uint8_t *hash,
3689 size_t hash_length,
3690 const uint8_t *signature,
3691 size_t signature_length )
3692{
3693 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003694 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003695 mbedtls_md_type_t md_alg;
3696
3697 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3698 if( status != PSA_SUCCESS )
3699 return( status );
3700
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003701 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3702 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003703
John Durkop0e005192020-10-31 22:06:54 -07003704#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003705 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3706 {
3707 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3708 MBEDTLS_MD_NONE );
3709 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003710 mbedtls_psa_get_random,
3711 mbedtls_psa_random_state( &global_data.rng ),
Gilles Peskine2b450e32018-06-27 15:42:46 +02003712 MBEDTLS_RSA_PUBLIC,
3713 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003714 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003715 hash,
3716 signature );
3717 }
3718 else
John Durkop0e005192020-10-31 22:06:54 -07003719#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3720#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003721 if( PSA_ALG_IS_RSA_PSS( alg ) )
3722 {
3723 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3724 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003725 mbedtls_psa_get_random,
3726 mbedtls_psa_random_state( &global_data.rng ),
Gilles Peskine2b450e32018-06-27 15:42:46 +02003727 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003728 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003729 (unsigned int) hash_length,
3730 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003731 signature );
3732 }
3733 else
John Durkop0e005192020-10-31 22:06:54 -07003734#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003735 {
3736 return( PSA_ERROR_INVALID_ARGUMENT );
3737 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003738
3739 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3740 * the rest of the signature is invalid". This has little use in
3741 * practice and PSA doesn't report this distinction. */
3742 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3743 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003744 return( mbedtls_to_psa_error( ret ) );
3745}
John Durkop6ba40d12020-11-10 08:50:04 -08003746#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3747 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003748
John Durkop6ba40d12020-11-10 08:50:04 -08003749#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3750 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003751/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3752 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3753 * (even though these functions don't modify it). */
3754static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3755 psa_algorithm_t alg,
3756 const uint8_t *hash,
3757 size_t hash_length,
3758 uint8_t *signature,
3759 size_t signature_size,
3760 size_t *signature_length )
3761{
Janos Follath24eed8d2019-11-22 13:21:35 +00003762 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003763 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003764 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003765 mbedtls_mpi_init( &r );
3766 mbedtls_mpi_init( &s );
3767
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003768 if( signature_size < 2 * curve_bytes )
3769 {
3770 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3771 goto cleanup;
3772 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003773
John Durkop0ea39e02020-10-13 19:58:20 -07003774#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003775 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3776 {
3777 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3778 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3779 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003780 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3781 &ecp->d, hash,
3782 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003783 mbedtls_psa_get_random,
3784 mbedtls_psa_random_state( &global_data.rng ) ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003785 }
3786 else
John Durkop0ea39e02020-10-13 19:58:20 -07003787#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003788 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003789 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003790 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3791 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003792 mbedtls_psa_get_random,
3793 mbedtls_psa_random_state( &global_data.rng ) ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003794 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003795
3796 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3797 signature,
3798 curve_bytes ) );
3799 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3800 signature + curve_bytes,
3801 curve_bytes ) );
3802
3803cleanup:
3804 mbedtls_mpi_free( &r );
3805 mbedtls_mpi_free( &s );
3806 if( ret == 0 )
3807 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003808 return( mbedtls_to_psa_error( ret ) );
3809}
3810
3811static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3812 const uint8_t *hash,
3813 size_t hash_length,
3814 const uint8_t *signature,
3815 size_t signature_length )
3816{
Janos Follath24eed8d2019-11-22 13:21:35 +00003817 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003818 mbedtls_mpi r, s;
3819 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3820 mbedtls_mpi_init( &r );
3821 mbedtls_mpi_init( &s );
3822
3823 if( signature_length != 2 * curve_bytes )
3824 return( PSA_ERROR_INVALID_SIGNATURE );
3825
3826 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3827 signature,
3828 curve_bytes ) );
3829 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3830 signature + curve_bytes,
3831 curve_bytes ) );
3832
Steven Cooremanacda8342020-07-24 23:09:52 +02003833 /* Check whether the public part is loaded. If not, load it. */
3834 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3835 {
3836 MBEDTLS_MPI_CHK(
3837 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003838 mbedtls_psa_get_random, mbedtls_psa_random_state( &global_data.rng ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003839 }
3840
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003841 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3842 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003843
3844cleanup:
3845 mbedtls_mpi_free( &r );
3846 mbedtls_mpi_free( &s );
3847 return( mbedtls_to_psa_error( ret ) );
3848}
John Durkop6ba40d12020-11-10 08:50:04 -08003849#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3850 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003851
Ronald Croncf56a0a2020-08-04 09:51:30 +02003852psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003853 psa_algorithm_t alg,
3854 const uint8_t *hash,
3855 size_t hash_length,
3856 uint8_t *signature,
3857 size_t signature_size,
3858 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003859{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003860 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003861 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003862 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003863
3864 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003865 /* Immediately reject a zero-length signature buffer. This guarantees
3866 * that signature must be a valid pointer. (On the other hand, the hash
3867 * buffer can in principle be empty since it doesn't actually have
3868 * to be a hash.) */
3869 if( signature_size == 0 )
3870 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003871
Ronald Cron5c522922020-11-14 16:35:34 +01003872 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3873 PSA_KEY_USAGE_SIGN_HASH,
3874 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003875 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003876 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003877 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003878 {
3879 status = PSA_ERROR_INVALID_ARGUMENT;
3880 goto exit;
3881 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003882
Steven Cooremancd84cb42020-07-16 20:28:36 +02003883 /* Try any of the available accelerators first */
3884 status = psa_driver_wrapper_sign_hash( slot,
3885 alg,
3886 hash,
3887 hash_length,
3888 signature,
3889 signature_size,
3890 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003891 if( status != PSA_ERROR_NOT_SUPPORTED ||
3892 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003893 goto exit;
3894
Steven Cooreman7a250572020-07-17 16:43:05 +02003895 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003896#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3897 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003898 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003899 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003900 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003901
Steven Cooreman4fed4552020-08-03 14:46:03 +02003902 status = psa_load_rsa_representation( slot->attr.type,
3903 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003904 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003905 &rsa );
3906 if( status != PSA_SUCCESS )
3907 goto exit;
3908
Steven Cooremana2371e52020-07-28 14:30:39 +02003909 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003910 alg,
3911 hash, hash_length,
3912 signature, signature_size,
3913 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003914
Steven Cooremana2371e52020-07-28 14:30:39 +02003915 mbedtls_rsa_free( rsa );
3916 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003917 }
3918 else
John Durkop6ba40d12020-11-10 08:50:04 -08003919#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3920 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003921 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003922 {
John Durkop9814fa22020-11-04 12:28:15 -08003923#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3924 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003925 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003926#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003927 PSA_ALG_IS_ECDSA( alg )
3928#else
3929 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3930#endif
3931 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003932 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003933 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003934 status = psa_load_ecp_representation( slot->attr.type,
3935 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003936 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003937 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003938 if( status != PSA_SUCCESS )
3939 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003940 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003941 alg,
3942 hash, hash_length,
3943 signature, signature_size,
3944 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003945 mbedtls_ecp_keypair_free( ecp );
3946 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003947 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003948 else
John Durkop9814fa22020-11-04 12:28:15 -08003949#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3950 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003951 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003952 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003953 }
itayzafrir5c753392018-05-08 11:18:38 +03003954 }
3955 else
itayzafrir5c753392018-05-08 11:18:38 +03003956 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003957 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003958 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003959
3960exit:
3961 /* Fill the unused part of the output buffer (the whole buffer on error,
3962 * the trailing part on success) with something that isn't a valid mac
3963 * (barring an attack on the mac and deliberately-crafted input),
3964 * in case the caller doesn't check the return status properly. */
3965 if( status == PSA_SUCCESS )
3966 memset( signature + *signature_length, '!',
3967 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003968 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003969 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003970 /* If signature_size is 0 then we have nothing to do. We must not call
3971 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003972
Ronald Cron5c522922020-11-14 16:35:34 +01003973 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003974
Ronald Cron5c522922020-11-14 16:35:34 +01003975 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003976}
3977
Ronald Croncf56a0a2020-08-04 09:51:30 +02003978psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003979 psa_algorithm_t alg,
3980 const uint8_t *hash,
3981 size_t hash_length,
3982 const uint8_t *signature,
3983 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003984{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003985 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003986 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003987 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003988
Ronald Cron5c522922020-11-14 16:35:34 +01003989 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3990 PSA_KEY_USAGE_VERIFY_HASH,
3991 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003992 if( status != PSA_SUCCESS )
3993 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003994
Steven Cooreman55ae2172020-07-17 19:46:15 +02003995 /* Try any of the available accelerators first */
3996 status = psa_driver_wrapper_verify_hash( slot,
3997 alg,
3998 hash,
3999 hash_length,
4000 signature,
4001 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02004002 if( status != PSA_ERROR_NOT_SUPPORTED ||
4003 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004004 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02004005
John Durkop6ba40d12020-11-10 08:50:04 -08004006#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
4007 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02004008 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004009 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004010 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02004011
Steven Cooreman4fed4552020-08-03 14:46:03 +02004012 status = psa_load_rsa_representation( slot->attr.type,
4013 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004014 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004015 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004016 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004017 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004018
Steven Cooremana2371e52020-07-28 14:30:39 +02004019 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02004020 alg,
4021 hash, hash_length,
4022 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004023 mbedtls_rsa_free( rsa );
4024 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004025 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004026 }
4027 else
John Durkop6ba40d12020-11-10 08:50:04 -08004028#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
4029 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02004030 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03004031 {
John Durkop9814fa22020-11-04 12:28:15 -08004032#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4033 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004034 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02004035 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004036 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004037 status = psa_load_ecp_representation( slot->attr.type,
4038 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004039 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004040 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004041 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004042 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004043 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004044 hash, hash_length,
4045 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004046 mbedtls_ecp_keypair_free( ecp );
4047 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004048 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02004049 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004050 else
John Durkop9814fa22020-11-04 12:28:15 -08004051#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4052 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004053 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004054 status = PSA_ERROR_INVALID_ARGUMENT;
4055 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004056 }
itayzafrir5c753392018-05-08 11:18:38 +03004057 }
Gilles Peskine20035e32018-02-03 22:44:14 +01004058 else
Gilles Peskine20035e32018-02-03 22:44:14 +01004059 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004060 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01004061 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004062
4063exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004064 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004065
Ronald Cron5c522922020-11-14 16:35:34 +01004066 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01004067}
4068
John Durkop0e005192020-10-31 22:06:54 -07004069#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02004070static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
4071 mbedtls_rsa_context *rsa )
4072{
4073 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
4074 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
4075 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
4076 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
4077}
John Durkop0e005192020-10-31 22:06:54 -07004078#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02004079
Ronald Croncf56a0a2020-08-04 09:51:30 +02004080psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004081 psa_algorithm_t alg,
4082 const uint8_t *input,
4083 size_t input_length,
4084 const uint8_t *salt,
4085 size_t salt_length,
4086 uint8_t *output,
4087 size_t output_size,
4088 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004089{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004090 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004091 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004092 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004093
Darryl Green5cc689a2018-07-24 15:34:10 +01004094 (void) input;
4095 (void) input_length;
4096 (void) salt;
4097 (void) output;
4098 (void) output_size;
4099
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004100 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004101
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004102 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4103 return( PSA_ERROR_INVALID_ARGUMENT );
4104
Ronald Cron5c522922020-11-14 16:35:34 +01004105 status = psa_get_and_lock_transparent_key_slot_with_policy(
4106 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004107 if( status != PSA_SUCCESS )
4108 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004109 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4110 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004111 {
4112 status = PSA_ERROR_INVALID_ARGUMENT;
4113 goto exit;
4114 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004115
John Durkop6ba40d12020-11-10 08:50:04 -08004116#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4117 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004118 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004119 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004120 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004121 status = psa_load_rsa_representation( slot->attr.type,
4122 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004123 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004124 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004125 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004126 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004127
4128 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004129 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004130 status = PSA_ERROR_BUFFER_TOO_SMALL;
4131 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004132 }
John Durkop0e005192020-10-31 22:06:54 -07004133#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004134 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004135 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004136 status = mbedtls_to_psa_error(
4137 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004138 mbedtls_psa_get_random,
4139 mbedtls_psa_random_state( &global_data.rng ),
Steven Cooreman4fed4552020-08-03 14:46:03 +02004140 MBEDTLS_RSA_PUBLIC,
4141 input_length,
4142 input,
4143 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004144 }
4145 else
John Durkop0e005192020-10-31 22:06:54 -07004146#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4147#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004148 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004149 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004150 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004151 status = mbedtls_to_psa_error(
4152 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004153 mbedtls_psa_get_random,
4154 mbedtls_psa_random_state( &global_data.rng ),
Steven Cooreman4fed4552020-08-03 14:46:03 +02004155 MBEDTLS_RSA_PUBLIC,
4156 salt, salt_length,
4157 input_length,
4158 input,
4159 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004160 }
4161 else
John Durkop0e005192020-10-31 22:06:54 -07004162#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004163 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004164 status = PSA_ERROR_INVALID_ARGUMENT;
4165 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004166 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004167rsa_exit:
4168 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004169 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004170
Steven Cooremana2371e52020-07-28 14:30:39 +02004171 mbedtls_rsa_free( rsa );
4172 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004173 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004174 else
John Durkop9814fa22020-11-04 12:28:15 -08004175#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08004176 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004177 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004178 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004179 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004180
4181exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004182 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004183
Ronald Cron5c522922020-11-14 16:35:34 +01004184 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004185}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004186
Ronald Croncf56a0a2020-08-04 09:51:30 +02004187psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004188 psa_algorithm_t alg,
4189 const uint8_t *input,
4190 size_t input_length,
4191 const uint8_t *salt,
4192 size_t salt_length,
4193 uint8_t *output,
4194 size_t output_size,
4195 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004196{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004197 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004198 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004199 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004200
Darryl Green5cc689a2018-07-24 15:34:10 +01004201 (void) input;
4202 (void) input_length;
4203 (void) salt;
4204 (void) output;
4205 (void) output_size;
4206
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004207 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004208
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004209 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4210 return( PSA_ERROR_INVALID_ARGUMENT );
4211
Ronald Cron5c522922020-11-14 16:35:34 +01004212 status = psa_get_and_lock_transparent_key_slot_with_policy(
4213 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004214 if( status != PSA_SUCCESS )
4215 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004216 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004217 {
4218 status = PSA_ERROR_INVALID_ARGUMENT;
4219 goto exit;
4220 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004221
John Durkop6ba40d12020-11-10 08:50:04 -08004222#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4223 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004224 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004225 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004226 mbedtls_rsa_context *rsa = NULL;
4227 status = psa_load_rsa_representation( slot->attr.type,
4228 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004229 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004230 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004231 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004232 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004233
Steven Cooremana2371e52020-07-28 14:30:39 +02004234 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004235 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004236 status = PSA_ERROR_INVALID_ARGUMENT;
4237 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004238 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004239
John Durkop0e005192020-10-31 22:06:54 -07004240#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004241 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004242 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004243 status = mbedtls_to_psa_error(
4244 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004245 mbedtls_psa_get_random,
4246 mbedtls_psa_random_state( &global_data.rng ),
Steven Cooreman4fed4552020-08-03 14:46:03 +02004247 MBEDTLS_RSA_PRIVATE,
4248 output_length,
4249 input,
4250 output,
4251 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004252 }
4253 else
John Durkop0e005192020-10-31 22:06:54 -07004254#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4255#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004256 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004257 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004258 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004259 status = mbedtls_to_psa_error(
4260 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004261 mbedtls_psa_get_random,
4262 mbedtls_psa_random_state( &global_data.rng ),
Steven Cooreman4fed4552020-08-03 14:46:03 +02004263 MBEDTLS_RSA_PRIVATE,
4264 salt, salt_length,
4265 output_length,
4266 input,
4267 output,
4268 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004269 }
4270 else
John Durkop0e005192020-10-31 22:06:54 -07004271#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004272 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004273 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004274 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004275
Steven Cooreman4fed4552020-08-03 14:46:03 +02004276rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004277 mbedtls_rsa_free( rsa );
4278 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004279 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004280 else
John Durkop6ba40d12020-11-10 08:50:04 -08004281#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
4282 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004283 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004284 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004285 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004286
4287exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004288 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004289
Ronald Cron5c522922020-11-14 16:35:34 +01004290 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004291}
Gilles Peskine20035e32018-02-03 22:44:14 +01004292
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004293
4294
mohammad1603503973b2018-03-12 15:59:30 +02004295/****************************************************************/
4296/* Symmetric cryptography */
4297/****************************************************************/
4298
Gilles Peskinee553c652018-06-04 16:22:46 +02004299static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004300 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004301 psa_algorithm_t alg,
4302 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004303{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004304 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004305 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004306 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004307 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004308 size_t key_bits;
4309 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004310 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4311 PSA_KEY_USAGE_ENCRYPT :
4312 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004313
Steven Cooremand3feccd2020-09-01 15:56:14 +02004314 /* A context must be freshly initialized before it can be set up. */
4315 if( operation->alg != 0 )
4316 return( PSA_ERROR_BAD_STATE );
4317
Steven Cooremana07b9972020-09-10 14:54:14 +02004318 /* The requested algorithm must be one that can be processed by cipher. */
4319 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004320 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004321
Steven Cooremanef8575e2020-09-11 11:44:50 +02004322 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004323 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004324 if( status != PSA_SUCCESS )
4325 goto exit;
4326
4327 /* Initialize the operation struct members, except for alg. The alg member
4328 * is used to indicate to psa_cipher_abort that there are resources to free,
4329 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004330 operation->key_set = 0;
4331 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004332 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004333 operation->iv_size = 0;
4334 operation->block_size = 0;
4335 if( alg == PSA_ALG_ECB_NO_PADDING )
4336 operation->iv_required = 0;
4337 else
4338 operation->iv_required = 1;
4339
Steven Cooremana07b9972020-09-10 14:54:14 +02004340 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004341 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004342 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004343 slot,
4344 alg );
4345 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004346 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004347 slot,
4348 alg );
4349
Steven Cooremanef8575e2020-09-11 11:44:50 +02004350 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004351 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004352 /* Once the driver context is initialised, it needs to be freed using
4353 * psa_cipher_abort. Indicate this through setting alg. */
4354 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004355 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004356
Steven Cooremand3feccd2020-09-01 15:56:14 +02004357 if( status != PSA_ERROR_NOT_SUPPORTED ||
4358 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4359 goto exit;
4360
Steven Cooremana07b9972020-09-10 14:54:14 +02004361 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004362 * available for the given algorithm & key. */
4363 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004364
Steven Cooremana07b9972020-09-10 14:54:14 +02004365 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004366 * psa_cipher_abort. Indicate there is something to be freed through setting
4367 * alg, and indicate the operation is being done using mbedtls crypto through
4368 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004369 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004370 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004371
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004372 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004373 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004374 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004375 {
4376 status = PSA_ERROR_NOT_SUPPORTED;
4377 goto exit;
4378 }
mohammad1603503973b2018-03-12 15:59:30 +02004379
mohammad1603503973b2018-03-12 15:59:30 +02004380 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004381 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004382 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004383
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004384#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004385 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004386 {
4387 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004388 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004389 memcpy( keys, slot->data.key.data, 16 );
4390 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004391 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4392 keys,
4393 192, cipher_operation );
4394 }
4395 else
4396#endif
4397 {
4398 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004399 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004400 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004401 }
Moran Peker41deec42018-04-04 15:43:05 +03004402 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004403 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004404
mohammad16038481e742018-03-18 13:57:31 +02004405#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004406 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004407 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004408 case PSA_ALG_CBC_NO_PADDING:
4409 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4410 MBEDTLS_PADDING_NONE );
4411 break;
4412 case PSA_ALG_CBC_PKCS7:
4413 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4414 MBEDTLS_PADDING_PKCS7 );
4415 break;
4416 default:
4417 /* The algorithm doesn't involve padding. */
4418 ret = 0;
4419 break;
4420 }
4421 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004422 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004423#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4424
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004425 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004426 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004427 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4428 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004429 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004430 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004431 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004432#if defined(MBEDTLS_CHACHA20_C)
4433 else
4434 if( alg == PSA_ALG_CHACHA20 )
4435 operation->iv_size = 12;
4436#endif
mohammad1603503973b2018-03-12 15:59:30 +02004437
Steven Cooreman7df02922020-09-09 15:28:49 +02004438 status = PSA_SUCCESS;
4439
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004440exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004441 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004442 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004443 if( status == PSA_SUCCESS )
4444 {
4445 /* Update operation flags for both driver and software implementations */
4446 operation->key_set = 1;
4447 }
4448 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004449 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004450
Ronald Cron5c522922020-11-14 16:35:34 +01004451 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004452
Ronald Cron5c522922020-11-14 16:35:34 +01004453 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004454}
4455
Gilles Peskinefe119512018-07-08 21:39:34 +02004456psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004457 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004458 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004459{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004460 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004461}
4462
Gilles Peskinefe119512018-07-08 21:39:34 +02004463psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004464 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004465 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004466{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004467 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004468}
4469
Gilles Peskinefe119512018-07-08 21:39:34 +02004470psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004471 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004472 size_t iv_size,
4473 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004474{
itayzafrir534bd7c2018-08-02 13:56:32 +03004475 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004476 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004477 if( operation->iv_set || ! operation->iv_required )
4478 {
4479 return( PSA_ERROR_BAD_STATE );
4480 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004481
Steven Cooremanef8575e2020-09-11 11:44:50 +02004482 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004483 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004484 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004485 iv,
4486 iv_size,
4487 iv_length );
4488 goto exit;
4489 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004490
Moran Peker41deec42018-04-04 15:43:05 +03004491 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004492 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004493 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004494 goto exit;
4495 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01004496 ret = mbedtls_psa_get_random( mbedtls_psa_random_state( &global_data.rng ),
4497 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004498 if( ret != 0 )
4499 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004500 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004501 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004502 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004503
mohammad16038481e742018-03-18 13:57:31 +02004504 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004505 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004506
Moran Peker395db872018-05-31 14:07:14 +03004507exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004508 if( status == PSA_SUCCESS )
4509 operation->iv_set = 1;
4510 else
Moran Peker395db872018-05-31 14:07:14 +03004511 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004512 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004513}
4514
Gilles Peskinefe119512018-07-08 21:39:34 +02004515psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004516 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004517 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004518{
itayzafrir534bd7c2018-08-02 13:56:32 +03004519 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004520 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004521 if( operation->iv_set || ! operation->iv_required )
4522 {
4523 return( PSA_ERROR_BAD_STATE );
4524 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004525
Steven Cooremanef8575e2020-09-11 11:44:50 +02004526 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004527 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004528 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004529 iv,
4530 iv_length );
4531 goto exit;
4532 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004533
Moran Pekera28258c2018-05-29 16:25:04 +03004534 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004535 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004536 status = PSA_ERROR_INVALID_ARGUMENT;
4537 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004538 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004539 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4540 status = mbedtls_to_psa_error( ret );
4541exit:
4542 if( status == PSA_SUCCESS )
4543 operation->iv_set = 1;
4544 else
mohammad1603503973b2018-03-12 15:59:30 +02004545 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004546 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004547}
4548
Steven Cooreman177deba2020-09-07 17:14:14 +02004549/* Process input for which the algorithm is set to ECB mode. This requires
4550 * manual processing, since the PSA API is defined as being able to process
4551 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4552 * underlying mbedtls_cipher_update only takes full blocks. */
4553static psa_status_t psa_cipher_update_ecb_internal(
4554 mbedtls_cipher_context_t *ctx,
4555 const uint8_t *input,
4556 size_t input_length,
4557 uint8_t *output,
4558 size_t output_size,
4559 size_t *output_length )
4560{
4561 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4562 size_t block_size = ctx->cipher_info->block_size;
4563 size_t internal_output_length = 0;
4564 *output_length = 0;
4565
4566 if( input_length == 0 )
4567 {
4568 status = PSA_SUCCESS;
4569 goto exit;
4570 }
4571
4572 if( ctx->unprocessed_len > 0 )
4573 {
4574 /* Fill up to block size, and run the block if there's a full one. */
4575 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4576
4577 if( input_length < bytes_to_copy )
4578 bytes_to_copy = input_length;
4579
4580 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4581 input, bytes_to_copy );
4582 input_length -= bytes_to_copy;
4583 input += bytes_to_copy;
4584 ctx->unprocessed_len += bytes_to_copy;
4585
4586 if( ctx->unprocessed_len == block_size )
4587 {
4588 status = mbedtls_to_psa_error(
4589 mbedtls_cipher_update( ctx,
4590 ctx->unprocessed_data,
4591 block_size,
4592 output, &internal_output_length ) );
4593
4594 if( status != PSA_SUCCESS )
4595 goto exit;
4596
4597 output += internal_output_length;
4598 output_size -= internal_output_length;
4599 *output_length += internal_output_length;
4600 ctx->unprocessed_len = 0;
4601 }
4602 }
4603
4604 while( input_length >= block_size )
4605 {
4606 /* Run all full blocks we have, one by one */
4607 status = mbedtls_to_psa_error(
4608 mbedtls_cipher_update( ctx, input,
4609 block_size,
4610 output, &internal_output_length ) );
4611
4612 if( status != PSA_SUCCESS )
4613 goto exit;
4614
4615 input_length -= block_size;
4616 input += block_size;
4617
4618 output += internal_output_length;
4619 output_size -= internal_output_length;
4620 *output_length += internal_output_length;
4621 }
4622
4623 if( input_length > 0 )
4624 {
4625 /* Save unprocessed bytes for later processing */
4626 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4627 input, input_length );
4628 ctx->unprocessed_len += input_length;
4629 }
4630
4631 status = PSA_SUCCESS;
4632
4633exit:
4634 return( status );
4635}
4636
Gilles Peskinee553c652018-06-04 16:22:46 +02004637psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4638 const uint8_t *input,
4639 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004640 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004641 size_t output_size,
4642 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004643{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004644 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004645 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004646 if( operation->alg == 0 )
4647 {
4648 return( PSA_ERROR_BAD_STATE );
4649 }
4650 if( operation->iv_required && ! operation->iv_set )
4651 {
4652 return( PSA_ERROR_BAD_STATE );
4653 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004654
Steven Cooremanef8575e2020-09-11 11:44:50 +02004655 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004656 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004657 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004658 input,
4659 input_length,
4660 output,
4661 output_size,
4662 output_length );
4663 goto exit;
4664 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004665
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004666 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004667 {
4668 /* Take the unprocessed partial block left over from previous
4669 * update calls, if any, plus the input to this call. Remove
4670 * the last partial block, if any. You get the data that will be
4671 * output in this call. */
4672 expected_output_size =
4673 ( operation->ctx.cipher.unprocessed_len + input_length )
4674 / operation->block_size * operation->block_size;
4675 }
4676 else
4677 {
4678 expected_output_size = input_length;
4679 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004680
Gilles Peskine89d789c2018-06-04 17:17:16 +02004681 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004682 {
4683 status = PSA_ERROR_BUFFER_TOO_SMALL;
4684 goto exit;
4685 }
mohammad160382759612018-03-12 18:16:40 +02004686
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004687 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4688 {
4689 /* mbedtls_cipher_update has an API inconsistency: it will only
4690 * process a single block at a time in ECB mode. Abstract away that
4691 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004692 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4693 input,
4694 input_length,
4695 output,
4696 output_size,
4697 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004698 }
4699 else
4700 {
4701 status = mbedtls_to_psa_error(
4702 mbedtls_cipher_update( &operation->ctx.cipher, input,
4703 input_length, output, output_length ) );
4704 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004705exit:
4706 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004707 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004708 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004709}
4710
Gilles Peskinee553c652018-06-04 16:22:46 +02004711psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4712 uint8_t *output,
4713 size_t output_size,
4714 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004715{
David Saadab4ecc272019-02-14 13:48:10 +02004716 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004717 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004718 if( operation->alg == 0 )
4719 {
4720 return( PSA_ERROR_BAD_STATE );
4721 }
4722 if( operation->iv_required && ! operation->iv_set )
4723 {
4724 return( PSA_ERROR_BAD_STATE );
4725 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004726
Steven Cooremanef8575e2020-09-11 11:44:50 +02004727 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004728 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004729 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004730 output,
4731 output_size,
4732 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004733 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004734 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004735
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004736 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004737 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004738 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004739 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004740 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004741 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004742 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004743 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004744 }
4745
Steven Cooremanef8575e2020-09-11 11:44:50 +02004746 status = mbedtls_to_psa_error(
4747 mbedtls_cipher_finish( &operation->ctx.cipher,
4748 temp_output_buffer,
4749 output_length ) );
4750 if( status != PSA_SUCCESS )
4751 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004752
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004753 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004754 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004755 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004756 memcpy( output, temp_output_buffer, *output_length );
4757 else
Janos Follath315b51c2018-07-09 16:04:51 +01004758 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004759
Steven Cooremanef8575e2020-09-11 11:44:50 +02004760exit:
4761 if( operation->mbedtls_in_use == 1 )
4762 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004763
Steven Cooremanef8575e2020-09-11 11:44:50 +02004764 if( status == PSA_SUCCESS )
4765 return( psa_cipher_abort( operation ) );
4766 else
4767 {
4768 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004769 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004770
Steven Cooremanef8575e2020-09-11 11:44:50 +02004771 return( status );
4772 }
mohammad1603503973b2018-03-12 15:59:30 +02004773}
4774
Gilles Peskinee553c652018-06-04 16:22:46 +02004775psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4776{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004777 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004778 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004779 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004780 * in use. It's ok to call abort on such an object, and there's
4781 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004782 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004783 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004784
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004785 /* Sanity check (shouldn't happen: operation->alg should
4786 * always have been initialized to a valid value). */
4787 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4788 return( PSA_ERROR_BAD_STATE );
4789
Steven Cooremanef8575e2020-09-11 11:44:50 +02004790 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004791 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004792 else
4793 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004794
Moran Peker41deec42018-04-04 15:43:05 +03004795 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004796 operation->key_set = 0;
4797 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004798 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004799 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004800 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004801 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004802
Moran Peker395db872018-05-31 14:07:14 +03004803 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004804}
4805
Gilles Peskinea0655c32018-04-30 17:06:50 +02004806
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004807
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004808
mohammad16035955c982018-04-26 00:53:03 +03004809/****************************************************************/
4810/* AEAD */
4811/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004812
Gilles Peskineedf9a652018-08-17 18:11:56 +02004813typedef struct
4814{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004815 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004816 const mbedtls_cipher_info_t *cipher_info;
4817 union
4818 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004819 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004820#if defined(MBEDTLS_CCM_C)
4821 mbedtls_ccm_context ccm;
4822#endif /* MBEDTLS_CCM_C */
4823#if defined(MBEDTLS_GCM_C)
4824 mbedtls_gcm_context gcm;
4825#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004826#if defined(MBEDTLS_CHACHAPOLY_C)
4827 mbedtls_chachapoly_context chachapoly;
4828#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004829 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004830 psa_algorithm_t core_alg;
4831 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004832 uint8_t tag_length;
4833} aead_operation_t;
4834
Ronald Cronf95a2b12020-10-22 15:24:49 +02004835#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4836
Gilles Peskine30a9e412019-01-14 18:36:12 +01004837static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004838{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004839 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004840 {
4841#if defined(MBEDTLS_CCM_C)
4842 case PSA_ALG_CCM:
4843 mbedtls_ccm_free( &operation->ctx.ccm );
4844 break;
4845#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004846#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004847 case PSA_ALG_GCM:
4848 mbedtls_gcm_free( &operation->ctx.gcm );
4849 break;
4850#endif /* MBEDTLS_GCM_C */
4851 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004852
Ronald Cron5c522922020-11-14 16:35:34 +01004853 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004854}
4855
4856static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004857 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004858 psa_key_usage_t usage,
4859 psa_algorithm_t alg )
4860{
4861 psa_status_t status;
4862 size_t key_bits;
4863 mbedtls_cipher_id_t cipher_id;
4864
Ronald Cron5c522922020-11-14 16:35:34 +01004865 status = psa_get_and_lock_transparent_key_slot_with_policy(
4866 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004867 if( status != PSA_SUCCESS )
4868 return( status );
4869
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004870 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004871
4872 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004873 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004874 &cipher_id );
4875 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004876 {
4877 status = PSA_ERROR_NOT_SUPPORTED;
4878 goto cleanup;
4879 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004880
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004881 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004882 {
4883#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004884 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4885 operation->core_alg = PSA_ALG_CCM;
4886 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004887 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4888 * The call to mbedtls_ccm_encrypt_and_tag or
4889 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004890 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004891 {
4892 status = PSA_ERROR_INVALID_ARGUMENT;
4893 goto cleanup;
4894 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004895 mbedtls_ccm_init( &operation->ctx.ccm );
4896 status = mbedtls_to_psa_error(
4897 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004898 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004899 (unsigned int) key_bits ) );
4900 if( status != 0 )
4901 goto cleanup;
4902 break;
4903#endif /* MBEDTLS_CCM_C */
4904
4905#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004906 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4907 operation->core_alg = PSA_ALG_GCM;
4908 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004909 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4910 * The call to mbedtls_gcm_crypt_and_tag or
4911 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004912 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004913 {
4914 status = PSA_ERROR_INVALID_ARGUMENT;
4915 goto cleanup;
4916 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004917 mbedtls_gcm_init( &operation->ctx.gcm );
4918 status = mbedtls_to_psa_error(
4919 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004920 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004921 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004922 if( status != 0 )
4923 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004924 break;
4925#endif /* MBEDTLS_GCM_C */
4926
Gilles Peskine26869f22019-05-06 15:25:00 +02004927#if defined(MBEDTLS_CHACHAPOLY_C)
4928 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4929 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4930 operation->full_tag_length = 16;
4931 /* We only support the default tag length. */
4932 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004933 {
4934 status = PSA_ERROR_NOT_SUPPORTED;
4935 goto cleanup;
4936 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004937 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4938 status = mbedtls_to_psa_error(
4939 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004940 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004941 if( status != 0 )
4942 goto cleanup;
4943 break;
4944#endif /* MBEDTLS_CHACHAPOLY_C */
4945
Gilles Peskineedf9a652018-08-17 18:11:56 +02004946 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004947 status = PSA_ERROR_NOT_SUPPORTED;
4948 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004949 }
4950
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004951 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4952 {
4953 status = PSA_ERROR_INVALID_ARGUMENT;
4954 goto cleanup;
4955 }
4956 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004957
Gilles Peskineedf9a652018-08-17 18:11:56 +02004958 return( PSA_SUCCESS );
4959
4960cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004961 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004962 return( status );
4963}
4964
Ronald Croncf56a0a2020-08-04 09:51:30 +02004965psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004966 psa_algorithm_t alg,
4967 const uint8_t *nonce,
4968 size_t nonce_length,
4969 const uint8_t *additional_data,
4970 size_t additional_data_length,
4971 const uint8_t *plaintext,
4972 size_t plaintext_length,
4973 uint8_t *ciphertext,
4974 size_t ciphertext_size,
4975 size_t *ciphertext_length )
4976{
mohammad16035955c982018-04-26 00:53:03 +03004977 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004978 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004979 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004980
mohammad1603f08a5502018-06-03 15:05:47 +03004981 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004982
Ronald Croncf56a0a2020-08-04 09:51:30 +02004983 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004984 if( status != PSA_SUCCESS )
4985 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004986
Gilles Peskineedf9a652018-08-17 18:11:56 +02004987 /* For all currently supported modes, the tag is at the end of the
4988 * ciphertext. */
4989 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4990 {
4991 status = PSA_ERROR_BUFFER_TOO_SMALL;
4992 goto exit;
4993 }
4994 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004995
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004996#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004997 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004998 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004999 status = mbedtls_to_psa_error(
5000 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
5001 MBEDTLS_GCM_ENCRYPT,
5002 plaintext_length,
5003 nonce, nonce_length,
5004 additional_data, additional_data_length,
5005 plaintext, ciphertext,
5006 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03005007 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005008 else
5009#endif /* MBEDTLS_GCM_C */
5010#if defined(MBEDTLS_CCM_C)
5011 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005012 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005013 status = mbedtls_to_psa_error(
5014 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
5015 plaintext_length,
5016 nonce, nonce_length,
5017 additional_data,
5018 additional_data_length,
5019 plaintext, ciphertext,
5020 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005021 }
mohammad16035c8845f2018-05-09 05:40:09 -07005022 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005023#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005024#if defined(MBEDTLS_CHACHAPOLY_C)
5025 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5026 {
5027 if( nonce_length != 12 || operation.tag_length != 16 )
5028 {
5029 status = PSA_ERROR_NOT_SUPPORTED;
5030 goto exit;
5031 }
5032 status = mbedtls_to_psa_error(
5033 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
5034 plaintext_length,
5035 nonce,
5036 additional_data,
5037 additional_data_length,
5038 plaintext,
5039 ciphertext,
5040 tag ) );
5041 }
5042 else
5043#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07005044 {
mohammad1603554faad2018-06-03 15:07:38 +03005045 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07005046 }
Gilles Peskine2d277862018-06-18 15:41:12 +02005047
Gilles Peskineedf9a652018-08-17 18:11:56 +02005048 if( status != PSA_SUCCESS && ciphertext_size != 0 )
5049 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02005050
Gilles Peskineedf9a652018-08-17 18:11:56 +02005051exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005052 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005053 if( status == PSA_SUCCESS )
5054 *ciphertext_length = plaintext_length + operation.tag_length;
5055 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005056}
5057
Gilles Peskineee652a32018-06-01 19:23:52 +02005058/* Locate the tag in a ciphertext buffer containing the encrypted data
5059 * followed by the tag. Return the length of the part preceding the tag in
5060 * *plaintext_length. This is the size of the plaintext in modes where
5061 * the encrypted data has the same size as the plaintext, such as
5062 * CCM and GCM. */
5063static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
5064 const uint8_t *ciphertext,
5065 size_t ciphertext_length,
5066 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02005067 const uint8_t **p_tag )
5068{
5069 size_t payload_length;
5070 if( tag_length > ciphertext_length )
5071 return( PSA_ERROR_INVALID_ARGUMENT );
5072 payload_length = ciphertext_length - tag_length;
5073 if( payload_length > plaintext_size )
5074 return( PSA_ERROR_BUFFER_TOO_SMALL );
5075 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02005076 return( PSA_SUCCESS );
5077}
5078
Ronald Croncf56a0a2020-08-04 09:51:30 +02005079psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03005080 psa_algorithm_t alg,
5081 const uint8_t *nonce,
5082 size_t nonce_length,
5083 const uint8_t *additional_data,
5084 size_t additional_data_length,
5085 const uint8_t *ciphertext,
5086 size_t ciphertext_length,
5087 uint8_t *plaintext,
5088 size_t plaintext_size,
5089 size_t *plaintext_length )
5090{
mohammad16035955c982018-04-26 00:53:03 +03005091 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005092 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02005093 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02005094
Gilles Peskineee652a32018-06-01 19:23:52 +02005095 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005096
Ronald Croncf56a0a2020-08-04 09:51:30 +02005097 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005098 if( status != PSA_SUCCESS )
5099 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005100
Gilles Peskinef7e7b012019-05-06 15:27:16 +02005101 status = psa_aead_unpadded_locate_tag( operation.tag_length,
5102 ciphertext, ciphertext_length,
5103 plaintext_size, &tag );
5104 if( status != PSA_SUCCESS )
5105 goto exit;
5106
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005107#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005108 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005109 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005110 status = mbedtls_to_psa_error(
5111 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5112 ciphertext_length - operation.tag_length,
5113 nonce, nonce_length,
5114 additional_data,
5115 additional_data_length,
5116 tag, operation.tag_length,
5117 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005118 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005119 else
5120#endif /* MBEDTLS_GCM_C */
5121#if defined(MBEDTLS_CCM_C)
5122 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005123 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005124 status = mbedtls_to_psa_error(
5125 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5126 ciphertext_length - operation.tag_length,
5127 nonce, nonce_length,
5128 additional_data,
5129 additional_data_length,
5130 ciphertext, plaintext,
5131 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005132 }
mohammad160339574652018-06-01 04:39:53 -07005133 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005134#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005135#if defined(MBEDTLS_CHACHAPOLY_C)
5136 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5137 {
5138 if( nonce_length != 12 || operation.tag_length != 16 )
5139 {
5140 status = PSA_ERROR_NOT_SUPPORTED;
5141 goto exit;
5142 }
5143 status = mbedtls_to_psa_error(
5144 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5145 ciphertext_length - operation.tag_length,
5146 nonce,
5147 additional_data,
5148 additional_data_length,
5149 tag,
5150 ciphertext,
5151 plaintext ) );
5152 }
5153 else
5154#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005155 {
mohammad1603554faad2018-06-03 15:07:38 +03005156 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005157 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005158
Gilles Peskineedf9a652018-08-17 18:11:56 +02005159 if( status != PSA_SUCCESS && plaintext_size != 0 )
5160 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005161
Gilles Peskineedf9a652018-08-17 18:11:56 +02005162exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005163 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005164 if( status == PSA_SUCCESS )
5165 *plaintext_length = ciphertext_length - operation.tag_length;
5166 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005167}
5168
Gilles Peskinea0655c32018-04-30 17:06:50 +02005169
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005170
Gilles Peskine20035e32018-02-03 22:44:14 +01005171/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005172/* Generators */
5173/****************************************************************/
5174
John Durkop07cc04a2020-11-16 22:08:34 -08005175#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
5176 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5177 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5178#define AT_LEAST_ONE_BUILTIN_KDF
5179#endif
5180
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005181#define HKDF_STATE_INIT 0 /* no input yet */
5182#define HKDF_STATE_STARTED 1 /* got salt */
5183#define HKDF_STATE_KEYED 2 /* got key */
5184#define HKDF_STATE_OUTPUT 3 /* output started */
5185
Gilles Peskinecbe66502019-05-16 16:59:18 +02005186static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005187 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005188{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005189 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5190 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005191 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005192 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005193}
5194
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005195psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005196{
5197 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005198 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005199 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005200 {
5201 /* The object has (apparently) been initialized but it is not
5202 * in use. It's ok to call abort on such an object, and there's
5203 * nothing to do. */
5204 }
5205 else
John Durkopd0321952020-10-29 21:37:36 -07005206#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005207 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005208 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005209 mbedtls_free( operation->ctx.hkdf.info );
5210 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005211 }
John Durkop07cc04a2020-11-16 22:08:34 -08005212 else
5213#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5214#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5215 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5216 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005217 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005218 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005219 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005220 if( operation->ctx.tls12_prf.seed != NULL )
5221 {
5222 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5223 operation->ctx.tls12_prf.seed_length );
5224 mbedtls_free( operation->ctx.tls12_prf.seed );
5225 }
5226
5227 if( operation->ctx.tls12_prf.label != NULL )
5228 {
5229 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5230 operation->ctx.tls12_prf.label_length );
5231 mbedtls_free( operation->ctx.tls12_prf.label );
5232 }
5233
5234 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5235
5236 /* We leave the fields Ai and output_block to be erased safely by the
5237 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005238 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005239 else
John Durkop07cc04a2020-11-16 22:08:34 -08005240#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5241 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005242 {
5243 status = PSA_ERROR_BAD_STATE;
5244 }
Janos Follath083036a2019-06-11 10:22:26 +01005245 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005246 return( status );
5247}
5248
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005249psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005250 size_t *capacity)
5251{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005252 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005253 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005254 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005255 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005256 }
5257
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005258 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005259 return( PSA_SUCCESS );
5260}
5261
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005262psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005263 size_t capacity )
5264{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005265 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005266 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005267 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005268 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005269 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005270 return( PSA_SUCCESS );
5271}
5272
John Durkopd0321952020-10-29 21:37:36 -07005273#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005274/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005275 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005276static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005277 psa_algorithm_t hash_alg,
5278 uint8_t *output,
5279 size_t output_length )
5280{
5281 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5282 psa_status_t status;
5283
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005284 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5285 return( PSA_ERROR_BAD_STATE );
5286 hkdf->state = HKDF_STATE_OUTPUT;
5287
Gilles Peskinebef7f142018-07-12 17:22:21 +02005288 while( output_length != 0 )
5289 {
5290 /* Copy what remains of the current block */
5291 uint8_t n = hash_length - hkdf->offset_in_block;
5292 if( n > output_length )
5293 n = (uint8_t) output_length;
5294 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5295 output += n;
5296 output_length -= n;
5297 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005298 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005299 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005300 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005301 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005302 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005303 * object was corrupted or if this function is called directly
5304 * inside the library. */
5305 if( hkdf->block_number == 0xff )
5306 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005307
5308 /* We need a new block */
5309 ++hkdf->block_number;
5310 hkdf->offset_in_block = 0;
5311 status = psa_hmac_setup_internal( &hkdf->hmac,
5312 hkdf->prk, hash_length,
5313 hash_alg );
5314 if( status != PSA_SUCCESS )
5315 return( status );
5316 if( hkdf->block_number != 1 )
5317 {
5318 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5319 hkdf->output_block,
5320 hash_length );
5321 if( status != PSA_SUCCESS )
5322 return( status );
5323 }
5324 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5325 hkdf->info,
5326 hkdf->info_length );
5327 if( status != PSA_SUCCESS )
5328 return( status );
5329 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5330 &hkdf->block_number, 1 );
5331 if( status != PSA_SUCCESS )
5332 return( status );
5333 status = psa_hmac_finish_internal( &hkdf->hmac,
5334 hkdf->output_block,
5335 sizeof( hkdf->output_block ) );
5336 if( status != PSA_SUCCESS )
5337 return( status );
5338 }
5339
5340 return( PSA_SUCCESS );
5341}
John Durkop07cc04a2020-11-16 22:08:34 -08005342#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005343
John Durkop07cc04a2020-11-16 22:08:34 -08005344#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5345 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005346static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5347 psa_tls12_prf_key_derivation_t *tls12_prf,
5348 psa_algorithm_t alg )
5349{
5350 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5351 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005352 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5353 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005354
Janos Follath7742fee2019-06-17 12:58:10 +01005355 /* We can't be wanting more output after block 0xff, otherwise
5356 * the capacity check in psa_key_derivation_output_bytes() would have
5357 * prevented this call. It could happen only if the operation
5358 * object was corrupted or if this function is called directly
5359 * inside the library. */
5360 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005361 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005362
5363 /* We need a new block */
5364 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005365 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005366
5367 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5368 *
5369 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5370 *
5371 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5372 * HMAC_hash(secret, A(2) + seed) +
5373 * HMAC_hash(secret, A(3) + seed) + ...
5374 *
5375 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005376 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005377 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005378 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005379 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005380 * is currently extracted as `output_block` and where i is
5381 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005382 */
5383
Janos Follathea29bfb2019-06-19 12:21:20 +01005384 /* Save the hash context before using it, to preserve the hash state with
5385 * only the inner padding in it. We need this, because inner padding depends
5386 * on the key (secret in the RFC's terminology). */
5387 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5388 if( status != PSA_SUCCESS )
5389 goto cleanup;
5390
5391 /* Calculate A(i) where i = tls12_prf->block_number. */
5392 if( tls12_prf->block_number == 1 )
5393 {
5394 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5395 * the variable seed and in this instance means it in the context of the
5396 * P_hash function, where seed = label + seed.) */
5397 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5398 tls12_prf->label, tls12_prf->label_length );
5399 if( status != PSA_SUCCESS )
5400 goto cleanup;
5401 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5402 tls12_prf->seed, tls12_prf->seed_length );
5403 if( status != PSA_SUCCESS )
5404 goto cleanup;
5405 }
5406 else
5407 {
5408 /* A(i) = HMAC_hash(secret, A(i-1)) */
5409 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5410 tls12_prf->Ai, hash_length );
5411 if( status != PSA_SUCCESS )
5412 goto cleanup;
5413 }
5414
5415 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5416 tls12_prf->Ai, hash_length );
5417 if( status != PSA_SUCCESS )
5418 goto cleanup;
5419 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5420 if( status != PSA_SUCCESS )
5421 goto cleanup;
5422
5423 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5424 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5425 tls12_prf->Ai, hash_length );
5426 if( status != PSA_SUCCESS )
5427 goto cleanup;
5428 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5429 tls12_prf->label, tls12_prf->label_length );
5430 if( status != PSA_SUCCESS )
5431 goto cleanup;
5432 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5433 tls12_prf->seed, tls12_prf->seed_length );
5434 if( status != PSA_SUCCESS )
5435 goto cleanup;
5436 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5437 tls12_prf->output_block, hash_length );
5438 if( status != PSA_SUCCESS )
5439 goto cleanup;
5440 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5441 if( status != PSA_SUCCESS )
5442 goto cleanup;
5443
Janos Follath7742fee2019-06-17 12:58:10 +01005444
5445cleanup:
5446
Janos Follathea29bfb2019-06-19 12:21:20 +01005447 cleanup_status = psa_hash_abort( &backup );
5448 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5449 status = cleanup_status;
5450
5451 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005452}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005453
Janos Follath844eb0e2019-06-19 12:10:49 +01005454static psa_status_t psa_key_derivation_tls12_prf_read(
5455 psa_tls12_prf_key_derivation_t *tls12_prf,
5456 psa_algorithm_t alg,
5457 uint8_t *output,
5458 size_t output_length )
5459{
5460 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5461 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5462 psa_status_t status;
5463 uint8_t offset, length;
5464
5465 while( output_length != 0 )
5466 {
5467 /* Check if we have fully processed the current block. */
5468 if( tls12_prf->left_in_block == 0 )
5469 {
5470 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5471 alg );
5472 if( status != PSA_SUCCESS )
5473 return( status );
5474
5475 continue;
5476 }
5477
5478 if( tls12_prf->left_in_block > output_length )
5479 length = (uint8_t) output_length;
5480 else
5481 length = tls12_prf->left_in_block;
5482
5483 offset = hash_length - tls12_prf->left_in_block;
5484 memcpy( output, tls12_prf->output_block + offset, length );
5485 output += length;
5486 output_length -= length;
5487 tls12_prf->left_in_block -= length;
5488 }
5489
5490 return( PSA_SUCCESS );
5491}
John Durkop07cc04a2020-11-16 22:08:34 -08005492#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5493 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005494
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005495psa_status_t psa_key_derivation_output_bytes(
5496 psa_key_derivation_operation_t *operation,
5497 uint8_t *output,
5498 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005499{
5500 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005501 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005502
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005503 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005504 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005505 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005506 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005507 }
5508
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005509 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005510 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005511 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005512 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005513 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005514 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005515 goto exit;
5516 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005517 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005518 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005519 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005520 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005521 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5522 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005523 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005524 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005525 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005526 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005527 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005528
John Durkopd0321952020-10-29 21:37:36 -07005529#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005530 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005531 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005532 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005533 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005534 output, output_length );
5535 }
Janos Follathadbec812019-06-14 11:05:39 +01005536 else
John Durkop07cc04a2020-11-16 22:08:34 -08005537#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5538#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5539 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005540 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005541 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005542 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005543 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005544 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005545 output_length );
5546 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005547 else
John Durkop07cc04a2020-11-16 22:08:34 -08005548#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5549 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005550 {
5551 return( PSA_ERROR_BAD_STATE );
5552 }
5553
5554exit:
5555 if( status != PSA_SUCCESS )
5556 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005557 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005558 * This allows us to differentiate between exhausted operations and
5559 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5560 * operations. */
5561 psa_algorithm_t alg = operation->alg;
5562 psa_key_derivation_abort( operation );
5563 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005564 memset( output, '!', output_length );
5565 }
5566 return( status );
5567}
5568
Gilles Peskine08542d82018-07-19 17:05:42 +02005569#if defined(MBEDTLS_DES_C)
5570static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5571{
5572 if( data_size >= 8 )
5573 mbedtls_des_key_set_parity( data );
5574 if( data_size >= 16 )
5575 mbedtls_des_key_set_parity( data + 8 );
5576 if( data_size >= 24 )
5577 mbedtls_des_key_set_parity( data + 16 );
5578}
5579#endif /* MBEDTLS_DES_C */
5580
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005581static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005582 psa_key_slot_t *slot,
5583 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005584 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005585{
5586 uint8_t *data = NULL;
5587 size_t bytes = PSA_BITS_TO_BYTES( bits );
5588 psa_status_t status;
5589
Gilles Peskine8e338702019-07-30 20:06:31 +02005590 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005591 return( PSA_ERROR_INVALID_ARGUMENT );
5592 if( bits % 8 != 0 )
5593 return( PSA_ERROR_INVALID_ARGUMENT );
5594 data = mbedtls_calloc( 1, bytes );
5595 if( data == NULL )
5596 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5597
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005598 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005599 if( status != PSA_SUCCESS )
5600 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005601#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005602 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005603 psa_des_set_key_parity( data, bytes );
5604#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005605 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005606
5607exit:
5608 mbedtls_free( data );
5609 return( status );
5610}
5611
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005612psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005613 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005614 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005615{
5616 psa_status_t status;
5617 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005618 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005619
Ronald Cron81709fc2020-11-14 12:10:32 +01005620 *key = MBEDTLS_SVC_KEY_ID_INIT;
5621
Gilles Peskine0f84d622019-09-12 19:03:13 +02005622 /* Reject any attempt to create a zero-length key so that we don't
5623 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5624 if( psa_get_key_bits( attributes ) == 0 )
5625 return( PSA_ERROR_INVALID_ARGUMENT );
5626
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005627 if( ! operation->can_output_key )
5628 return( PSA_ERROR_NOT_PERMITTED );
5629
Ronald Cron81709fc2020-11-14 12:10:32 +01005630 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5631 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005632#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5633 if( driver != NULL )
5634 {
5635 /* Deriving a key in a secure element is not implemented yet. */
5636 status = PSA_ERROR_NOT_SUPPORTED;
5637 }
5638#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005639 if( status == PSA_SUCCESS )
5640 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005641 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005642 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005643 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005644 }
5645 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005646 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005647 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005648 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005649
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005650 return( status );
5651}
5652
Gilles Peskineeab56e42018-07-12 17:12:33 +02005653
5654
5655/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005656/* Key derivation */
5657/****************************************************************/
5658
John Durkop07cc04a2020-11-16 22:08:34 -08005659#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005660static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005661 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005662 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005663{
John Durkop07cc04a2020-11-16 22:08:34 -08005664 int is_kdf_alg_supported;
5665
Janos Follath5fe19732019-06-20 15:09:30 +01005666 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5667 * initialisers for this union leave some bytes unspecified.) */
5668 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5669
Gilles Peskine969c5d62019-01-16 15:53:06 +01005670 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005671#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005672 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5673 is_kdf_alg_supported = 1;
5674 else
5675#endif
5676#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5677 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5678 is_kdf_alg_supported = 1;
5679 else
5680#endif
5681#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5682 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5683 is_kdf_alg_supported = 1;
5684 else
5685#endif
5686 is_kdf_alg_supported = 0;
5687
5688 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005689 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005690 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005691 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5692 if( hash_size == 0 )
5693 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005694 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5695 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005696 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005697 {
5698 return( PSA_ERROR_NOT_SUPPORTED );
5699 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005700 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005701 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005702 }
John Durkop07cc04a2020-11-16 22:08:34 -08005703
5704 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005705}
John Durkop07cc04a2020-11-16 22:08:34 -08005706#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005707
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005708psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005709 psa_algorithm_t alg )
5710{
5711 psa_status_t status;
5712
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005713 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005714 return( PSA_ERROR_BAD_STATE );
5715
Gilles Peskine6843c292019-01-18 16:44:49 +01005716 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5717 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005718#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005719 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005720 {
5721 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005722 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005723 }
5724 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5725 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005726 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005727 }
John Durkop07cc04a2020-11-16 22:08:34 -08005728#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005729 else
5730 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005731
5732 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005733 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005734 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005735}
5736
John Durkopd0321952020-10-29 21:37:36 -07005737#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005738static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005739 psa_algorithm_t hash_alg,
5740 psa_key_derivation_step_t step,
5741 const uint8_t *data,
5742 size_t data_length )
5743{
5744 psa_status_t status;
5745 switch( step )
5746 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005747 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005748 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005749 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005750 status = psa_hmac_setup_internal( &hkdf->hmac,
5751 data, data_length,
5752 hash_alg );
5753 if( status != PSA_SUCCESS )
5754 return( status );
5755 hkdf->state = HKDF_STATE_STARTED;
5756 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005757 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005758 /* If no salt was provided, use an empty salt. */
5759 if( hkdf->state == HKDF_STATE_INIT )
5760 {
5761 status = psa_hmac_setup_internal( &hkdf->hmac,
5762 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005763 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005764 if( status != PSA_SUCCESS )
5765 return( status );
5766 hkdf->state = HKDF_STATE_STARTED;
5767 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005768 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005769 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005770 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5771 data, data_length );
5772 if( status != PSA_SUCCESS )
5773 return( status );
5774 status = psa_hmac_finish_internal( &hkdf->hmac,
5775 hkdf->prk,
5776 sizeof( hkdf->prk ) );
5777 if( status != PSA_SUCCESS )
5778 return( status );
5779 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5780 hkdf->block_number = 0;
5781 hkdf->state = HKDF_STATE_KEYED;
5782 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005783 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005784 if( hkdf->state == HKDF_STATE_OUTPUT )
5785 return( PSA_ERROR_BAD_STATE );
5786 if( hkdf->info_set )
5787 return( PSA_ERROR_BAD_STATE );
5788 hkdf->info_length = data_length;
5789 if( data_length != 0 )
5790 {
5791 hkdf->info = mbedtls_calloc( 1, data_length );
5792 if( hkdf->info == NULL )
5793 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5794 memcpy( hkdf->info, data, data_length );
5795 }
5796 hkdf->info_set = 1;
5797 return( PSA_SUCCESS );
5798 default:
5799 return( PSA_ERROR_INVALID_ARGUMENT );
5800 }
5801}
John Durkop07cc04a2020-11-16 22:08:34 -08005802#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005803
John Durkop07cc04a2020-11-16 22:08:34 -08005804#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5805 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005806static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5807 const uint8_t *data,
5808 size_t data_length )
5809{
5810 if( prf->state != TLS12_PRF_STATE_INIT )
5811 return( PSA_ERROR_BAD_STATE );
5812
Janos Follathd6dce9f2019-07-04 09:11:38 +01005813 if( data_length != 0 )
5814 {
5815 prf->seed = mbedtls_calloc( 1, data_length );
5816 if( prf->seed == NULL )
5817 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005818
Janos Follathd6dce9f2019-07-04 09:11:38 +01005819 memcpy( prf->seed, data, data_length );
5820 prf->seed_length = data_length;
5821 }
Janos Follathf08e2652019-06-13 09:05:41 +01005822
5823 prf->state = TLS12_PRF_STATE_SEED_SET;
5824
5825 return( PSA_SUCCESS );
5826}
5827
Janos Follath81550542019-06-13 14:26:34 +01005828static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5829 psa_algorithm_t hash_alg,
5830 const uint8_t *data,
5831 size_t data_length )
5832{
5833 psa_status_t status;
5834 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5835 return( PSA_ERROR_BAD_STATE );
5836
5837 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5838 if( status != PSA_SUCCESS )
5839 return( status );
5840
5841 prf->state = TLS12_PRF_STATE_KEY_SET;
5842
5843 return( PSA_SUCCESS );
5844}
5845
Janos Follath63028dd2019-06-13 09:15:47 +01005846static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5847 const uint8_t *data,
5848 size_t data_length )
5849{
5850 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5851 return( PSA_ERROR_BAD_STATE );
5852
Janos Follathd6dce9f2019-07-04 09:11:38 +01005853 if( data_length != 0 )
5854 {
5855 prf->label = mbedtls_calloc( 1, data_length );
5856 if( prf->label == NULL )
5857 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005858
Janos Follathd6dce9f2019-07-04 09:11:38 +01005859 memcpy( prf->label, data, data_length );
5860 prf->label_length = data_length;
5861 }
Janos Follath63028dd2019-06-13 09:15:47 +01005862
5863 prf->state = TLS12_PRF_STATE_LABEL_SET;
5864
5865 return( PSA_SUCCESS );
5866}
5867
Janos Follathb03233e2019-06-11 15:30:30 +01005868static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5869 psa_algorithm_t hash_alg,
5870 psa_key_derivation_step_t step,
5871 const uint8_t *data,
5872 size_t data_length )
5873{
Janos Follathb03233e2019-06-11 15:30:30 +01005874 switch( step )
5875 {
Janos Follathf08e2652019-06-13 09:05:41 +01005876 case PSA_KEY_DERIVATION_INPUT_SEED:
5877 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005878 case PSA_KEY_DERIVATION_INPUT_SECRET:
5879 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005880 case PSA_KEY_DERIVATION_INPUT_LABEL:
5881 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005882 default:
5883 return( PSA_ERROR_INVALID_ARGUMENT );
5884 }
5885}
John Durkop07cc04a2020-11-16 22:08:34 -08005886#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5887 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5888
5889#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5890static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5891 psa_tls12_prf_key_derivation_t *prf,
5892 psa_algorithm_t hash_alg,
5893 const uint8_t *data,
5894 size_t data_length )
5895{
5896 psa_status_t status;
5897 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5898 uint8_t *cur = pms;
5899
5900 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5901 return( PSA_ERROR_INVALID_ARGUMENT );
5902
5903 /* Quoting RFC 4279, Section 2:
5904 *
5905 * The premaster secret is formed as follows: if the PSK is N octets
5906 * long, concatenate a uint16 with the value N, N zero octets, a second
5907 * uint16 with the value N, and the PSK itself.
5908 */
5909
5910 *cur++ = ( data_length >> 8 ) & 0xff;
5911 *cur++ = ( data_length >> 0 ) & 0xff;
5912 memset( cur, 0, data_length );
5913 cur += data_length;
5914 *cur++ = pms[0];
5915 *cur++ = pms[1];
5916 memcpy( cur, data, data_length );
5917 cur += data_length;
5918
5919 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5920
5921 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5922 return( status );
5923}
Janos Follath6660f0e2019-06-17 08:44:03 +01005924
5925static psa_status_t psa_tls12_prf_psk_to_ms_input(
5926 psa_tls12_prf_key_derivation_t *prf,
5927 psa_algorithm_t hash_alg,
5928 psa_key_derivation_step_t step,
5929 const uint8_t *data,
5930 size_t data_length )
5931{
5932 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005933 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005934 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5935 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005936 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005937
5938 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5939}
John Durkop07cc04a2020-11-16 22:08:34 -08005940#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005941
Gilles Peskineb8965192019-09-24 16:21:10 +02005942/** Check whether the given key type is acceptable for the given
5943 * input step of a key derivation.
5944 *
5945 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5946 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5947 * Both secret and non-secret inputs can alternatively have the type
5948 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5949 * that the input was passed as a buffer rather than via a key object.
5950 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005951static int psa_key_derivation_check_input_type(
5952 psa_key_derivation_step_t step,
5953 psa_key_type_t key_type )
5954{
5955 switch( step )
5956 {
5957 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005958 if( key_type == PSA_KEY_TYPE_DERIVE )
5959 return( PSA_SUCCESS );
5960 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005961 return( PSA_SUCCESS );
5962 break;
5963 case PSA_KEY_DERIVATION_INPUT_LABEL:
5964 case PSA_KEY_DERIVATION_INPUT_SALT:
5965 case PSA_KEY_DERIVATION_INPUT_INFO:
5966 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005967 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5968 return( PSA_SUCCESS );
5969 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005970 return( PSA_SUCCESS );
5971 break;
5972 }
5973 return( PSA_ERROR_INVALID_ARGUMENT );
5974}
5975
Janos Follathb80a94e2019-06-12 15:54:46 +01005976static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005977 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005978 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005979 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005980 const uint8_t *data,
5981 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005982{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005983 psa_status_t status;
5984 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5985
5986 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005987 if( status != PSA_SUCCESS )
5988 goto exit;
5989
John Durkopd0321952020-10-29 21:37:36 -07005990#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005991 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005992 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005993 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005994 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005995 step, data, data_length );
5996 }
John Durkop07cc04a2020-11-16 22:08:34 -08005997 else
5998#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5999#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
6000 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006001 {
Janos Follathb03233e2019-06-11 15:30:30 +01006002 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
6003 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
6004 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01006005 }
John Durkop07cc04a2020-11-16 22:08:34 -08006006 else
6007#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6008#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6009 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01006010 {
6011 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
6012 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
6013 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006014 }
6015 else
John Durkop07cc04a2020-11-16 22:08:34 -08006016#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006017 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006018 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006019 return( PSA_ERROR_BAD_STATE );
6020 }
6021
Gilles Peskine224b0d62019-09-23 18:13:17 +02006022exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006023 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006024 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006025 return( status );
6026}
6027
Janos Follath51f4a0f2019-06-14 11:35:55 +01006028psa_status_t psa_key_derivation_input_bytes(
6029 psa_key_derivation_operation_t *operation,
6030 psa_key_derivation_step_t step,
6031 const uint8_t *data,
6032 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006033{
Gilles Peskineb8965192019-09-24 16:21:10 +02006034 return( psa_key_derivation_input_internal( operation, step,
6035 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01006036 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006037}
6038
Janos Follath51f4a0f2019-06-14 11:35:55 +01006039psa_status_t psa_key_derivation_input_key(
6040 psa_key_derivation_operation_t *operation,
6041 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006042 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006043{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006044 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006045 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006046 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006047
Ronald Cron5c522922020-11-14 16:35:34 +01006048 status = psa_get_and_lock_transparent_key_slot_with_policy(
6049 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006050 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02006051 {
6052 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006053 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02006054 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006055
6056 /* Passing a key object as a SECRET input unlocks the permission
6057 * to output to a key object. */
6058 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6059 operation->can_output_key = 1;
6060
Ronald Cronf95a2b12020-10-22 15:24:49 +02006061 status = psa_key_derivation_input_internal( operation,
6062 step, slot->attr.type,
6063 slot->data.key.data,
6064 slot->data.key.bytes );
6065
Ronald Cron5c522922020-11-14 16:35:34 +01006066 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006067
Ronald Cron5c522922020-11-14 16:35:34 +01006068 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006069}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006070
6071
6072
6073/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006074/* Key agreement */
6075/****************************************************************/
6076
John Durkop6ba40d12020-11-10 08:50:04 -08006077#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006078static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
6079 size_t peer_key_length,
6080 const mbedtls_ecp_keypair *our_key,
6081 uint8_t *shared_secret,
6082 size_t shared_secret_size,
6083 size_t *shared_secret_length )
6084{
Steven Cooremand4867872020-08-05 16:31:39 +02006085 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006086 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00006087 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006088 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01006089 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006090 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006091
Steven Cooreman4fed4552020-08-03 14:46:03 +02006092 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
6093 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02006094 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02006095 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00006096 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006097 goto exit;
6098
Jaeden Amero97271b32019-01-10 19:38:51 +00006099 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02006100 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00006101 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006102 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00006103 status = mbedtls_to_psa_error(
6104 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
6105 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006106 goto exit;
6107
Jaeden Amero97271b32019-01-10 19:38:51 +00006108 status = mbedtls_to_psa_error(
6109 mbedtls_ecdh_calc_secret( &ecdh,
6110 shared_secret_length,
6111 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006112 mbedtls_psa_get_random,
6113 mbedtls_psa_random_state( &global_data.rng ) ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006114 if( status != PSA_SUCCESS )
6115 goto exit;
6116 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
6117 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006118
6119exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01006120 if( status != PSA_SUCCESS )
6121 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006122 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02006123 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02006124 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02006125
Jaeden Amero97271b32019-01-10 19:38:51 +00006126 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006127}
John Durkop6ba40d12020-11-10 08:50:04 -08006128#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006129
Gilles Peskine01d718c2018-09-18 12:01:02 +02006130#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6131
Gilles Peskine0216fe12019-04-11 21:23:21 +02006132static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6133 psa_key_slot_t *private_key,
6134 const uint8_t *peer_key,
6135 size_t peer_key_length,
6136 uint8_t *shared_secret,
6137 size_t shared_secret_size,
6138 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006139{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006140 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006141 {
John Durkop6ba40d12020-11-10 08:50:04 -08006142#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006143 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006144 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006145 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006146 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02006147 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02006148 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02006149 private_key->data.key.data,
6150 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02006151 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006152 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006153 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006154 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006155 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006156 shared_secret, shared_secret_size,
6157 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006158 mbedtls_ecp_keypair_free( ecp );
6159 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006160 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08006161#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006162 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006163 (void) private_key;
6164 (void) peer_key;
6165 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006166 (void) shared_secret;
6167 (void) shared_secret_size;
6168 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006169 return( PSA_ERROR_NOT_SUPPORTED );
6170 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006171}
6172
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006173/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006174 * to potentially free embedded data structures and wipe confidential data.
6175 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006176static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006177 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006178 psa_key_slot_t *private_key,
6179 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006180 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006181{
6182 psa_status_t status;
6183 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6184 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006185 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006186
6187 /* Step 1: run the secret agreement algorithm to generate the shared
6188 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006189 status = psa_key_agreement_raw_internal( ka_alg,
6190 private_key,
6191 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006192 shared_secret,
6193 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006194 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006195 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006196 goto exit;
6197
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006198 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006199 * the shared secret. A shared secret is permitted wherever a key
6200 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006201 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006202 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006203 shared_secret,
6204 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006205exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006206 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006207 return( status );
6208}
6209
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006210psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006211 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006212 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006213 const uint8_t *peer_key,
6214 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006215{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006216 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006217 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006218 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006219
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006220 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006221 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01006222 status = psa_get_and_lock_transparent_key_slot_with_policy(
6223 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006224 if( status != PSA_SUCCESS )
6225 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006226 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006227 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006228 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006229 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006230 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006231 else
6232 {
6233 /* If a private key has been added as SECRET, we allow the derived
6234 * key material to be used as a key in PSA Crypto. */
6235 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6236 operation->can_output_key = 1;
6237 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006238
Ronald Cron5c522922020-11-14 16:35:34 +01006239 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006240
Ronald Cron5c522922020-11-14 16:35:34 +01006241 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006242}
6243
Gilles Peskinebe697d82019-05-16 18:00:41 +02006244psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006245 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006246 const uint8_t *peer_key,
6247 size_t peer_key_length,
6248 uint8_t *output,
6249 size_t output_size,
6250 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006251{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006252 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006253 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006254 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006255
6256 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6257 {
6258 status = PSA_ERROR_INVALID_ARGUMENT;
6259 goto exit;
6260 }
Ronald Cron5c522922020-11-14 16:35:34 +01006261 status = psa_get_and_lock_transparent_key_slot_with_policy(
6262 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006263 if( status != PSA_SUCCESS )
6264 goto exit;
6265
6266 status = psa_key_agreement_raw_internal( alg, slot,
6267 peer_key, peer_key_length,
6268 output, output_size,
6269 output_length );
6270
6271exit:
6272 if( status != PSA_SUCCESS )
6273 {
6274 /* If an error happens and is not handled properly, the output
6275 * may be used as a key to protect sensitive data. Arrange for such
6276 * a key to be random, which is likely to result in decryption or
6277 * verification errors. This is better than filling the buffer with
6278 * some constant data such as zeros, which would result in the data
6279 * being protected with a reproducible, easily knowable key.
6280 */
6281 psa_generate_random( output, output_size );
6282 *output_length = output_size;
6283 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006284
Ronald Cron5c522922020-11-14 16:35:34 +01006285 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006286
Ronald Cron5c522922020-11-14 16:35:34 +01006287 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006288}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006289
6290
Gilles Peskine30524eb2020-11-13 17:02:26 +01006291
Gilles Peskine86a440b2018-11-12 18:39:40 +01006292/****************************************************************/
6293/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006294/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006295
Gilles Peskine30524eb2020-11-13 17:02:26 +01006296/** Initialize the PSA random generator.
6297 */
6298static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
6299{
6300 /* Set default configuration if
6301 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6302 if( rng->entropy_init == NULL )
6303 rng->entropy_init = mbedtls_entropy_init;
6304 if( rng->entropy_free == NULL )
6305 rng->entropy_free = mbedtls_entropy_free;
6306
6307 rng->entropy_init( &rng->entropy );
6308#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6309 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6310 /* The PSA entropy injection feature depends on using NV seed as an entropy
6311 * source. Add NV seed as an entropy source for PSA entropy injection. */
6312 mbedtls_entropy_add_source( &rng->entropy,
6313 mbedtls_nv_seed_poll, NULL,
6314 MBEDTLS_ENTROPY_BLOCK_SIZE,
6315 MBEDTLS_ENTROPY_SOURCE_STRONG );
6316#endif
6317
6318 mbedtls_psa_drbg_init( mbedtls_psa_random_state( rng ) );
6319}
6320
6321/** Deinitialize the PSA random generator.
6322 */
6323static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
6324{
6325 mbedtls_psa_drbg_free( mbedtls_psa_random_state( rng ) );
6326 rng->entropy_free( &rng->entropy );
6327}
6328
6329/** Seed the PSA random generator.
6330 */
6331static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
6332{
6333 const unsigned char drbg_seed[] = "PSA";
6334 int ret = mbedtls_psa_drbg_seed( rng, drbg_seed, sizeof( drbg_seed ) - 1 );
6335 return mbedtls_to_psa_error( ret );
6336}
6337
Gilles Peskinee59236f2018-01-27 23:32:46 +01006338psa_status_t psa_generate_random( uint8_t *output,
6339 size_t output_size )
6340{
Janos Follath24eed8d2019-11-22 13:21:35 +00006341 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006342 GUARD_MODULE_INITIALIZED;
6343
Gilles Peskine30524eb2020-11-13 17:02:26 +01006344 while( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006345 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006346 ret = mbedtls_psa_get_random(
6347 mbedtls_psa_random_state( &global_data.rng ),
6348 output, MBEDTLS_PSA_RANDOM_MAX_REQUEST );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006349 if( ret != 0 )
6350 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006351 output += MBEDTLS_PSA_RANDOM_MAX_REQUEST;
6352 output_size -= MBEDTLS_PSA_RANDOM_MAX_REQUEST;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006353 }
6354
Gilles Peskine30524eb2020-11-13 17:02:26 +01006355 ret = mbedtls_psa_get_random( mbedtls_psa_random_state( &global_data.rng ),
6356 output, output_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006357 return( mbedtls_to_psa_error( ret ) );
6358}
6359
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006360#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6361#include "mbedtls/entropy_poll.h"
6362
Gilles Peskine7228da22019-07-15 11:06:15 +02006363psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006364 size_t seed_size )
6365{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006366 if( global_data.initialized )
6367 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006368
6369 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6370 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6371 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6372 return( PSA_ERROR_INVALID_ARGUMENT );
6373
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006374 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006375}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006376#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006377
John Durkop07cc04a2020-11-16 22:08:34 -08006378#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006379static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6380 size_t domain_parameters_size,
6381 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006382{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006383 size_t i;
6384 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006385
Gilles Peskinee56e8782019-04-26 17:34:02 +02006386 if( domain_parameters_size == 0 )
6387 {
6388 *exponent = 65537;
6389 return( PSA_SUCCESS );
6390 }
6391
6392 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6393 * support values that fit in a 32-bit integer, which is larger than
6394 * int on just about every platform anyway. */
6395 if( domain_parameters_size > sizeof( acc ) )
6396 return( PSA_ERROR_NOT_SUPPORTED );
6397 for( i = 0; i < domain_parameters_size; i++ )
6398 acc = ( acc << 8 ) | domain_parameters[i];
6399 if( acc > INT_MAX )
6400 return( PSA_ERROR_NOT_SUPPORTED );
6401 *exponent = acc;
6402 return( PSA_SUCCESS );
6403}
John Durkop07cc04a2020-11-16 22:08:34 -08006404#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006405
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006406static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006407 psa_key_slot_t *slot, size_t bits,
6408 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006409{
Gilles Peskine8e338702019-07-30 20:06:31 +02006410 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006411
Gilles Peskinee56e8782019-04-26 17:34:02 +02006412 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006413 return( PSA_ERROR_INVALID_ARGUMENT );
6414
Gilles Peskinee59236f2018-01-27 23:32:46 +01006415 if( key_type_is_raw_bytes( type ) )
6416 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006417 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006418
6419 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006420 if( status != PSA_SUCCESS )
6421 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006422
6423 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006424 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6425 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006426 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006427
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006428 status = psa_generate_random( slot->data.key.data,
6429 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006430 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006431 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006432
6433 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006434#if defined(MBEDTLS_DES_C)
6435 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006436 psa_des_set_key_parity( slot->data.key.data,
6437 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006438#endif /* MBEDTLS_DES_C */
6439 }
6440 else
6441
John Durkop07cc04a2020-11-16 22:08:34 -08006442#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006443 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006444 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006445 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006447 int exponent;
6448 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006449 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6450 return( PSA_ERROR_NOT_SUPPORTED );
6451 /* Accept only byte-aligned keys, for the same reasons as
6452 * in psa_import_rsa_key(). */
6453 if( bits % 8 != 0 )
6454 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006455 status = psa_read_rsa_exponent( domain_parameters,
6456 domain_parameters_size,
6457 &exponent );
6458 if( status != PSA_SUCCESS )
6459 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006460 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6461 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006462 mbedtls_psa_get_random,
6463 mbedtls_psa_random_state( &global_data.rng ),
Gilles Peskinee59236f2018-01-27 23:32:46 +01006464 (unsigned int) bits,
6465 exponent );
6466 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006467 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006468
6469 /* Make sure to always have an export representation available */
6470 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6471
Steven Cooreman75b74362020-07-28 14:30:13 +02006472 status = psa_allocate_buffer_to_slot( slot, bytes );
6473 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006474 {
6475 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006476 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006477 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006478
6479 status = psa_export_rsa_key( type,
6480 &rsa,
6481 slot->data.key.data,
6482 bytes,
6483 &slot->data.key.bytes );
6484 mbedtls_rsa_free( &rsa );
6485 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006486 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006487 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006488 }
6489 else
John Durkop07cc04a2020-11-16 22:08:34 -08006490#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006491
John Durkop9814fa22020-11-04 12:28:15 -08006492#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006493 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006494 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006495 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006496 mbedtls_ecp_group_id grp_id =
6497 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006498 const mbedtls_ecp_curve_info *curve_info =
6499 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006500 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006501 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006502 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006503 return( PSA_ERROR_NOT_SUPPORTED );
6504 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6505 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006506 mbedtls_ecp_keypair_init( &ecp );
6507 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006508 mbedtls_psa_get_random,
6509 mbedtls_psa_random_state( &global_data.rng ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006510 if( ret != 0 )
6511 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006512 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006513 return( mbedtls_to_psa_error( ret ) );
6514 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006515
6516
6517 /* Make sure to always have an export representation available */
6518 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006519 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6520 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006521 {
6522 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006523 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006524 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006525
6526 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006527 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6528
6529 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006530 if( status != PSA_SUCCESS ) {
6531 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006532 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006533 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006534 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006535 }
6536 else
John Durkop9814fa22020-11-04 12:28:15 -08006537#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006538 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006539 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006540 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006541
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006542 return( PSA_SUCCESS );
6543}
Darryl Green0c6575a2018-11-07 16:05:30 +00006544
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006545psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006546 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006547{
6548 psa_status_t status;
6549 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006550 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006551
Ronald Cron81709fc2020-11-14 12:10:32 +01006552 *key = MBEDTLS_SVC_KEY_ID_INIT;
6553
Gilles Peskine0f84d622019-09-12 19:03:13 +02006554 /* Reject any attempt to create a zero-length key so that we don't
6555 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6556 if( psa_get_key_bits( attributes ) == 0 )
6557 return( PSA_ERROR_INVALID_ARGUMENT );
6558
Ronald Cron81709fc2020-11-14 12:10:32 +01006559 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6560 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006561 if( status != PSA_SUCCESS )
6562 goto exit;
6563
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006564 status = psa_driver_wrapper_generate_key( attributes,
6565 slot );
6566 if( status != PSA_ERROR_NOT_SUPPORTED ||
6567 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6568 goto exit;
6569
6570 status = psa_generate_key_internal(
6571 slot, attributes->core.bits,
6572 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006573
6574exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006575 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006576 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006577 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006578 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006579
Darryl Green0c6575a2018-11-07 16:05:30 +00006580 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006581}
6582
6583
Gilles Peskinee59236f2018-01-27 23:32:46 +01006584
6585/****************************************************************/
6586/* Module setup */
6587/****************************************************************/
6588
Gilles Peskine5e769522018-11-20 21:59:56 +01006589psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6590 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6591 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6592{
6593 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6594 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006595 global_data.rng.entropy_init = entropy_init;
6596 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006597 return( PSA_SUCCESS );
6598}
6599
Gilles Peskinee59236f2018-01-27 23:32:46 +01006600void mbedtls_psa_crypto_free( void )
6601{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006602 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006603 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6604 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006605 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006606 }
6607 /* Wipe all remaining data, including configuration.
6608 * In particular, this sets all state indicator to the value
6609 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006610 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006611#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006612 /* Unregister all secure element drivers, so that we restart from
6613 * a pristine state. */
6614 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006615#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006616}
6617
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006618#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6619/** Recover a transaction that was interrupted by a power failure.
6620 *
6621 * This function is called during initialization, before psa_crypto_init()
6622 * returns. If this function returns a failure status, the initialization
6623 * fails.
6624 */
6625static psa_status_t psa_crypto_recover_transaction(
6626 const psa_crypto_transaction_t *transaction )
6627{
6628 switch( transaction->unknown.type )
6629 {
6630 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6631 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006632 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006633 * is implemented.
6634 * https://github.com/ARMmbed/mbed-crypto/issues/218
6635 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006636 default:
6637 /* We found an unsupported transaction in the storage.
6638 * We don't know what state the storage is in. Give up. */
6639 return( PSA_ERROR_STORAGE_FAILURE );
6640 }
6641}
6642#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6643
Gilles Peskinee59236f2018-01-27 23:32:46 +01006644psa_status_t psa_crypto_init( void )
6645{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006646 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006647
Gilles Peskinec6b69072018-11-20 21:42:52 +01006648 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006649 if( global_data.initialized != 0 )
6650 return( PSA_SUCCESS );
6651
Gilles Peskine30524eb2020-11-13 17:02:26 +01006652 /* Initialize and seed the random generator. */
6653 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006654 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006655 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006656 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006657 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006658 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006659
Gilles Peskine66fb1262018-12-10 16:29:04 +01006660 status = psa_initialize_key_slots( );
6661 if( status != PSA_SUCCESS )
6662 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006663
Gilles Peskined9348f22019-10-01 15:22:29 +02006664#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6665 status = psa_init_all_se_drivers( );
6666 if( status != PSA_SUCCESS )
6667 goto exit;
6668#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6669
Gilles Peskine4b734222019-07-24 15:56:31 +02006670#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006671 status = psa_crypto_load_transaction( );
6672 if( status == PSA_SUCCESS )
6673 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006674 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6675 if( status != PSA_SUCCESS )
6676 goto exit;
6677 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006678 }
6679 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6680 {
6681 /* There's no transaction to complete. It's all good. */
6682 status = PSA_SUCCESS;
6683 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006684#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006685
Gilles Peskinec6b69072018-11-20 21:42:52 +01006686 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006687 global_data.initialized = 1;
6688
6689exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006690 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006691 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006692 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006693}
6694
6695#endif /* MBEDTLS_PSA_CRYPTO_C */