blob: 7258f72844656e3465a89f4b12f0d13171e03124 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020036#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010038#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010039/* Include internal declarations that are useful for implementing persistently
40 * stored keys. */
41#include "psa_crypto_storage.h"
42
Gilles Peskineb46bef22019-07-30 21:32:04 +020043#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include <stdlib.h>
45#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010046#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020047#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#define mbedtls_calloc calloc
49#define mbedtls_free free
50#endif
51
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020053#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000054#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020055#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/blowfish.h"
57#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020058#include "mbedtls/chacha20.h"
59#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/cipher.h"
61#include "mbedtls/ccm.h"
62#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020065#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010067#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/error.h"
69#include "mbedtls/gcm.h"
70#include "mbedtls/md2.h"
71#include "mbedtls/md4.h"
72#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010073#include "mbedtls/md.h"
74#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010075#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010077#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000078#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010079#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010080#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010081#include "mbedtls/sha1.h"
82#include "mbedtls/sha256.h"
83#include "mbedtls/sha512.h"
84#include "mbedtls/xtea.h"
85
Gilles Peskine996deb12018-08-01 15:45:45 +020086#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
87
Gilles Peskine9ef733f2018-02-07 21:05:37 +010088/* constant-time buffer comparison */
89static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
90{
91 size_t i;
92 unsigned char diff = 0;
93
94 for( i = 0; i < n; i++ )
95 diff |= a[i] ^ b[i];
96
97 return( diff );
98}
99
100
101
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100102/****************************************************************/
103/* Global data, support functions and library management */
104/****************************************************************/
105
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200106static int key_type_is_raw_bytes( psa_key_type_t type )
107{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200108 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200109}
110
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100111/* Values for psa_global_data_t::rng_state */
112#define RNG_NOT_INITIALIZED 0
113#define RNG_INITIALIZED 1
114#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100115
Gilles Peskine2d277862018-06-18 15:41:12 +0200116typedef struct
117{
Gilles Peskine5e769522018-11-20 21:59:56 +0100118 void (* entropy_init )( mbedtls_entropy_context *ctx );
119 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120 mbedtls_entropy_context entropy;
121 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100122 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100123 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100124} psa_global_data_t;
125
126static psa_global_data_t global_data;
127
itayzafrir0adf0fc2018-09-06 16:24:41 +0300128#define GUARD_MODULE_INITIALIZED \
129 if( global_data.initialized == 0 ) \
130 return( PSA_ERROR_BAD_STATE );
131
Steven Cooreman01164162020-07-20 15:31:37 +0200132psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133{
Gilles Peskinea5905292018-02-07 20:59:33 +0100134 /* If there's both a high-level code and low-level code, dispatch on
135 * the high-level code. */
136 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100137 {
138 case 0:
139 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100140
141 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
142 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
143 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
144 return( PSA_ERROR_NOT_SUPPORTED );
145 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
146 return( PSA_ERROR_HARDWARE_FAILURE );
147
148 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
149 return( PSA_ERROR_HARDWARE_FAILURE );
150
Gilles Peskine9a944802018-06-21 09:35:35 +0200151 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
152 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
153 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
154 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
155 case MBEDTLS_ERR_ASN1_INVALID_DATA:
156 return( PSA_ERROR_INVALID_ARGUMENT );
157 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
158 return( PSA_ERROR_INSUFFICIENT_MEMORY );
159 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
160 return( PSA_ERROR_BUFFER_TOO_SMALL );
161
Jaeden Amero93e21112019-02-20 13:57:28 +0000162#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000163 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000164#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
165 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
166#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
168 return( PSA_ERROR_NOT_SUPPORTED );
169 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
170 return( PSA_ERROR_HARDWARE_FAILURE );
171
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000173 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000174#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
175 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
178 return( PSA_ERROR_NOT_SUPPORTED );
179 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
180 return( PSA_ERROR_HARDWARE_FAILURE );
181
182 case MBEDTLS_ERR_CCM_BAD_INPUT:
183 return( PSA_ERROR_INVALID_ARGUMENT );
184 case MBEDTLS_ERR_CCM_AUTH_FAILED:
185 return( PSA_ERROR_INVALID_SIGNATURE );
186 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
187 return( PSA_ERROR_HARDWARE_FAILURE );
188
Gilles Peskine26869f22019-05-06 15:25:00 +0200189 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
190 return( PSA_ERROR_INVALID_ARGUMENT );
191
192 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
193 return( PSA_ERROR_BAD_STATE );
194 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
195 return( PSA_ERROR_INVALID_SIGNATURE );
196
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
198 return( PSA_ERROR_NOT_SUPPORTED );
199 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
200 return( PSA_ERROR_INVALID_ARGUMENT );
201 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
202 return( PSA_ERROR_INSUFFICIENT_MEMORY );
203 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
204 return( PSA_ERROR_INVALID_PADDING );
205 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200206 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
208 return( PSA_ERROR_INVALID_SIGNATURE );
209 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200210 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
212 return( PSA_ERROR_HARDWARE_FAILURE );
213
214 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
215 return( PSA_ERROR_HARDWARE_FAILURE );
216
217 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
218 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
219 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
220 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
223 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
224
225 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
226 return( PSA_ERROR_NOT_SUPPORTED );
227 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
228 return( PSA_ERROR_HARDWARE_FAILURE );
229
Gilles Peskinee59236f2018-01-27 23:32:46 +0100230 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
231 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
232 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
233 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100234
235 case MBEDTLS_ERR_GCM_AUTH_FAILED:
236 return( PSA_ERROR_INVALID_SIGNATURE );
237 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200238 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100239 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
240 return( PSA_ERROR_HARDWARE_FAILURE );
241
242 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
243 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
244 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
245 return( PSA_ERROR_HARDWARE_FAILURE );
246
247 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
248 return( PSA_ERROR_NOT_SUPPORTED );
249 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_MD_ALLOC_FAILED:
252 return( PSA_ERROR_INSUFFICIENT_MEMORY );
253 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
254 return( PSA_ERROR_STORAGE_FAILURE );
255 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
256 return( PSA_ERROR_HARDWARE_FAILURE );
257
Gilles Peskinef76aa772018-10-29 19:24:33 +0100258 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
259 return( PSA_ERROR_STORAGE_FAILURE );
260 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
261 return( PSA_ERROR_INVALID_ARGUMENT );
262 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
265 return( PSA_ERROR_BUFFER_TOO_SMALL );
266 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
269 return( PSA_ERROR_INVALID_ARGUMENT );
270 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
271 return( PSA_ERROR_INVALID_ARGUMENT );
272 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
274
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100275 case MBEDTLS_ERR_PK_ALLOC_FAILED:
276 return( PSA_ERROR_INSUFFICIENT_MEMORY );
277 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
278 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
279 return( PSA_ERROR_INVALID_ARGUMENT );
280 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100281 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100282 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
283 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
286 return( PSA_ERROR_NOT_SUPPORTED );
287 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
288 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
289 return( PSA_ERROR_NOT_PERMITTED );
290 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
291 return( PSA_ERROR_INVALID_ARGUMENT );
292 case MBEDTLS_ERR_PK_INVALID_ALG:
293 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
294 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
295 return( PSA_ERROR_NOT_SUPPORTED );
296 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
297 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100298 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
299 return( PSA_ERROR_HARDWARE_FAILURE );
300
Gilles Peskineff2d2002019-05-06 15:26:23 +0200301 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
302 return( PSA_ERROR_HARDWARE_FAILURE );
303 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
304 return( PSA_ERROR_NOT_SUPPORTED );
305
Gilles Peskinea5905292018-02-07 20:59:33 +0100306 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
307 return( PSA_ERROR_HARDWARE_FAILURE );
308
309 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
310 return( PSA_ERROR_INVALID_ARGUMENT );
311 case MBEDTLS_ERR_RSA_INVALID_PADDING:
312 return( PSA_ERROR_INVALID_PADDING );
313 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
314 return( PSA_ERROR_HARDWARE_FAILURE );
315 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
316 return( PSA_ERROR_INVALID_ARGUMENT );
317 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
318 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200319 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
321 return( PSA_ERROR_INVALID_SIGNATURE );
322 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
323 return( PSA_ERROR_BUFFER_TOO_SMALL );
324 case MBEDTLS_ERR_RSA_RNG_FAILED:
325 return( PSA_ERROR_INSUFFICIENT_MEMORY );
326 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
327 return( PSA_ERROR_NOT_SUPPORTED );
328 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
329 return( PSA_ERROR_HARDWARE_FAILURE );
330
331 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
332 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
333 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
334 return( PSA_ERROR_HARDWARE_FAILURE );
335
336 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
337 return( PSA_ERROR_INVALID_ARGUMENT );
338 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
339 return( PSA_ERROR_HARDWARE_FAILURE );
340
itayzafrir5c753392018-05-08 11:18:38 +0300341 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300342 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300343 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
345 return( PSA_ERROR_BUFFER_TOO_SMALL );
346 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
347 return( PSA_ERROR_NOT_SUPPORTED );
348 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
349 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
350 return( PSA_ERROR_INVALID_SIGNATURE );
351 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
352 return( PSA_ERROR_INSUFFICIENT_MEMORY );
353 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
354 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000355 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
356 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300357
Gilles Peskinee59236f2018-01-27 23:32:46 +0100358 default:
David Saadab4ecc272019-02-14 13:48:10 +0200359 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100360 }
361}
362
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200363
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200364
365
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100366/****************************************************************/
367/* Key management */
368/****************************************************************/
369
Gilles Peskine73167e12019-07-12 23:44:37 +0200370#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
371static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
372{
Gilles Peskine8e338702019-07-30 20:06:31 +0200373 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200374}
375#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
376
John Durkop07cc04a2020-11-16 22:08:34 -0800377/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
378 * current test driver in key_management.c is using this function
379 * when accelerators are used for ECC key pair and public key.
380 * Once that dependency is resolved these guards can be removed.
381 */
John Durkop9814fa22020-11-04 12:28:15 -0800382#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800383 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
384 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
385 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100386mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100387 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200388{
389 switch( curve )
390 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100391 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 switch( byte_length )
393 {
394 case PSA_BITS_TO_BYTES( 192 ):
395 return( MBEDTLS_ECP_DP_SECP192R1 );
396 case PSA_BITS_TO_BYTES( 224 ):
397 return( MBEDTLS_ECP_DP_SECP224R1 );
398 case PSA_BITS_TO_BYTES( 256 ):
399 return( MBEDTLS_ECP_DP_SECP256R1 );
400 case PSA_BITS_TO_BYTES( 384 ):
401 return( MBEDTLS_ECP_DP_SECP384R1 );
402 case PSA_BITS_TO_BYTES( 521 ):
403 return( MBEDTLS_ECP_DP_SECP521R1 );
404 default:
405 return( MBEDTLS_ECP_DP_NONE );
406 }
407 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100408
Paul Elliott8ff510a2020-06-02 17:19:28 +0100409 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 switch( byte_length )
411 {
412 case PSA_BITS_TO_BYTES( 256 ):
413 return( MBEDTLS_ECP_DP_BP256R1 );
414 case PSA_BITS_TO_BYTES( 384 ):
415 return( MBEDTLS_ECP_DP_BP384R1 );
416 case PSA_BITS_TO_BYTES( 512 ):
417 return( MBEDTLS_ECP_DP_BP512R1 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 255 ):
427 return( MBEDTLS_ECP_DP_CURVE25519 );
428 case PSA_BITS_TO_BYTES( 448 ):
429 return( MBEDTLS_ECP_DP_CURVE448 );
430 default:
431 return( MBEDTLS_ECP_DP_NONE );
432 }
433 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100434
Paul Elliott8ff510a2020-06-02 17:19:28 +0100435 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100436 switch( byte_length )
437 {
438 case PSA_BITS_TO_BYTES( 192 ):
439 return( MBEDTLS_ECP_DP_SECP192K1 );
440 case PSA_BITS_TO_BYTES( 224 ):
441 return( MBEDTLS_ECP_DP_SECP224K1 );
442 case PSA_BITS_TO_BYTES( 256 ):
443 return( MBEDTLS_ECP_DP_SECP256K1 );
444 default:
445 return( MBEDTLS_ECP_DP_NONE );
446 }
447 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100448
Gilles Peskine12313cd2018-06-20 00:20:32 +0200449 default:
450 return( MBEDTLS_ECP_DP_NONE );
451 }
452}
John Durkop9814fa22020-11-04 12:28:15 -0800453#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800454 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
455 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
456 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200457
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200458static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
459 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200460{
461 /* Check that the bit size is acceptable for the key type */
462 switch( type )
463 {
464 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200465 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200466 case PSA_KEY_TYPE_DERIVE:
467 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200468#if defined(MBEDTLS_AES_C)
469 case PSA_KEY_TYPE_AES:
470 if( bits != 128 && bits != 192 && bits != 256 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
472 break;
473#endif
474#if defined(MBEDTLS_CAMELLIA_C)
475 case PSA_KEY_TYPE_CAMELLIA:
476 if( bits != 128 && bits != 192 && bits != 256 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
478 break;
479#endif
480#if defined(MBEDTLS_DES_C)
481 case PSA_KEY_TYPE_DES:
482 if( bits != 64 && bits != 128 && bits != 192 )
483 return( PSA_ERROR_INVALID_ARGUMENT );
484 break;
485#endif
486#if defined(MBEDTLS_ARC4_C)
487 case PSA_KEY_TYPE_ARC4:
488 if( bits < 8 || bits > 2048 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
490 break;
491#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200492#if defined(MBEDTLS_CHACHA20_C)
493 case PSA_KEY_TYPE_CHACHA20:
494 if( bits != 256 )
495 return( PSA_ERROR_INVALID_ARGUMENT );
496 break;
497#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200498 default:
499 return( PSA_ERROR_NOT_SUPPORTED );
500 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200501 if( bits % 8 != 0 )
502 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200503
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200504 return( PSA_SUCCESS );
505}
506
John Durkop0e005192020-10-31 22:06:54 -0700507#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
508 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
509 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
John Durkop9814fa22020-11-04 12:28:15 -0800510 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
511 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
512 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooremana01795d2020-07-24 22:48:15 +0200513
Gilles Peskine86a440b2018-11-12 18:39:40 +0100514/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
515 * that are not a multiple of 8) well. For example, there is only
516 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
517 * way to return the exact bit size of a key.
518 * To keep things simple, reject non-byte-aligned key sizes. */
519static psa_status_t psa_check_rsa_key_byte_aligned(
520 const mbedtls_rsa_context *rsa )
521{
522 mbedtls_mpi n;
523 psa_status_t status;
524 mbedtls_mpi_init( &n );
525 status = mbedtls_to_psa_error(
526 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
527 if( status == PSA_SUCCESS )
528 {
529 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
530 status = PSA_ERROR_NOT_SUPPORTED;
531 }
532 mbedtls_mpi_free( &n );
533 return( status );
534}
535
Steven Cooreman7f391872020-07-30 14:57:44 +0200536/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200538 * \param[in] type The type of key contained in \p data.
539 * \param[in] data The buffer from which to load the representation.
540 * \param[in] data_length The size in bytes of \p data.
541 * \param[out] p_rsa Returns a pointer to an RSA context on success.
542 * The caller is responsible for freeing both the
543 * contents of the context and the context itself
544 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200545 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200546static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
547 const uint8_t *data,
548 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200549 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200550{
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000551 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200552 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000553 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200554 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555
556 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200557 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200559 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200560 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000561 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200562 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( status != PSA_SUCCESS )
564 goto exit;
565
566 /* We have something that the pkparse module recognizes. If it is a
567 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200569 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000570 status = PSA_ERROR_INVALID_ARGUMENT;
571 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200572 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000573
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000574 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
575 * supports non-byte-aligned key sizes, but not well. For example,
576 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200577 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000578 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
579 {
580 status = PSA_ERROR_NOT_SUPPORTED;
581 goto exit;
582 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200583 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 if( status != PSA_SUCCESS )
585 goto exit;
586
Steven Cooremana2371e52020-07-28 14:30:39 +0200587 /* Copy out the pointer to the RSA context, and reset the PK context
588 * such that pk_free doesn't free the RSA context we just grabbed. */
589 *p_rsa = mbedtls_pk_rsa( ctx );
590 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000591
592exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200593 mbedtls_pk_free( &ctx );
594 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +0200595}
596
John Durkop6ba40d12020-11-10 08:50:04 -0800597#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
598 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
599 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
600 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
601 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
602 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
603
604#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
605 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
606
Steven Cooremana01795d2020-07-24 22:48:15 +0200607/** Export an RSA key to export representation
608 *
609 * \param[in] type The type of key (public/private) to export
610 * \param[in] rsa The internal RSA representation from which to export
611 * \param[out] data The buffer to export to
612 * \param[in] data_size The length of the buffer to export to
613 * \param[out] data_length The amount of bytes written to \p data
614 */
615static psa_status_t psa_export_rsa_key( psa_key_type_t type,
616 mbedtls_rsa_context *rsa,
617 uint8_t *data,
618 size_t data_size,
619 size_t *data_length )
620{
621#if defined(MBEDTLS_PK_WRITE_C)
622 int ret;
623 mbedtls_pk_context pk;
624 uint8_t *pos = data + data_size;
625
626 mbedtls_pk_init( &pk );
627 pk.pk_info = &mbedtls_rsa_info;
628 pk.pk_ctx = rsa;
629
630 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200631 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
632 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200633 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
634 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
635 else
636 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
637
638 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200639 {
640 /* Clean up in case pk_write failed halfway through. */
641 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200642 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200643 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200644
645 /* The mbedtls_pk_xxx functions write to the end of the buffer.
646 * Move the data to the beginning and erase remaining data
647 * at the original location. */
648 if( 2 * (size_t) ret <= data_size )
649 {
650 memcpy( data, data + data_size - ret, ret );
651 memset( data + data_size - ret, 0, ret );
652 }
653 else if( (size_t) ret < data_size )
654 {
655 memmove( data, data + data_size - ret, ret );
656 memset( data + ret, 0, data_size - ret );
657 }
658
659 *data_length = ret;
660 return( PSA_SUCCESS );
661#else
662 (void) type;
663 (void) rsa;
664 (void) data;
665 (void) data_size;
666 (void) data_length;
667 return( PSA_ERROR_NOT_SUPPORTED );
668#endif /* MBEDTLS_PK_WRITE_C */
669}
670
671/** Import an RSA key from import representation to a slot
672 *
673 * \param[in,out] slot The slot where to store the export representation to
674 * \param[in] data The buffer containing the import representation
675 * \param[in] data_length The amount of bytes in \p data
676 */
677static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
678 const uint8_t *data,
679 size_t data_length )
680{
681 psa_status_t status;
682 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200683 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200684
Steven Cooremana01795d2020-07-24 22:48:15 +0200685 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200686 status = psa_load_rsa_representation( slot->attr.type,
687 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200688 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200689 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200690 if( status != PSA_SUCCESS )
691 goto exit;
692
693 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200694 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200695
Steven Cooreman75b74362020-07-28 14:30:13 +0200696 /* Re-export the data to PSA export format, such that we can store export
697 * representation in the key slot. Export representation in case of RSA is
698 * the smallest representation that's allowed as input, so a straight-up
699 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200700 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200701 if( output == NULL )
702 {
703 status = PSA_ERROR_INSUFFICIENT_MEMORY;
704 goto exit;
705 }
706
Steven Cooremana01795d2020-07-24 22:48:15 +0200707 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200708 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200709 output,
710 data_length,
711 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200712exit:
713 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200714 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200715 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200716
717 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000718 if( status != PSA_SUCCESS )
719 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200720 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000721 return( status );
722 }
723
Steven Cooremana01795d2020-07-24 22:48:15 +0200724 /* On success, store the allocated export-formatted key. */
725 slot->data.key.data = output;
726 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000727
728 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200729}
John Durkop6ba40d12020-11-10 08:50:04 -0800730
731#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -0800732 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200733
John Durkop9814fa22020-11-04 12:28:15 -0800734#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800735 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
736 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
737 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) || \
738 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Steven Cooreman7f391872020-07-30 14:57:44 +0200739/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200740 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200741 * \param[in] type The type of key contained in \p data.
742 * \param[in] data The buffer from which to load the representation.
743 * \param[in] data_length The size in bytes of \p data.
744 * \param[out] p_ecp Returns a pointer to an ECP context on success.
745 * The caller is responsible for freeing both the
746 * contents of the context and the context itself
747 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200748 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200749static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
750 const uint8_t *data,
751 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200752 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100753{
754 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200755 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200756 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200757 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100758
Steven Cooreman4fed4552020-08-03 14:46:03 +0200759 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
760 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100761 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200762 /* A Weierstrass public key is represented as:
763 * - The byte 0x04;
764 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
765 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200766 * So its data length is 2m+1 where m is the curve size in bits.
Steven Cooreman4fed4552020-08-03 14:46:03 +0200767 */
768 if( ( data_length & 1 ) == 0 )
769 return( PSA_ERROR_INVALID_ARGUMENT );
770 curve_size = data_length / 2;
771
772 /* Montgomery public keys are represented in compressed format, meaning
773 * their curve_size is equal to the amount of input. */
774
775 /* Private keys are represented in uncompressed private random integer
776 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100777 }
778
Steven Cooreman6d839f02020-07-30 11:36:45 +0200779 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200780 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200781 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200782 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200783 mbedtls_ecp_keypair_init( ecp );
784
Gilles Peskine4cd32772019-12-02 20:49:42 +0100785 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200786 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
787 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100788 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200789 {
790 status = PSA_ERROR_INVALID_ARGUMENT;
791 goto exit;
792 }
793
Steven Cooremanacda8342020-07-24 23:09:52 +0200794 status = mbedtls_to_psa_error(
795 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
796 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200797 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200798
Steven Cooreman6d839f02020-07-30 11:36:45 +0200799 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200800 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200801 {
802 /* Load the public value. */
803 status = mbedtls_to_psa_error(
804 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200805 data,
806 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200807 if( status != PSA_SUCCESS )
808 goto exit;
809
810 /* Check that the point is on the curve. */
811 status = mbedtls_to_psa_error(
812 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
813 if( status != PSA_SUCCESS )
814 goto exit;
815 }
816 else
817 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200818 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200819 status = mbedtls_to_psa_error(
820 mbedtls_ecp_read_key( ecp->grp.id,
821 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200822 data,
823 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200824 if( status != PSA_SUCCESS )
825 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200826 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200827
828 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200829exit:
830 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200831 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200832 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200833 mbedtls_free( ecp );
834 }
835
Steven Cooreman29149862020-08-05 15:43:42 +0200836 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100837}
John Durkop6ba40d12020-11-10 08:50:04 -0800838#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
839 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
840 * defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
841 * defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) ||
842 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Jaeden Ameroccdce902019-01-10 11:42:27 +0000843
John Durkop6ba40d12020-11-10 08:50:04 -0800844#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
845 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman4fed4552020-08-03 14:46:03 +0200846/** Export an ECP key to export representation
847 *
848 * \param[in] type The type of key (public/private) to export
849 * \param[in] ecp The internal ECP representation from which to export
850 * \param[out] data The buffer to export to
851 * \param[in] data_size The length of the buffer to export to
852 * \param[out] data_length The amount of bytes written to \p data
853 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200854static psa_status_t psa_export_ecp_key( psa_key_type_t type,
855 mbedtls_ecp_keypair *ecp,
856 uint8_t *data,
857 size_t data_size,
858 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200859{
Steven Cooremanacda8342020-07-24 23:09:52 +0200860 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000861
Steven Cooremanacda8342020-07-24 23:09:52 +0200862 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200863 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 /* Check whether the public part is loaded */
865 if( mbedtls_ecp_is_zero( &ecp->Q ) )
866 {
867 /* Calculate the public key */
868 status = mbedtls_to_psa_error(
869 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
870 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
871 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200872 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200873 }
874
Steven Cooreman4fed4552020-08-03 14:46:03 +0200875 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200876 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
877 MBEDTLS_ECP_PF_UNCOMPRESSED,
878 data_length,
879 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200880 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200881 if( status != PSA_SUCCESS )
882 memset( data, 0, data_size );
883
Steven Cooreman29149862020-08-05 15:43:42 +0200884 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200885 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200886 else
887 {
Steven Cooreman29149862020-08-05 15:43:42 +0200888 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200889 return( PSA_ERROR_BUFFER_TOO_SMALL );
890
891 status = mbedtls_to_psa_error(
892 mbedtls_ecp_write_key( ecp,
893 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200894 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200896 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200897 else
898 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200899
900 return( status );
901 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200902}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200903
Steven Cooreman4fed4552020-08-03 14:46:03 +0200904/** Import an ECP key from import representation to a slot
905 *
906 * \param[in,out] slot The slot where to store the export representation to
907 * \param[in] data The buffer containing the import representation
908 * \param[in] data_length The amount of bytes in \p data
909 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200910static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
911 const uint8_t *data,
912 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100913{
Steven Cooremanacda8342020-07-24 23:09:52 +0200914 psa_status_t status;
915 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100917
Steven Cooremanacda8342020-07-24 23:09:52 +0200918 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200919 status = psa_load_ecp_representation( slot->attr.type,
920 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200921 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200922 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100923 if( status != PSA_SUCCESS )
924 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100925
Steven Cooremanacda8342020-07-24 23:09:52 +0200926 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200927 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200928 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200929 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200930
Steven Cooremanacda8342020-07-24 23:09:52 +0200931 /* Re-export the data to PSA export format. There is currently no support
932 * for other input formats then the export format, so this is a 1-1
933 * copy operation. */
934 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200935 if( output == NULL )
936 {
937 status = PSA_ERROR_INSUFFICIENT_MEMORY;
938 goto exit;
939 }
940
941 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200942 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200943 output,
944 data_length,
945 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100946exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200947 /* Always free the PK object (will also free contained ECP context) */
948 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200949 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200950
951 /* Free the allocated buffer only on error. */
952 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100953 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200954 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200955 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100956 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200957
958 /* On success, store the allocated export-formatted key. */
959 slot->data.key.data = output;
960 slot->data.key.bytes = data_length;
961
962 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100963}
John Durkop9814fa22020-11-04 12:28:15 -0800964#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
965 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskinef76aa772018-10-29 19:24:33 +0100966
Gilles Peskineb46bef22019-07-30 21:32:04 +0200967/** Return the size of the key in the given slot, in bits.
968 *
969 * \param[in] slot A key slot.
970 *
971 * \return The key size in bits, read from the metadata in the slot.
972 */
973static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
974{
975 return( slot->attr.bits );
976}
977
Steven Cooreman75b74362020-07-28 14:30:13 +0200978/** Try to allocate a buffer to an empty key slot.
979 *
980 * \param[in,out] slot Key slot to attach buffer to.
981 * \param[in] buffer_length Requested size of the buffer.
982 *
983 * \retval #PSA_SUCCESS
984 * The buffer has been successfully allocated.
985 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
986 * Not enough memory was available for allocation.
987 * \retval #PSA_ERROR_ALREADY_EXISTS
988 * Trying to allocate a buffer to a non-empty key slot.
989 */
990static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
991 size_t buffer_length )
992{
993 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200994 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200995
996 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
997 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200998 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200999
1000 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +02001001 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +02001002}
1003
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001004psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
1005 const uint8_t* data,
1006 size_t data_length )
1007{
1008 psa_status_t status = psa_allocate_buffer_to_slot( slot,
1009 data_length );
1010 if( status != PSA_SUCCESS )
1011 return( status );
1012
1013 memcpy( slot->data.key.data, data, data_length );
1014 return( PSA_SUCCESS );
1015}
1016
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001017/** Import key data into a slot.
1018 *
1019 * `slot->type` must have been set previously.
1020 * This function assumes that the slot does not contain any key material yet.
1021 * On failure, the slot content is unchanged.
1022 *
1023 * Persistent storage is not affected.
1024 *
1025 * \param[in,out] slot The key slot to import data into.
1026 * Its `type` field must have previously been set to
1027 * the desired key type.
1028 * It must not contain any key material yet.
1029 * \param[in] data Buffer containing the key material to parse and import.
1030 * \param data_length Size of \p data in bytes.
1031 *
1032 * \retval #PSA_SUCCESS
1033 * \retval #PSA_ERROR_INVALID_ARGUMENT
1034 * \retval #PSA_ERROR_NOT_SUPPORTED
1035 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1036 */
1037static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
1038 const uint8_t *data,
1039 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040{
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001041 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +02001042 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001043
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001044 /* zero-length keys are never supported. */
1045 if( data_length == 0 )
1046 return( PSA_ERROR_NOT_SUPPORTED );
1047
Gilles Peskine8e338702019-07-30 20:06:31 +02001048 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001049 {
Steven Cooreman04524762020-10-13 17:43:44 +02001050 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001051
Steven Cooreman75b74362020-07-28 14:30:13 +02001052 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1053 if( data_length > SIZE_MAX / 8 )
1054 return( PSA_ERROR_NOT_SUPPORTED );
1055
Gilles Peskine1b9505c2019-08-07 10:59:45 +02001056 /* Enforce a size limit, and in particular ensure that the bit
1057 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +02001058 if( bit_size > PSA_MAX_KEY_BITS )
1059 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001060
1061 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001062 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001063 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001064
1065 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001066 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +02001067 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001068 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001069
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001070 /* Write the actual key size to the slot.
1071 * psa_start_key_creation() wrote the size declared by the
1072 * caller, which may be 0 (meaning unspecified) or wrong. */
1073 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +01001074
1075 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001076 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001077 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +02001078 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001079 /* Try validation through accelerators first. */
1080 bit_size = slot->attr.bits;
1081 psa_key_attributes_t attributes = {
1082 .core = slot->attr
1083 };
1084 status = psa_driver_wrapper_validate_key( &attributes,
1085 data,
1086 data_length,
1087 &bit_size );
1088 if( status == PSA_SUCCESS )
1089 {
1090 /* Key has been validated successfully by an accelerator.
1091 * Copy key material into slot. */
1092 status = psa_copy_key_material_into_slot( slot, data, data_length );
1093 if( status != PSA_SUCCESS )
1094 return( status );
1095
1096 slot->attr.bits = (psa_key_bits_t) bit_size;
1097 return( PSA_SUCCESS );
1098 }
1099 else if( status != PSA_ERROR_NOT_SUPPORTED )
1100 return( status );
1101
1102 /* Key format is not supported by any accelerator, try software fallback
1103 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -08001104#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1105 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001106 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1107 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001108 return( psa_import_ecp_key( slot, data, data_length ) );
1109 }
John Durkop9814fa22020-11-04 12:28:15 -08001110#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1111 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -07001112#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1113 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +01001114 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001115 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001116 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001117 }
John Durkop9814fa22020-11-04 12:28:15 -08001118#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1119 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +01001120
1121 /* Fell through the fallback as well, so have nothing else to try. */
1122 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001123 }
1124 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001125 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001126 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001127 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001128 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001129}
1130
Gilles Peskinef603c712019-01-19 13:40:11 +01001131/** Calculate the intersection of two algorithm usage policies.
1132 *
1133 * Return 0 (which allows no operation) on incompatibility.
1134 */
1135static psa_algorithm_t psa_key_policy_algorithm_intersection(
1136 psa_algorithm_t alg1,
1137 psa_algorithm_t alg2 )
1138{
Gilles Peskine549ea862019-05-22 11:45:59 +02001139 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001140 if( alg1 == alg2 )
1141 return( alg1 );
1142 /* If the policies are from the same hash-and-sign family, check
1143 * if one is a wildcard. If so the other has the specific algorithm. */
1144 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1145 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1146 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1147 {
1148 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1149 return( alg2 );
1150 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1151 return( alg1 );
1152 }
1153 /* If the policies are incompatible, allow nothing. */
1154 return( 0 );
1155}
1156
Gilles Peskined6f371b2019-05-10 19:33:38 +02001157static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1158 psa_algorithm_t requested_alg )
1159{
Gilles Peskine549ea862019-05-22 11:45:59 +02001160 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001161 if( requested_alg == policy_alg )
1162 return( 1 );
1163 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001164 * and requested_alg is the same hash-and-sign family with any hash,
1165 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001166 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1167 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1168 {
1169 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1170 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1171 }
Steven Cooremance48e852020-10-05 16:02:45 +02001172 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001173 * a key derivation with that key agreement should also be allowed. This
1174 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001175 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1176 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1177 {
1178 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1179 policy_alg );
1180 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001181 /* If it isn't permitted, it's forbidden. */
1182 return( 0 );
1183}
1184
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001185/** Test whether a policy permits an algorithm.
1186 *
1187 * The caller must test usage flags separately.
1188 */
1189static int psa_key_policy_permits( const psa_key_policy_t *policy,
1190 psa_algorithm_t alg )
1191{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001192 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1193 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001194}
1195
Gilles Peskinef603c712019-01-19 13:40:11 +01001196/** Restrict a key policy based on a constraint.
1197 *
1198 * \param[in,out] policy The policy to restrict.
1199 * \param[in] constraint The policy constraint to apply.
1200 *
1201 * \retval #PSA_SUCCESS
1202 * \c *policy contains the intersection of the original value of
1203 * \c *policy and \c *constraint.
1204 * \retval #PSA_ERROR_INVALID_ARGUMENT
1205 * \c *policy and \c *constraint are incompatible.
1206 * \c *policy is unchanged.
1207 */
1208static psa_status_t psa_restrict_key_policy(
1209 psa_key_policy_t *policy,
1210 const psa_key_policy_t *constraint )
1211{
1212 psa_algorithm_t intersection_alg =
1213 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001214 psa_algorithm_t intersection_alg2 =
1215 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001216 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1217 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001218 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1219 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001220 policy->usage &= constraint->usage;
1221 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001222 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001223 return( PSA_SUCCESS );
1224}
1225
Ronald Cron5c522922020-11-14 16:35:34 +01001226/** Get the description of a key given its identifier and policy constraints
1227 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001228 *
Ronald Cron5c522922020-11-14 16:35:34 +01001229 * The key must have allow all the usage flags set in \p usage. If \p alg is
1230 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +01001231 *
Ronald Cron5c522922020-11-14 16:35:34 +01001232 * In case of a persistent key, the function loads the description of the key
1233 * into a key slot if not already done.
1234 *
1235 * On success, the returned key slot is locked. It is the responsibility of
1236 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001237 */
Ronald Cron5c522922020-11-14 16:35:34 +01001238static psa_status_t psa_get_and_lock_key_slot_with_policy(
1239 mbedtls_svc_key_id_t key,
1240 psa_key_slot_t **p_slot,
1241 psa_key_usage_t usage,
1242 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +01001243{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1245 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001246
Ronald Cron5c522922020-11-14 16:35:34 +01001247 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001248 if( status != PSA_SUCCESS )
1249 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001250 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001251
1252 /* Enforce that usage policy for the key slot contains all the flags
1253 * required by the usage parameter. There is one exception: public
1254 * keys can always be exported, so we treat public key objects as
1255 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001256 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001257 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001258
1259 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +02001260 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001261 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001262
1263 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001264 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001265 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +01001266
Darryl Green06fd18d2018-07-16 11:21:11 +01001267 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001268
1269error:
1270 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001271 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001272
1273 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001274}
Darryl Green940d72c2018-07-13 13:18:51 +01001275
Ronald Cron5c522922020-11-14 16:35:34 +01001276/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001277 *
1278 * A transparent key is a key for which the key material is directly
1279 * available, as opposed to a key in a secure element.
1280 *
Ronald Cron5c522922020-11-14 16:35:34 +01001281 * This is a temporary function to use instead of
1282 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1283 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001284 *
Ronald Cron5c522922020-11-14 16:35:34 +01001285 * On success, the returned key slot is locked. It is the responsibility of the
1286 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001287 */
1288#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001289static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1290 mbedtls_svc_key_id_t key,
1291 psa_key_slot_t **p_slot,
1292 psa_key_usage_t usage,
1293 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001294{
Ronald Cron5c522922020-11-14 16:35:34 +01001295 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1296 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001297 if( status != PSA_SUCCESS )
1298 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001299
Gilles Peskineadad8132019-07-25 11:31:23 +02001300 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001301 {
Ronald Cron5c522922020-11-14 16:35:34 +01001302 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001303 *p_slot = NULL;
1304 return( PSA_ERROR_NOT_SUPPORTED );
1305 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001306
Gilles Peskine28f8f302019-07-24 13:30:31 +02001307 return( PSA_SUCCESS );
1308}
1309#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1310/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001311#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1312 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001313#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1314
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001315/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001316static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001317{
Gilles Peskine73167e12019-07-12 23:44:37 +02001318#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1319 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001320 {
1321 /* No key material to clean. */
1322 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001323 else
1324#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001325 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001326 /* Data pointer will always be either a valid pointer or NULL in an
1327 * initialized slot, so we can just free it. */
1328 if( slot->data.key.data != NULL )
1329 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001330 mbedtls_free( slot->data.key.data );
1331 slot->data.key.data = NULL;
1332 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001333 }
Darryl Green40225ba2018-11-15 14:48:15 +00001334
1335 return( PSA_SUCCESS );
1336}
1337
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001338/** Completely wipe a slot in memory, including its policy.
1339 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001340psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001341{
1342 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001343
1344 /*
1345 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001346 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001347 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1348 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001349 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001350 */
Ronald Cron5c522922020-11-14 16:35:34 +01001351 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001352 {
1353#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001354 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001355#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001356 status = PSA_ERROR_CORRUPTION_DETECTED;
1357 }
1358
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001359 /* Multipart operations may still be using the key. This is safe
1360 * because all multipart operation objects are independent from
1361 * the key slot: if they need to access the key after the setup
1362 * phase, they have a copy of the key. Note that this means that
1363 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001364 /* At this point, key material and other type-specific content has
1365 * been wiped. Clear remaining metadata. We can call memset and not
1366 * zeroize because the metadata is not particularly sensitive. */
1367 memset( slot, 0, sizeof( *slot ) );
1368 return( status );
1369}
1370
Ronald Croncf56a0a2020-08-04 09:51:30 +02001371psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001372{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001373 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001374 psa_status_t status; /* status of the last operation */
1375 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001376#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1377 psa_se_drv_table_entry_t *driver;
1378#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001379
Ronald Croncf56a0a2020-08-04 09:51:30 +02001380 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001381 return( PSA_SUCCESS );
1382
Ronald Cronf2911112020-10-29 17:51:10 +01001383 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001384 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001385 * key, this will load the key description from persistent memory if not
1386 * done yet. We cannot avoid this loading as without it we don't know if
1387 * the key is operated by an SE or not and this information is needed by
1388 * the current implementation.
1389 */
Ronald Cron5c522922020-11-14 16:35:34 +01001390 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001391 if( status != PSA_SUCCESS )
1392 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001393
Ronald Cronf2911112020-10-29 17:51:10 +01001394 /*
1395 * If the key slot containing the key description is under access by the
1396 * library (apart from the present access), the key cannot be destroyed
1397 * yet. For the time being, just return in error. Eventually (to be
1398 * implemented), the key should be destroyed when all accesses have
1399 * stopped.
1400 */
Ronald Cron5c522922020-11-14 16:35:34 +01001401 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001402 {
Ronald Cron5c522922020-11-14 16:35:34 +01001403 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001404 return( PSA_ERROR_GENERIC_ERROR );
1405 }
1406
Gilles Peskine354f7672019-07-12 23:46:38 +02001407#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001408 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001409 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001410 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001411 /* For a key in a secure element, we need to do three things:
1412 * remove the key file in internal storage, destroy the
1413 * key inside the secure element, and update the driver's
1414 * persistent data. Start a transaction that will encompass these
1415 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001416 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001417 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001418 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001419 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001420 status = psa_crypto_save_transaction( );
1421 if( status != PSA_SUCCESS )
1422 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001423 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001424 /* We should still try to destroy the key in the secure
1425 * element and the key metadata in storage. This is especially
1426 * important if the error is that the storage is full.
1427 * But how to do it exactly without risking an inconsistent
1428 * state after a reset?
1429 * https://github.com/ARMmbed/mbed-crypto/issues/215
1430 */
1431 overall_status = status;
1432 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001433 }
1434
Gilles Peskine354f7672019-07-12 23:46:38 +02001435 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001436 if( overall_status == PSA_SUCCESS )
1437 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001438 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001439#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1440
Darryl Greend49a4992018-06-18 17:27:26 +01001441#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001442 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001443 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001444 status = psa_destroy_persistent_key( slot->attr.id );
1445 if( overall_status == PSA_SUCCESS )
1446 overall_status = status;
1447
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001448 /* TODO: other slots may have a copy of the same key. We should
1449 * invalidate them.
1450 * https://github.com/ARMmbed/mbed-crypto/issues/214
1451 */
Darryl Greend49a4992018-06-18 17:27:26 +01001452 }
1453#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001454
Gilles Peskinefc762652019-07-22 19:30:34 +02001455#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1456 if( driver != NULL )
1457 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001458 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001459 if( overall_status == PSA_SUCCESS )
1460 overall_status = status;
1461 status = psa_crypto_stop_transaction( );
1462 if( overall_status == PSA_SUCCESS )
1463 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001464 }
1465#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1466
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001467#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1468exit:
1469#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001470 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001471 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1472 if( overall_status == PSA_SUCCESS )
1473 overall_status = status;
1474 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001475}
1476
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001477void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001478{
Gilles Peskineb699f072019-04-26 16:06:02 +02001479 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001480 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001481}
1482
Gilles Peskineb699f072019-04-26 16:06:02 +02001483psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1484 psa_key_type_t type,
1485 const uint8_t *data,
1486 size_t data_length )
1487{
1488 uint8_t *copy = NULL;
1489
1490 if( data_length != 0 )
1491 {
1492 copy = mbedtls_calloc( 1, data_length );
1493 if( copy == NULL )
1494 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1495 memcpy( copy, data, data_length );
1496 }
1497 /* After this point, this function is guaranteed to succeed, so it
1498 * can start modifying `*attributes`. */
1499
1500 if( attributes->domain_parameters != NULL )
1501 {
1502 mbedtls_free( attributes->domain_parameters );
1503 attributes->domain_parameters = NULL;
1504 attributes->domain_parameters_size = 0;
1505 }
1506
1507 attributes->domain_parameters = copy;
1508 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001509 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001510 return( PSA_SUCCESS );
1511}
1512
1513psa_status_t psa_get_key_domain_parameters(
1514 const psa_key_attributes_t *attributes,
1515 uint8_t *data, size_t data_size, size_t *data_length )
1516{
1517 if( attributes->domain_parameters_size > data_size )
1518 return( PSA_ERROR_BUFFER_TOO_SMALL );
1519 *data_length = attributes->domain_parameters_size;
1520 if( attributes->domain_parameters_size != 0 )
1521 memcpy( data, attributes->domain_parameters,
1522 attributes->domain_parameters_size );
1523 return( PSA_SUCCESS );
1524}
1525
John Durkop07cc04a2020-11-16 22:08:34 -08001526#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001527 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001528static psa_status_t psa_get_rsa_public_exponent(
1529 const mbedtls_rsa_context *rsa,
1530 psa_key_attributes_t *attributes )
1531{
1532 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001534 uint8_t *buffer = NULL;
1535 size_t buflen;
1536 mbedtls_mpi_init( &mpi );
1537
1538 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1539 if( ret != 0 )
1540 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001541 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1542 {
1543 /* It's the default value, which is reported as an empty string,
1544 * so there's nothing to do. */
1545 goto exit;
1546 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001547
1548 buflen = mbedtls_mpi_size( &mpi );
1549 buffer = mbedtls_calloc( 1, buflen );
1550 if( buffer == NULL )
1551 {
1552 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1553 goto exit;
1554 }
1555 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1556 if( ret != 0 )
1557 goto exit;
1558 attributes->domain_parameters = buffer;
1559 attributes->domain_parameters_size = buflen;
1560
1561exit:
1562 mbedtls_mpi_free( &mpi );
1563 if( ret != 0 )
1564 mbedtls_free( buffer );
1565 return( mbedtls_to_psa_error( ret ) );
1566}
John Durkop07cc04a2020-11-16 22:08:34 -08001567#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001568 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001569
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001570/** Retrieve all the publicly-accessible attributes of a key.
1571 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001572psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001573 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001574{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001575 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001576 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001577 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001578
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001579 psa_reset_key_attributes( attributes );
1580
Ronald Cron5c522922020-11-14 16:35:34 +01001581 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001582 if( status != PSA_SUCCESS )
1583 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001584
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001585 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001586 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1587 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1588
1589#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1590 if( psa_key_slot_is_external( slot ) )
1591 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1592#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001593
Gilles Peskine8e338702019-07-30 20:06:31 +02001594 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001595 {
John Durkop07cc04a2020-11-16 22:08:34 -08001596#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001597 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001598 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001599 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001600#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001601 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001602 * is not yet implemented.
1603 * https://github.com/ARMmbed/mbed-crypto/issues/216
1604 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001605 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001606 break;
1607#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001608 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001609 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001610
Steven Cooreman4fed4552020-08-03 14:46:03 +02001611 status = psa_load_rsa_representation( slot->attr.type,
1612 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001613 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001614 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001615 if( status != PSA_SUCCESS )
1616 break;
1617
Steven Cooremana2371e52020-07-28 14:30:39 +02001618 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001619 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001620 mbedtls_rsa_free( rsa );
1621 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001622 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001623 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001624#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001625 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001626 default:
1627 /* Nothing else to do. */
1628 break;
1629 }
1630
1631 if( status != PSA_SUCCESS )
1632 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001633
Ronald Cron5c522922020-11-14 16:35:34 +01001634 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001635
Ronald Cron5c522922020-11-14 16:35:34 +01001636 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001637}
1638
Gilles Peskinec8000c02019-08-02 20:15:51 +02001639#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1640psa_status_t psa_get_key_slot_number(
1641 const psa_key_attributes_t *attributes,
1642 psa_key_slot_number_t *slot_number )
1643{
1644 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1645 {
1646 *slot_number = attributes->slot_number;
1647 return( PSA_SUCCESS );
1648 }
1649 else
1650 return( PSA_ERROR_INVALID_ARGUMENT );
1651}
1652#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1653
Steven Cooremana01795d2020-07-24 22:48:15 +02001654static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1655 uint8_t *data,
1656 size_t data_size,
1657 size_t *data_length )
1658{
1659 if( slot->data.key.bytes > data_size )
1660 return( PSA_ERROR_BUFFER_TOO_SMALL );
1661 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1662 memset( data + slot->data.key.bytes, 0,
1663 data_size - slot->data.key.bytes );
1664 *data_length = slot->data.key.bytes;
1665 return( PSA_SUCCESS );
1666}
1667
Gilles Peskinef603c712019-01-19 13:40:11 +01001668static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1669 uint8_t *data,
1670 size_t data_size,
1671 size_t *data_length,
1672 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001673{
Gilles Peskine5d309672019-07-12 23:47:28 +02001674#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1675 const psa_drv_se_t *drv;
1676 psa_drv_se_context_t *drv_context;
1677#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1678
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001679 *data_length = 0;
1680
Gilles Peskine8e338702019-07-30 20:06:31 +02001681 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001682 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001683
Gilles Peskinef9168942019-09-12 19:20:29 +02001684 /* Reject a zero-length output buffer now, since this can never be a
1685 * valid key representation. This way we know that data must be a valid
1686 * pointer and we can do things like memset(data, ..., data_size). */
1687 if( data_size == 0 )
1688 return( PSA_ERROR_BUFFER_TOO_SMALL );
1689
Gilles Peskine5d309672019-07-12 23:47:28 +02001690#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001691 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001692 {
1693 psa_drv_se_export_key_t method;
1694 if( drv->key_management == NULL )
1695 return( PSA_ERROR_NOT_SUPPORTED );
1696 method = ( export_public_key ?
1697 drv->key_management->p_export_public :
1698 drv->key_management->p_export );
1699 if( method == NULL )
1700 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001701 return( method( drv_context,
1702 slot->data.se.slot_number,
1703 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001704 }
1705#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1706
Gilles Peskine8e338702019-07-30 20:06:31 +02001707 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001708 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001709 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001710 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001711 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1712 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001713 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001714 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001715 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001716 /* Exporting public -> public */
1717 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1718 }
1719 else if( !export_public_key )
1720 {
1721 /* Exporting private -> private */
1722 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1723 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001724
Steven Cooreman560c28a2020-07-24 23:20:24 +02001725 /* Need to export the public part of a private key,
Steven Cooremanb9b84422020-10-14 14:39:20 +02001726 * so conversion is needed. Try the accelerators first. */
1727 psa_status_t status = psa_driver_wrapper_export_public_key( slot,
1728 data,
1729 data_size,
1730 data_length );
1731
1732 if( status != PSA_ERROR_NOT_SUPPORTED ||
1733 psa_key_lifetime_is_external( slot->attr.lifetime ) )
1734 return( status );
1735
Steven Cooreman560c28a2020-07-24 23:20:24 +02001736 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1737 {
John Durkop0e005192020-10-31 22:06:54 -07001738#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1739 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001740 mbedtls_rsa_context *rsa = NULL;
Steven Cooremanb9b84422020-10-14 14:39:20 +02001741 status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001742 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001743 slot->data.key.data,
1744 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001745 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001746 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001747 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001748
Steven Cooreman560c28a2020-07-24 23:20:24 +02001749 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001750 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001751 data,
1752 data_size,
1753 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001754
Steven Cooremana2371e52020-07-28 14:30:39 +02001755 mbedtls_rsa_free( rsa );
1756 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001757
Steven Cooreman560c28a2020-07-24 23:20:24 +02001758 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001759#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001760 /* We don't know how to convert a private RSA key to public. */
1761 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001762#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1763 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001764 }
1765 else
Moran Pekera998bc62018-04-16 18:16:20 +03001766 {
John Durkop6ba40d12020-11-10 08:50:04 -08001767#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1768 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001769 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooremanb9b84422020-10-14 14:39:20 +02001770 status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001771 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001772 slot->data.key.data,
1773 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001774 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001775 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001776 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001777
1778 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1779 PSA_KEY_TYPE_ECC_GET_FAMILY(
1780 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001781 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001782 data,
1783 data_size,
1784 data_length );
1785
Steven Cooremana2371e52020-07-28 14:30:39 +02001786 mbedtls_ecp_keypair_free( ecp );
1787 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001788 return( status );
1789#else
1790 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001791 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001792#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1793 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001794 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001795 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001796 else
1797 {
1798 /* This shouldn't happen in the reference implementation, but
1799 it is valid for a special-purpose implementation to omit
1800 support for exporting certain key types. */
1801 return( PSA_ERROR_NOT_SUPPORTED );
1802 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001803}
1804
Ronald Croncf56a0a2020-08-04 09:51:30 +02001805psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001806 uint8_t *data,
1807 size_t data_size,
1808 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001809{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001810 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001811 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001812 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001813
1814 /* Set the key to empty now, so that even when there are errors, we always
1815 * set data_length to a value between 0 and data_size. On error, setting
1816 * the key to empty is a good choice because an empty key representation is
1817 * unlikely to be accepted anywhere. */
1818 *data_length = 0;
1819
1820 /* Export requires the EXPORT flag. There is an exception for public keys,
Ronald Cron5c522922020-11-14 16:35:34 +01001821 * which don't require any flag, but
1822 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1823 */
1824 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1825 PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001826 if( status != PSA_SUCCESS )
1827 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001828
1829 status = psa_internal_export_key( slot, data, data_size, data_length, 0 );
Ronald Cron5c522922020-11-14 16:35:34 +01001830 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001831
Ronald Cron5c522922020-11-14 16:35:34 +01001832 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001833}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001834
Ronald Croncf56a0a2020-08-04 09:51:30 +02001835psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001836 uint8_t *data,
1837 size_t data_size,
1838 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001839{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001840 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001841 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001842 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001843
1844 /* Set the key to empty now, so that even when there are errors, we always
1845 * set data_length to a value between 0 and data_size. On error, setting
1846 * the key to empty is a good choice because an empty key representation is
1847 * unlikely to be accepted anywhere. */
1848 *data_length = 0;
1849
1850 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001851 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001852 if( status != PSA_SUCCESS )
1853 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001854
1855 status = psa_internal_export_key( slot, data, data_size, data_length, 1 );
Ronald Cron5c522922020-11-14 16:35:34 +01001856 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001857
Ronald Cron5c522922020-11-14 16:35:34 +01001858 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001859}
1860
Gilles Peskine91e8c332019-08-02 19:19:39 +02001861#if defined(static_assert)
1862static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1863 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001864static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001865 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001866static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001867 "One or more key attribute flag is listed as both internal-only and external-only" );
1868#endif
1869
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001870/** Validate that a key policy is internally well-formed.
1871 *
1872 * This function only rejects invalid policies. It does not validate the
1873 * consistency of the policy with respect to other attributes of the key
1874 * such as the key type.
1875 */
1876static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001877{
1878 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001879 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 PSA_KEY_USAGE_ENCRYPT |
1881 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001882 PSA_KEY_USAGE_SIGN_HASH |
1883 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1885 return( PSA_ERROR_INVALID_ARGUMENT );
1886
Gilles Peskine4747d192019-04-17 15:05:45 +02001887 return( PSA_SUCCESS );
1888}
1889
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001890/** Validate the internal consistency of key attributes.
1891 *
1892 * This function only rejects invalid attribute values. If does not
1893 * validate the consistency of the attributes with any key data that may
1894 * be involved in the creation of the key.
1895 *
1896 * Call this function early in the key creation process.
1897 *
1898 * \param[in] attributes Key attributes for the new key.
1899 * \param[out] p_drv On any return, the driver for the key, if any.
1900 * NULL for a transparent key.
1901 *
1902 */
1903static psa_status_t psa_validate_key_attributes(
1904 const psa_key_attributes_t *attributes,
1905 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001906{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001907 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001908 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001909 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001910
Ronald Cron54b90082020-10-29 15:26:43 +01001911 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001912 if( status != PSA_SUCCESS )
1913 return( status );
1914
Ronald Crond2ed4812020-07-17 16:11:30 +02001915 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001916 if( status != PSA_SUCCESS )
1917 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001918
Ronald Cron65f38a32020-10-23 17:11:13 +02001919 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1920 {
1921 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1922 return( PSA_ERROR_INVALID_ARGUMENT );
1923 }
1924 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001925 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001926 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001927 if( status != PSA_SUCCESS )
1928 return( status );
1929 }
1930
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001931 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001932 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001933 return( status );
1934
1935 /* Refuse to create overly large keys.
1936 * Note that this doesn't trigger on import if the attributes don't
1937 * explicitly specify a size (so psa_get_key_bits returns 0), so
1938 * psa_import_key() needs its own checks. */
1939 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1940 return( PSA_ERROR_NOT_SUPPORTED );
1941
Gilles Peskine91e8c332019-08-02 19:19:39 +02001942 /* Reject invalid flags. These should not be reachable through the API. */
1943 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1944 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1945 return( PSA_ERROR_INVALID_ARGUMENT );
1946
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001947 return( PSA_SUCCESS );
1948}
1949
Gilles Peskine4747d192019-04-17 15:05:45 +02001950/** Prepare a key slot to receive key material.
1951 *
1952 * This function allocates a key slot and sets its metadata.
1953 *
1954 * If this function fails, call psa_fail_key_creation().
1955 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001956 * This function is intended to be used as follows:
1957 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001958 * it with the specified attributes, and in case of a volatile key assign it
1959 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001960 * -# Populate the slot with the key material.
1961 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1962 * In case of failure at any step, stop the sequence and call
1963 * psa_fail_key_creation().
1964 *
Ronald Cron5c522922020-11-14 16:35:34 +01001965 * On success, the key slot is locked. It is the responsibility of the caller
1966 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001967 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001968 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001969 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001970 * \param[out] p_slot On success, a pointer to the prepared slot.
1971 * \param[out] p_drv On any return, the driver for the key, if any.
1972 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001973 *
1974 * \retval #PSA_SUCCESS
1975 * The key slot is ready to receive key material.
1976 * \return If this function fails, the key slot is an invalid state.
1977 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001978 */
1979static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001980 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001981 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001982 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001983 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001984{
1985 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001986 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001987 psa_key_slot_t *slot;
1988
Gilles Peskinedf179142019-07-15 22:02:14 +02001989 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001990 *p_drv = NULL;
1991
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001992 status = psa_validate_key_attributes( attributes, p_drv );
1993 if( status != PSA_SUCCESS )
1994 return( status );
1995
Ronald Cronc4d1b512020-07-31 11:26:37 +02001996 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001997 if( status != PSA_SUCCESS )
1998 return( status );
1999 slot = *p_slot;
2000
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002001 /* We're storing the declared bit-size of the key. It's up to each
2002 * creation mechanism to verify that this information is correct.
2003 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02002004 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02002005 * is optional (import, copy). In case of a volatile key, assign it the
2006 * volatile key identifier associated to the slot returned to contain its
2007 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002008
2009 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02002010 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
2011 {
2012#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
2013 slot->attr.id = volatile_key_id;
2014#else
2015 slot->attr.id.key_id = volatile_key_id;
2016#endif
2017 }
Gilles Peskinec744d992019-07-30 17:26:54 +02002018
Gilles Peskine91e8c332019-08-02 19:19:39 +02002019 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02002020 * external-only flags, query `attributes`. Thanks to the check
2021 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02002022 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02002023 * may have set. */
2024 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02002025
Gilles Peskinecbaff462019-07-12 23:46:04 +02002026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002027 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002028 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02002029 * create the key file in internal storage, create the
2030 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002031 * persistent data. This is done by starting a transaction that will
2032 * encompass these three actions.
2033 * For registering a volatile key, we just need to find an appropriate
2034 * slot number inside the SE. Since the key is designated volatile, creating
2035 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02002036 /* The first thing to do is to find a slot number for the new key.
2037 * We save the slot number in persistent storage as part of the
2038 * transaction data. It will be needed to recover if the power
2039 * fails during the key creation process, to clean up on the secure
2040 * element side after restarting. Obtaining a slot number from the
2041 * secure element driver updates its persistent state, but we do not yet
2042 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02002043 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002044 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00002045 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02002046 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02002047 &slot->data.se.slot_number );
2048 if( status != PSA_SUCCESS )
2049 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002050
2051 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02002052 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002053 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
2054 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
2055 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
2056 psa_crypto_transaction.key.id = slot->attr.id;
2057 status = psa_crypto_save_transaction( );
2058 if( status != PSA_SUCCESS )
2059 {
2060 (void) psa_crypto_stop_transaction( );
2061 return( status );
2062 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02002063 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002064 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002065
2066 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
2067 {
2068 /* Key registration only makes sense with a secure element. */
2069 return( PSA_ERROR_INVALID_ARGUMENT );
2070 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02002071#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2072
Ronald Cronc4d1b512020-07-31 11:26:37 +02002073 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00002074}
Gilles Peskine4747d192019-04-17 15:05:45 +02002075
2076/** Finalize the creation of a key once its key material has been set.
2077 *
2078 * This entails writing the key to persistent storage.
2079 *
2080 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002081 * See the documentation of psa_start_key_creation() for the intended use
2082 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002083 *
Ronald Cron5c522922020-11-14 16:35:34 +01002084 * If the finalization succeeds, the function unlocks the key slot (it was
2085 * locked by psa_start_key_creation()) and the key slot cannot be accessed
2086 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01002087 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002088 * \param[in,out] slot Pointer to the slot with key material.
2089 * \param[in] driver The secure element driver for the key,
2090 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01002091 * \param[out] key On success, identifier of the key. Note that the
2092 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002093 *
2094 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002095 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01002096 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
2097 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
2098 * \retval #PSA_ERROR_ALREADY_EXISTS
2099 * \retval #PSA_ERROR_DATA_INVALID
2100 * \retval #PSA_ERROR_DATA_CORRUPT
2101 * \retval #PSA_ERROR_INVALID_ARGUMENT
2102 * \retval #PSA_ERROR_DOES_NOT_EXIST
2103 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002104 * \return If this function fails, the key slot is an invalid state.
2105 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002106 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002107static psa_status_t psa_finish_key_creation(
2108 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002109 psa_se_drv_table_entry_t *driver,
2110 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002111{
2112 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002113 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002114 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002115
2116#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02002117 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02002118 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002119#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2120 if( driver != NULL )
2121 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002122 psa_se_key_data_storage_t data;
2123#if defined(static_assert)
2124 static_assert( sizeof( slot->data.se.slot_number ) ==
2125 sizeof( data.slot_number ),
2126 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002127#endif
2128 memcpy( &data.slot_number, &slot->data.se.slot_number,
2129 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002130 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002131 (uint8_t*) &data,
2132 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002133 }
2134 else
2135#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2136 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002137 /* Key material is saved in export representation in the slot, so
2138 * just pass the slot buffer for storage. */
2139 status = psa_save_persistent_key( &slot->attr,
2140 slot->data.key.data,
2141 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002142 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002143 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002144#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2145
Gilles Peskinecbaff462019-07-12 23:46:04 +02002146#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002147 /* Finish the transaction for a key creation. This does not
2148 * happen when registering an existing key. Detect this case
2149 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002150 * creation of a persistent key in a secure element requires a transaction,
2151 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002152 if( driver != NULL &&
2153 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002154 {
2155 status = psa_save_se_persistent_data( driver );
2156 if( status != PSA_SUCCESS )
2157 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002158 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002159 return( status );
2160 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002161 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002162 }
2163#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2164
Ronald Cron50972942020-11-14 11:28:25 +01002165 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01002166 {
2167 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01002168 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01002169 if( status != PSA_SUCCESS )
2170 *key = MBEDTLS_SVC_KEY_ID_INIT;
2171 }
Ronald Cron50972942020-11-14 11:28:25 +01002172
Gilles Peskine4747d192019-04-17 15:05:45 +02002173 return( status );
2174}
2175
2176/** Abort the creation of a key.
2177 *
2178 * You may call this function after calling psa_start_key_creation(),
2179 * or after psa_finish_key_creation() fails. In other circumstances, this
2180 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002181 * See the documentation of psa_start_key_creation() for the intended use
2182 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002183 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002184 * \param[in,out] slot Pointer to the slot with key material.
2185 * \param[in] driver The secure element driver for the key,
2186 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002187 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002188static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002189 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002190{
Gilles Peskine011e4282019-06-26 18:34:38 +02002191 (void) driver;
2192
Gilles Peskine4747d192019-04-17 15:05:45 +02002193 if( slot == NULL )
2194 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002195
2196#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002197 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002198 * element, and the failure happened later (when saving metadata
2199 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002200 * element.
2201 * https://github.com/ARMmbed/mbed-crypto/issues/217
2202 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002203
Gilles Peskined7729582019-08-05 15:55:54 +02002204 /* Abort the ongoing transaction if any (there may not be one if
2205 * the creation process failed before starting one, or if the
2206 * key creation is a registration of a key in a secure element).
2207 * Earlier functions must already have done what it takes to undo any
2208 * partial creation. All that's left is to update the transaction data
2209 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002210 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002211#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2212
Gilles Peskine4747d192019-04-17 15:05:45 +02002213 psa_wipe_key_slot( slot );
2214}
2215
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002216/** Validate optional attributes during key creation.
2217 *
2218 * Some key attributes are optional during key creation. If they are
2219 * specified in the attributes structure, check that they are consistent
2220 * with the data in the slot.
2221 *
2222 * This function should be called near the end of key creation, after
2223 * the slot in memory is fully populated but before saving persistent data.
2224 */
2225static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002226 const psa_key_slot_t *slot,
2227 const psa_key_attributes_t *attributes )
2228{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002229 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002230 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002231 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002232 return( PSA_ERROR_INVALID_ARGUMENT );
2233 }
2234
2235 if( attributes->domain_parameters_size != 0 )
2236 {
John Durkop0e005192020-10-31 22:06:54 -07002237#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
2238 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02002239 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002240 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002241 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002242 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002243 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002244
Steven Cooreman7f391872020-07-30 14:57:44 +02002245 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002246 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002247 slot->data.key.data,
2248 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002249 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002250 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002251 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002252
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002253 mbedtls_mpi_init( &actual );
2254 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002255 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002256 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002257 mbedtls_rsa_free( rsa );
2258 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002259 if( ret != 0 )
2260 goto rsa_exit;
2261 ret = mbedtls_mpi_read_binary( &required,
2262 attributes->domain_parameters,
2263 attributes->domain_parameters_size );
2264 if( ret != 0 )
2265 goto rsa_exit;
2266 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2267 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2268 rsa_exit:
2269 mbedtls_mpi_free( &actual );
2270 mbedtls_mpi_free( &required );
2271 if( ret != 0)
2272 return( mbedtls_to_psa_error( ret ) );
2273 }
2274 else
John Durkop9814fa22020-11-04 12:28:15 -08002275#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
2276 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002277 {
2278 return( PSA_ERROR_INVALID_ARGUMENT );
2279 }
2280 }
2281
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002282 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002283 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002284 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002285 return( PSA_ERROR_INVALID_ARGUMENT );
2286 }
2287
2288 return( PSA_SUCCESS );
2289}
2290
Gilles Peskine4747d192019-04-17 15:05:45 +02002291psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002292 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002293 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002294 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002295{
2296 psa_status_t status;
2297 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002298 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002299
Ronald Cron81709fc2020-11-14 12:10:32 +01002300 *key = MBEDTLS_SVC_KEY_ID_INIT;
2301
Gilles Peskine0f84d622019-09-12 19:03:13 +02002302 /* Reject zero-length symmetric keys (including raw data key objects).
2303 * This also rejects any key which might be encoded as an empty string,
2304 * which is never valid. */
2305 if( data_length == 0 )
2306 return( PSA_ERROR_INVALID_ARGUMENT );
2307
Gilles Peskinedf179142019-07-15 22:02:14 +02002308 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002309 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002310 if( status != PSA_SUCCESS )
2311 goto exit;
2312
Gilles Peskine5d309672019-07-12 23:47:28 +02002313#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2314 if( driver != NULL )
2315 {
2316 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002317 /* The driver should set the number of key bits, however in
2318 * case it doesn't, we initialize bits to an invalid value. */
2319 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002320 if( drv->key_management == NULL ||
2321 drv->key_management->p_import == NULL )
2322 {
2323 status = PSA_ERROR_NOT_SUPPORTED;
2324 goto exit;
2325 }
2326 status = drv->key_management->p_import(
2327 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002328 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002329 &bits );
2330 if( status != PSA_SUCCESS )
2331 goto exit;
2332 if( bits > PSA_MAX_KEY_BITS )
2333 {
2334 status = PSA_ERROR_NOT_SUPPORTED;
2335 goto exit;
2336 }
2337 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002338 }
2339 else
2340#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2341 {
2342 status = psa_import_key_into_slot( slot, data, data_length );
2343 if( status != PSA_SUCCESS )
2344 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002345 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002346 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002347 if( status != PSA_SUCCESS )
2348 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002349
Ronald Cron81709fc2020-11-14 12:10:32 +01002350 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002351exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002352 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002353 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002354
Gilles Peskine4747d192019-04-17 15:05:45 +02002355 return( status );
2356}
2357
Gilles Peskined7729582019-08-05 15:55:54 +02002358#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2359psa_status_t mbedtls_psa_register_se_key(
2360 const psa_key_attributes_t *attributes )
2361{
2362 psa_status_t status;
2363 psa_key_slot_t *slot = NULL;
2364 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002365 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002366
2367 /* Leaving attributes unspecified is not currently supported.
2368 * It could make sense to query the key type and size from the
2369 * secure element, but not all secure elements support this
2370 * and the driver HAL doesn't currently support it. */
2371 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2372 return( PSA_ERROR_NOT_SUPPORTED );
2373 if( psa_get_key_bits( attributes ) == 0 )
2374 return( PSA_ERROR_NOT_SUPPORTED );
2375
2376 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002377 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002378 if( status != PSA_SUCCESS )
2379 goto exit;
2380
Ronald Cron81709fc2020-11-14 12:10:32 +01002381 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002382
2383exit:
2384 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002385 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002386
Gilles Peskined7729582019-08-05 15:55:54 +02002387 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002388 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002389 return( status );
2390}
2391#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2392
Gilles Peskinef603c712019-01-19 13:40:11 +01002393static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002394 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002395{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002396 psa_status_t status = psa_copy_key_material_into_slot( target,
2397 source->data.key.data,
2398 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002399 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002400 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002401
Steven Cooreman398aee52020-10-13 14:35:45 +02002402 target->attr.type = source->attr.type;
2403 target->attr.bits = source->attr.bits;
2404
2405 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002406}
2407
Ronald Croncf56a0a2020-08-04 09:51:30 +02002408psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002409 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002410 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002411{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002413 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002414 psa_key_slot_t *source_slot = NULL;
2415 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002416 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002417 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002418
Ronald Cron81709fc2020-11-14 12:10:32 +01002419 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2420
Ronald Cron5c522922020-11-14 16:35:34 +01002421 status = psa_get_and_lock_transparent_key_slot_with_policy(
2422 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002423 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002424 goto exit;
2425
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002426 status = psa_validate_optional_attributes( source_slot,
2427 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002428 if( status != PSA_SUCCESS )
2429 goto exit;
2430
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002431 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002432 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002433 if( status != PSA_SUCCESS )
2434 goto exit;
2435
Ronald Cron81709fc2020-11-14 12:10:32 +01002436 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2437 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002438 if( status != PSA_SUCCESS )
2439 goto exit;
2440
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002441#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2442 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002443 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002444 /* Copying to a secure element is not implemented yet. */
2445 status = PSA_ERROR_NOT_SUPPORTED;
2446 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002447 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002448#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002449
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002450 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002451 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002452 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002453
Ronald Cron81709fc2020-11-14 12:10:32 +01002454 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002455exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002456 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002457 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002458
Ronald Cron5c522922020-11-14 16:35:34 +01002459 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002460
Ronald Cron5c522922020-11-14 16:35:34 +01002461 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002462}
2463
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002464
2465
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002466/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002467/* Message digests */
2468/****************************************************************/
2469
John Durkop07cc04a2020-11-16 22:08:34 -08002470#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002471 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2472 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002473 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002474static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002475{
2476 switch( alg )
2477 {
2478#if defined(MBEDTLS_MD2_C)
2479 case PSA_ALG_MD2:
2480 return( &mbedtls_md2_info );
2481#endif
2482#if defined(MBEDTLS_MD4_C)
2483 case PSA_ALG_MD4:
2484 return( &mbedtls_md4_info );
2485#endif
2486#if defined(MBEDTLS_MD5_C)
2487 case PSA_ALG_MD5:
2488 return( &mbedtls_md5_info );
2489#endif
2490#if defined(MBEDTLS_RIPEMD160_C)
2491 case PSA_ALG_RIPEMD160:
2492 return( &mbedtls_ripemd160_info );
2493#endif
2494#if defined(MBEDTLS_SHA1_C)
2495 case PSA_ALG_SHA_1:
2496 return( &mbedtls_sha1_info );
2497#endif
2498#if defined(MBEDTLS_SHA256_C)
2499 case PSA_ALG_SHA_224:
2500 return( &mbedtls_sha224_info );
2501 case PSA_ALG_SHA_256:
2502 return( &mbedtls_sha256_info );
2503#endif
2504#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002505#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002506 case PSA_ALG_SHA_384:
2507 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002508#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002509 case PSA_ALG_SHA_512:
2510 return( &mbedtls_sha512_info );
2511#endif
2512 default:
2513 return( NULL );
2514 }
2515}
John Durkop07cc04a2020-11-16 22:08:34 -08002516#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002517 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2518 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2519 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002520
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002521psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2522{
2523 switch( operation->alg )
2524 {
Gilles Peskine81736312018-06-26 15:04:31 +02002525 case 0:
2526 /* The object has (apparently) been initialized but it is not
2527 * in use. It's ok to call abort on such an object, and there's
2528 * nothing to do. */
2529 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002530#if defined(MBEDTLS_MD2_C)
2531 case PSA_ALG_MD2:
2532 mbedtls_md2_free( &operation->ctx.md2 );
2533 break;
2534#endif
2535#if defined(MBEDTLS_MD4_C)
2536 case PSA_ALG_MD4:
2537 mbedtls_md4_free( &operation->ctx.md4 );
2538 break;
2539#endif
2540#if defined(MBEDTLS_MD5_C)
2541 case PSA_ALG_MD5:
2542 mbedtls_md5_free( &operation->ctx.md5 );
2543 break;
2544#endif
2545#if defined(MBEDTLS_RIPEMD160_C)
2546 case PSA_ALG_RIPEMD160:
2547 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2548 break;
2549#endif
2550#if defined(MBEDTLS_SHA1_C)
2551 case PSA_ALG_SHA_1:
2552 mbedtls_sha1_free( &operation->ctx.sha1 );
2553 break;
2554#endif
2555#if defined(MBEDTLS_SHA256_C)
2556 case PSA_ALG_SHA_224:
2557 case PSA_ALG_SHA_256:
2558 mbedtls_sha256_free( &operation->ctx.sha256 );
2559 break;
2560#endif
2561#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002562#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002563 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002564#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002565 case PSA_ALG_SHA_512:
2566 mbedtls_sha512_free( &operation->ctx.sha512 );
2567 break;
2568#endif
2569 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002570 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002571 }
2572 operation->alg = 0;
2573 return( PSA_SUCCESS );
2574}
2575
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002576psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002577 psa_algorithm_t alg )
2578{
Janos Follath24eed8d2019-11-22 13:21:35 +00002579 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002580
2581 /* A context must be freshly initialized before it can be set up. */
2582 if( operation->alg != 0 )
2583 {
2584 return( PSA_ERROR_BAD_STATE );
2585 }
2586
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002587 switch( alg )
2588 {
2589#if defined(MBEDTLS_MD2_C)
2590 case PSA_ALG_MD2:
2591 mbedtls_md2_init( &operation->ctx.md2 );
2592 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2593 break;
2594#endif
2595#if defined(MBEDTLS_MD4_C)
2596 case PSA_ALG_MD4:
2597 mbedtls_md4_init( &operation->ctx.md4 );
2598 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2599 break;
2600#endif
2601#if defined(MBEDTLS_MD5_C)
2602 case PSA_ALG_MD5:
2603 mbedtls_md5_init( &operation->ctx.md5 );
2604 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2605 break;
2606#endif
2607#if defined(MBEDTLS_RIPEMD160_C)
2608 case PSA_ALG_RIPEMD160:
2609 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2610 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2611 break;
2612#endif
2613#if defined(MBEDTLS_SHA1_C)
2614 case PSA_ALG_SHA_1:
2615 mbedtls_sha1_init( &operation->ctx.sha1 );
2616 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2617 break;
2618#endif
2619#if defined(MBEDTLS_SHA256_C)
2620 case PSA_ALG_SHA_224:
2621 mbedtls_sha256_init( &operation->ctx.sha256 );
2622 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2623 break;
2624 case PSA_ALG_SHA_256:
2625 mbedtls_sha256_init( &operation->ctx.sha256 );
2626 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2627 break;
2628#endif
2629#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002630#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002631 case PSA_ALG_SHA_384:
2632 mbedtls_sha512_init( &operation->ctx.sha512 );
2633 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2634 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002635#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002636 case PSA_ALG_SHA_512:
2637 mbedtls_sha512_init( &operation->ctx.sha512 );
2638 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2639 break;
2640#endif
2641 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002642 return( PSA_ALG_IS_HASH( alg ) ?
2643 PSA_ERROR_NOT_SUPPORTED :
2644 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002645 }
2646 if( ret == 0 )
2647 operation->alg = alg;
2648 else
2649 psa_hash_abort( operation );
2650 return( mbedtls_to_psa_error( ret ) );
2651}
2652
2653psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2654 const uint8_t *input,
2655 size_t input_length )
2656{
Janos Follath24eed8d2019-11-22 13:21:35 +00002657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002658
2659 /* Don't require hash implementations to behave correctly on a
2660 * zero-length input, which may have an invalid pointer. */
2661 if( input_length == 0 )
2662 return( PSA_SUCCESS );
2663
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002664 switch( operation->alg )
2665 {
2666#if defined(MBEDTLS_MD2_C)
2667 case PSA_ALG_MD2:
2668 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2669 input, input_length );
2670 break;
2671#endif
2672#if defined(MBEDTLS_MD4_C)
2673 case PSA_ALG_MD4:
2674 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2675 input, input_length );
2676 break;
2677#endif
2678#if defined(MBEDTLS_MD5_C)
2679 case PSA_ALG_MD5:
2680 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2681 input, input_length );
2682 break;
2683#endif
2684#if defined(MBEDTLS_RIPEMD160_C)
2685 case PSA_ALG_RIPEMD160:
2686 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2687 input, input_length );
2688 break;
2689#endif
2690#if defined(MBEDTLS_SHA1_C)
2691 case PSA_ALG_SHA_1:
2692 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2693 input, input_length );
2694 break;
2695#endif
2696#if defined(MBEDTLS_SHA256_C)
2697 case PSA_ALG_SHA_224:
2698 case PSA_ALG_SHA_256:
2699 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2700 input, input_length );
2701 break;
2702#endif
2703#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002704#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002705 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002706#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002707 case PSA_ALG_SHA_512:
2708 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2709 input, input_length );
2710 break;
2711#endif
2712 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002713 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002714 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002715
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002716 if( ret != 0 )
2717 psa_hash_abort( operation );
2718 return( mbedtls_to_psa_error( ret ) );
2719}
2720
2721psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2722 uint8_t *hash,
2723 size_t hash_size,
2724 size_t *hash_length )
2725{
itayzafrir40835d42018-08-02 13:14:17 +03002726 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002727 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002728 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002729
2730 /* Fill the output buffer with something that isn't a valid hash
2731 * (barring an attack on the hash and deliberately-crafted input),
2732 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002733 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002734 /* If hash_size is 0 then hash may be NULL and then the
2735 * call to memset would have undefined behavior. */
2736 if( hash_size != 0 )
2737 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002738
2739 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002740 {
2741 status = PSA_ERROR_BUFFER_TOO_SMALL;
2742 goto exit;
2743 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002744
2745 switch( operation->alg )
2746 {
2747#if defined(MBEDTLS_MD2_C)
2748 case PSA_ALG_MD2:
2749 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2750 break;
2751#endif
2752#if defined(MBEDTLS_MD4_C)
2753 case PSA_ALG_MD4:
2754 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2755 break;
2756#endif
2757#if defined(MBEDTLS_MD5_C)
2758 case PSA_ALG_MD5:
2759 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2760 break;
2761#endif
2762#if defined(MBEDTLS_RIPEMD160_C)
2763 case PSA_ALG_RIPEMD160:
2764 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2765 break;
2766#endif
2767#if defined(MBEDTLS_SHA1_C)
2768 case PSA_ALG_SHA_1:
2769 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2770 break;
2771#endif
2772#if defined(MBEDTLS_SHA256_C)
2773 case PSA_ALG_SHA_224:
2774 case PSA_ALG_SHA_256:
2775 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2776 break;
2777#endif
2778#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002779#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002780 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002781#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002782 case PSA_ALG_SHA_512:
2783 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2784 break;
2785#endif
2786 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002787 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002788 }
itayzafrir40835d42018-08-02 13:14:17 +03002789 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002790
itayzafrir40835d42018-08-02 13:14:17 +03002791exit:
2792 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002793 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002794 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002795 return( psa_hash_abort( operation ) );
2796 }
2797 else
2798 {
2799 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002800 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002801 }
2802}
2803
Gilles Peskine2d277862018-06-18 15:41:12 +02002804psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2805 const uint8_t *hash,
2806 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002807{
2808 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2809 size_t actual_hash_length;
2810 psa_status_t status = psa_hash_finish( operation,
2811 actual_hash, sizeof( actual_hash ),
2812 &actual_hash_length );
2813 if( status != PSA_SUCCESS )
2814 return( status );
2815 if( actual_hash_length != hash_length )
2816 return( PSA_ERROR_INVALID_SIGNATURE );
2817 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2818 return( PSA_ERROR_INVALID_SIGNATURE );
2819 return( PSA_SUCCESS );
2820}
2821
Gilles Peskine0a749c82019-11-28 19:33:58 +01002822psa_status_t psa_hash_compute( psa_algorithm_t alg,
2823 const uint8_t *input, size_t input_length,
2824 uint8_t *hash, size_t hash_size,
2825 size_t *hash_length )
2826{
2827 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2828 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2829
2830 *hash_length = hash_size;
2831 status = psa_hash_setup( &operation, alg );
2832 if( status != PSA_SUCCESS )
2833 goto exit;
2834 status = psa_hash_update( &operation, input, input_length );
2835 if( status != PSA_SUCCESS )
2836 goto exit;
2837 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2838 if( status != PSA_SUCCESS )
2839 goto exit;
2840
2841exit:
2842 if( status == PSA_SUCCESS )
2843 status = psa_hash_abort( &operation );
2844 else
2845 psa_hash_abort( &operation );
2846 return( status );
2847}
2848
2849psa_status_t psa_hash_compare( psa_algorithm_t alg,
2850 const uint8_t *input, size_t input_length,
2851 const uint8_t *hash, size_t hash_length )
2852{
2853 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2855
2856 status = psa_hash_setup( &operation, alg );
2857 if( status != PSA_SUCCESS )
2858 goto exit;
2859 status = psa_hash_update( &operation, input, input_length );
2860 if( status != PSA_SUCCESS )
2861 goto exit;
2862 status = psa_hash_verify( &operation, hash, hash_length );
2863 if( status != PSA_SUCCESS )
2864 goto exit;
2865
2866exit:
2867 if( status == PSA_SUCCESS )
2868 status = psa_hash_abort( &operation );
2869 else
2870 psa_hash_abort( &operation );
2871 return( status );
2872}
2873
Gilles Peskineeb35d782019-01-22 17:56:16 +01002874psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2875 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002876{
2877 if( target_operation->alg != 0 )
2878 return( PSA_ERROR_BAD_STATE );
2879
2880 switch( source_operation->alg )
2881 {
2882 case 0:
2883 return( PSA_ERROR_BAD_STATE );
2884#if defined(MBEDTLS_MD2_C)
2885 case PSA_ALG_MD2:
2886 mbedtls_md2_clone( &target_operation->ctx.md2,
2887 &source_operation->ctx.md2 );
2888 break;
2889#endif
2890#if defined(MBEDTLS_MD4_C)
2891 case PSA_ALG_MD4:
2892 mbedtls_md4_clone( &target_operation->ctx.md4,
2893 &source_operation->ctx.md4 );
2894 break;
2895#endif
2896#if defined(MBEDTLS_MD5_C)
2897 case PSA_ALG_MD5:
2898 mbedtls_md5_clone( &target_operation->ctx.md5,
2899 &source_operation->ctx.md5 );
2900 break;
2901#endif
2902#if defined(MBEDTLS_RIPEMD160_C)
2903 case PSA_ALG_RIPEMD160:
2904 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2905 &source_operation->ctx.ripemd160 );
2906 break;
2907#endif
2908#if defined(MBEDTLS_SHA1_C)
2909 case PSA_ALG_SHA_1:
2910 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2911 &source_operation->ctx.sha1 );
2912 break;
2913#endif
2914#if defined(MBEDTLS_SHA256_C)
2915 case PSA_ALG_SHA_224:
2916 case PSA_ALG_SHA_256:
2917 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2918 &source_operation->ctx.sha256 );
2919 break;
2920#endif
2921#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002922#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002923 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002924#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002925 case PSA_ALG_SHA_512:
2926 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2927 &source_operation->ctx.sha512 );
2928 break;
2929#endif
2930 default:
2931 return( PSA_ERROR_NOT_SUPPORTED );
2932 }
2933
2934 target_operation->alg = source_operation->alg;
2935 return( PSA_SUCCESS );
2936}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002937
2938
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002939/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002940/* MAC */
2941/****************************************************************/
2942
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002943static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002944 psa_algorithm_t alg,
2945 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002946 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002947 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002948{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002949 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002950 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002951
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002952 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002953 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002954
Gilles Peskine8c9def32018-02-08 10:02:12 +01002955 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2956 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002957 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002958 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002959 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002960 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002961 mode = MBEDTLS_MODE_STREAM;
2962 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002963 case PSA_ALG_CTR:
2964 mode = MBEDTLS_MODE_CTR;
2965 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002966 case PSA_ALG_CFB:
2967 mode = MBEDTLS_MODE_CFB;
2968 break;
2969 case PSA_ALG_OFB:
2970 mode = MBEDTLS_MODE_OFB;
2971 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002972 case PSA_ALG_ECB_NO_PADDING:
2973 mode = MBEDTLS_MODE_ECB;
2974 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002975 case PSA_ALG_CBC_NO_PADDING:
2976 mode = MBEDTLS_MODE_CBC;
2977 break;
2978 case PSA_ALG_CBC_PKCS7:
2979 mode = MBEDTLS_MODE_CBC;
2980 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002981 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002982 mode = MBEDTLS_MODE_CCM;
2983 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002984 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002985 mode = MBEDTLS_MODE_GCM;
2986 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002987 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2988 mode = MBEDTLS_MODE_CHACHAPOLY;
2989 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002990 default:
2991 return( NULL );
2992 }
2993 }
2994 else if( alg == PSA_ALG_CMAC )
2995 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002996 else
2997 return( NULL );
2998
2999 switch( key_type )
3000 {
3001 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03003002 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003003 break;
3004 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003005 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
3006 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003007 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03003008 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003009 else
mohammad1603f4f0d612018-06-03 15:04:51 +03003010 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003011 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
3012 * but two-key Triple-DES is functionally three-key Triple-DES
3013 * with K1=K3, so that's how we present it to mbedtls. */
3014 if( key_bits == 128 )
3015 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003016 break;
3017 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03003018 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003019 break;
3020 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03003021 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003022 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02003023 case PSA_KEY_TYPE_CHACHA20:
3024 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
3025 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003026 default:
3027 return( NULL );
3028 }
mohammad1603f4f0d612018-06-03 15:04:51 +03003029 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03003030 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003031
Jaeden Amero23bbb752018-06-26 14:16:54 +01003032 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
3033 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003034}
3035
John Durkop6ba40d12020-11-10 08:50:04 -08003036#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003037static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003038{
Gilles Peskine2d277862018-06-18 15:41:12 +02003039 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003040 {
3041 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003042 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003043 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003044 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003045 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003046 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003047 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003048 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003049 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003050 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003051 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003052 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003053 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003054 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003055 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003056 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003057 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02003058 return( 128 );
3059 default:
3060 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003061 }
3062}
John Durkop07cc04a2020-11-16 22:08:34 -08003063#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03003064
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003065/* Initialize the MAC operation structure. Once this function has been
3066 * called, psa_mac_abort can run and will do the right thing. */
3067static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
3068 psa_algorithm_t alg )
3069{
3070 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
3071
3072 operation->alg = alg;
3073 operation->key_set = 0;
3074 operation->iv_set = 0;
3075 operation->iv_required = 0;
3076 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003077 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003078
3079#if defined(MBEDTLS_CMAC_C)
3080 if( alg == PSA_ALG_CMAC )
3081 {
3082 operation->iv_required = 0;
3083 mbedtls_cipher_init( &operation->ctx.cmac );
3084 status = PSA_SUCCESS;
3085 }
3086 else
3087#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003088#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003089 if( PSA_ALG_IS_HMAC( operation->alg ) )
3090 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02003091 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
3092 operation->ctx.hmac.hash_ctx.alg = 0;
3093 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003094 }
3095 else
John Durkopd0321952020-10-29 21:37:36 -07003096#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003097 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02003098 if( ! PSA_ALG_IS_MAC( alg ) )
3099 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003100 }
3101
3102 if( status != PSA_SUCCESS )
3103 memset( operation, 0, sizeof( *operation ) );
3104 return( status );
3105}
3106
John Durkop6ba40d12020-11-10 08:50:04 -08003107#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003108static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
3109{
Gilles Peskine3f108122018-12-07 18:14:53 +01003110 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003111 return( psa_hash_abort( &hmac->hash_ctx ) );
3112}
John Durkop6ba40d12020-11-10 08:50:04 -08003113#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003114
Gilles Peskine8c9def32018-02-08 10:02:12 +01003115psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
3116{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003117 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003118 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003119 /* The object has (apparently) been initialized but it is not
3120 * in use. It's ok to call abort on such an object, and there's
3121 * nothing to do. */
3122 return( PSA_SUCCESS );
3123 }
3124 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003125#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003126 if( operation->alg == PSA_ALG_CMAC )
3127 {
3128 mbedtls_cipher_free( &operation->ctx.cmac );
3129 }
3130 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003131#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003132#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003133 if( PSA_ALG_IS_HMAC( operation->alg ) )
3134 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003135 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003136 }
3137 else
John Durkopd0321952020-10-29 21:37:36 -07003138#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003139 {
3140 /* Sanity check (shouldn't happen: operation->alg should
3141 * always have been initialized to a valid value). */
3142 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003143 }
Moran Peker41deec42018-04-04 15:43:05 +03003144
Gilles Peskine8c9def32018-02-08 10:02:12 +01003145 operation->alg = 0;
3146 operation->key_set = 0;
3147 operation->iv_set = 0;
3148 operation->iv_required = 0;
3149 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003150 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003151
Gilles Peskine8c9def32018-02-08 10:02:12 +01003152 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003153
3154bad_state:
3155 /* If abort is called on an uninitialized object, we can't trust
3156 * anything. Wipe the object in case it contains confidential data.
3157 * This may result in a memory leak if a pointer gets overwritten,
3158 * but it's too late to do anything about this. */
3159 memset( operation, 0, sizeof( *operation ) );
3160 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003161}
3162
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003163#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003164static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003165 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003166 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003167 const mbedtls_cipher_info_t *cipher_info )
3168{
Janos Follath24eed8d2019-11-22 13:21:35 +00003169 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003170
3171 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003172
3173 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3174 if( ret != 0 )
3175 return( ret );
3176
3177 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003178 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003179 key_bits );
3180 return( ret );
3181}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003182#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003183
John Durkop6ba40d12020-11-10 08:50:04 -08003184#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003185static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3186 const uint8_t *key,
3187 size_t key_length,
3188 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003189{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003190 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003191 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003192 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003193 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003194 psa_status_t status;
3195
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003196 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3197 * overflow below. This should never trigger if the hash algorithm
3198 * is implemented correctly. */
3199 /* The size checks against the ipad and opad buffers cannot be written
3200 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3201 * because that triggers -Wlogical-op on GCC 7.3. */
3202 if( block_size > sizeof( ipad ) )
3203 return( PSA_ERROR_NOT_SUPPORTED );
3204 if( block_size > sizeof( hmac->opad ) )
3205 return( PSA_ERROR_NOT_SUPPORTED );
3206 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003207 return( PSA_ERROR_NOT_SUPPORTED );
3208
Gilles Peskined223b522018-06-11 18:12:58 +02003209 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003210 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003211 status = psa_hash_compute( hash_alg, key, key_length,
3212 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003213 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003214 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003215 }
Gilles Peskine96889972018-07-12 17:07:03 +02003216 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3217 * but it is permitted. It is common when HMAC is used in HKDF, for
3218 * example. Don't call `memcpy` in the 0-length because `key` could be
3219 * an invalid pointer which would make the behavior undefined. */
3220 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003221 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003222
Gilles Peskined223b522018-06-11 18:12:58 +02003223 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3224 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003225 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003226 ipad[i] ^= 0x36;
3227 memset( ipad + key_length, 0x36, block_size - key_length );
3228
3229 /* Copy the key material from ipad to opad, flipping the requisite bits,
3230 * and filling the rest of opad with the requisite constant. */
3231 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003232 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3233 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003234
Gilles Peskine01126fa2018-07-12 17:04:55 +02003235 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003236 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003237 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003238
Gilles Peskine01126fa2018-07-12 17:04:55 +02003239 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003240
3241cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003242 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003243
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003244 return( status );
3245}
John Durkop6ba40d12020-11-10 08:50:04 -08003246#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003247
Gilles Peskine89167cb2018-07-08 20:12:23 +02003248static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003249 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003250 psa_algorithm_t alg,
3251 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003252{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003253 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003254 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003255 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003256 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003257 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003258 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003259 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003260 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003261
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003262 /* A context must be freshly initialized before it can be set up. */
3263 if( operation->alg != 0 )
3264 {
3265 return( PSA_ERROR_BAD_STATE );
3266 }
3267
Gilles Peskined911eb72018-08-14 15:18:45 +02003268 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003269 if( status != PSA_SUCCESS )
3270 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003271 if( is_sign )
3272 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003273
Ronald Cron5c522922020-11-14 16:35:34 +01003274 status = psa_get_and_lock_transparent_key_slot_with_policy(
3275 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003276 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003277 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003278 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003279
Gilles Peskine8c9def32018-02-08 10:02:12 +01003280#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003281 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003282 {
3283 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003284 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003285 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003287 if( cipher_info == NULL )
3288 {
3289 status = PSA_ERROR_NOT_SUPPORTED;
3290 goto exit;
3291 }
3292 operation->mac_size = cipher_info->block_size;
3293 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3294 status = mbedtls_to_psa_error( ret );
3295 }
3296 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003297#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003298#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02003299 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003300 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003301 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003302 if( hash_alg == 0 )
3303 {
3304 status = PSA_ERROR_NOT_SUPPORTED;
3305 goto exit;
3306 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003307
3308 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3309 /* Sanity check. This shouldn't fail on a valid configuration. */
3310 if( operation->mac_size == 0 ||
3311 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3312 {
3313 status = PSA_ERROR_NOT_SUPPORTED;
3314 goto exit;
3315 }
3316
Gilles Peskine8e338702019-07-30 20:06:31 +02003317 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003318 {
3319 status = PSA_ERROR_INVALID_ARGUMENT;
3320 goto exit;
3321 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003322
Gilles Peskine01126fa2018-07-12 17:04:55 +02003323 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003324 slot->data.key.data,
3325 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003326 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003327 }
3328 else
John Durkopd0321952020-10-29 21:37:36 -07003329#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003330 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003331 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003332 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003333 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003334
Gilles Peskined911eb72018-08-14 15:18:45 +02003335 if( truncated == 0 )
3336 {
3337 /* The "normal" case: untruncated algorithm. Nothing to do. */
3338 }
3339 else if( truncated < 4 )
3340 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003341 /* A very short MAC is too short for security since it can be
3342 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3343 * so we make this our minimum, even though 32 bits is still
3344 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003345 status = PSA_ERROR_NOT_SUPPORTED;
3346 }
3347 else if( truncated > operation->mac_size )
3348 {
3349 /* It's impossible to "truncate" to a larger length. */
3350 status = PSA_ERROR_INVALID_ARGUMENT;
3351 }
3352 else
3353 operation->mac_size = truncated;
3354
Gilles Peskinefbfac682018-07-08 20:51:54 +02003355exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003356 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003357 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003358 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003359 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003360 else
3361 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003362 operation->key_set = 1;
3363 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003364
Ronald Cron5c522922020-11-14 16:35:34 +01003365 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003366
Ronald Cron5c522922020-11-14 16:35:34 +01003367 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003368}
3369
Gilles Peskine89167cb2018-07-08 20:12:23 +02003370psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003371 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003372 psa_algorithm_t alg )
3373{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003374 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003375}
3376
3377psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003378 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003379 psa_algorithm_t alg )
3380{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003381 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003382}
3383
Gilles Peskine8c9def32018-02-08 10:02:12 +01003384psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3385 const uint8_t *input,
3386 size_t input_length )
3387{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003388 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003389 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003390 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003391 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003392 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003393 operation->has_input = 1;
3394
Gilles Peskine8c9def32018-02-08 10:02:12 +01003395#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003396 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003397 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003398 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3399 input, input_length );
3400 status = mbedtls_to_psa_error( ret );
3401 }
3402 else
3403#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003404#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003405 if( PSA_ALG_IS_HMAC( operation->alg ) )
3406 {
3407 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3408 input_length );
3409 }
3410 else
John Durkopd0321952020-10-29 21:37:36 -07003411#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003412 {
3413 /* This shouldn't happen if `operation` was initialized by
3414 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003415 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003416 }
3417
Gilles Peskinefbfac682018-07-08 20:51:54 +02003418 if( status != PSA_SUCCESS )
3419 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003420 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003421}
3422
John Durkop6ba40d12020-11-10 08:50:04 -08003423#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003424static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3425 uint8_t *mac,
3426 size_t mac_size )
3427{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003428 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003429 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3430 size_t hash_size = 0;
3431 size_t block_size = psa_get_hash_block_size( hash_alg );
3432 psa_status_t status;
3433
Gilles Peskine01126fa2018-07-12 17:04:55 +02003434 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3435 if( status != PSA_SUCCESS )
3436 return( status );
3437 /* From here on, tmp needs to be wiped. */
3438
3439 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3440 if( status != PSA_SUCCESS )
3441 goto exit;
3442
3443 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3444 if( status != PSA_SUCCESS )
3445 goto exit;
3446
3447 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3448 if( status != PSA_SUCCESS )
3449 goto exit;
3450
Gilles Peskined911eb72018-08-14 15:18:45 +02003451 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3452 if( status != PSA_SUCCESS )
3453 goto exit;
3454
3455 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003456
3457exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003458 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003459 return( status );
3460}
John Durkop6ba40d12020-11-10 08:50:04 -08003461#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003462
mohammad16036df908f2018-04-02 08:34:15 -07003463static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003464 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003465 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003466{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003467 if( ! operation->key_set )
3468 return( PSA_ERROR_BAD_STATE );
3469 if( operation->iv_required && ! operation->iv_set )
3470 return( PSA_ERROR_BAD_STATE );
3471
Gilles Peskine8c9def32018-02-08 10:02:12 +01003472 if( mac_size < operation->mac_size )
3473 return( PSA_ERROR_BUFFER_TOO_SMALL );
3474
Gilles Peskine8c9def32018-02-08 10:02:12 +01003475#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003476 if( operation->alg == PSA_ALG_CMAC )
3477 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003478 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3479 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3480 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003481 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003482 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003483 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003484 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003485 else
3486#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003487#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003488 if( PSA_ALG_IS_HMAC( operation->alg ) )
3489 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003490 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003491 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003492 }
3493 else
John Durkopd0321952020-10-29 21:37:36 -07003494#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003495 {
3496 /* This shouldn't happen if `operation` was initialized by
3497 * a setup function. */
3498 return( PSA_ERROR_BAD_STATE );
3499 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003500}
3501
Gilles Peskineacd4be32018-07-08 19:56:25 +02003502psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3503 uint8_t *mac,
3504 size_t mac_size,
3505 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003506{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003507 psa_status_t status;
3508
Jaeden Amero252ef282019-02-15 14:05:35 +00003509 if( operation->alg == 0 )
3510 {
3511 return( PSA_ERROR_BAD_STATE );
3512 }
3513
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003514 /* Fill the output buffer with something that isn't a valid mac
3515 * (barring an attack on the mac and deliberately-crafted input),
3516 * in case the caller doesn't check the return status properly. */
3517 *mac_length = mac_size;
3518 /* If mac_size is 0 then mac may be NULL and then the
3519 * call to memset would have undefined behavior. */
3520 if( mac_size != 0 )
3521 memset( mac, '!', mac_size );
3522
Gilles Peskine89167cb2018-07-08 20:12:23 +02003523 if( ! operation->is_sign )
3524 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003525 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003526 }
mohammad16036df908f2018-04-02 08:34:15 -07003527
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003528 status = psa_mac_finish_internal( operation, mac, mac_size );
3529
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003530 if( status == PSA_SUCCESS )
3531 {
3532 status = psa_mac_abort( operation );
3533 if( status == PSA_SUCCESS )
3534 *mac_length = operation->mac_size;
3535 else
3536 memset( mac, '!', mac_size );
3537 }
3538 else
3539 psa_mac_abort( operation );
3540 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003541}
3542
Gilles Peskineacd4be32018-07-08 19:56:25 +02003543psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3544 const uint8_t *mac,
3545 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003546{
Gilles Peskine828ed142018-06-18 23:25:51 +02003547 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003548 psa_status_t status;
3549
Jaeden Amero252ef282019-02-15 14:05:35 +00003550 if( operation->alg == 0 )
3551 {
3552 return( PSA_ERROR_BAD_STATE );
3553 }
3554
Gilles Peskine89167cb2018-07-08 20:12:23 +02003555 if( operation->is_sign )
3556 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003557 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003558 }
3559 if( operation->mac_size != mac_length )
3560 {
3561 status = PSA_ERROR_INVALID_SIGNATURE;
3562 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003563 }
mohammad16036df908f2018-04-02 08:34:15 -07003564
3565 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003566 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003567 if( status != PSA_SUCCESS )
3568 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003569
3570 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3571 status = PSA_ERROR_INVALID_SIGNATURE;
3572
3573cleanup:
3574 if( status == PSA_SUCCESS )
3575 status = psa_mac_abort( operation );
3576 else
3577 psa_mac_abort( operation );
3578
Gilles Peskine3f108122018-12-07 18:14:53 +01003579 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003580
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003581 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003582}
3583
3584
Gilles Peskine20035e32018-02-03 22:44:14 +01003585
Gilles Peskine20035e32018-02-03 22:44:14 +01003586/****************************************************************/
3587/* Asymmetric cryptography */
3588/****************************************************************/
3589
John Durkop6ba40d12020-11-10 08:50:04 -08003590#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3591 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003592/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003593 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003594static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3595 size_t hash_length,
3596 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003597{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003598 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003599 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003600 *md_alg = mbedtls_md_get_type( md_info );
3601
3602 /* The Mbed TLS RSA module uses an unsigned int for hash length
3603 * parameters. Validate that it fits so that we don't risk an
3604 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003605#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003606 if( hash_length > UINT_MAX )
3607 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003608#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003609
John Durkop0e005192020-10-31 22:06:54 -07003610#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003611 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3612 * must be correct. */
3613 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3614 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003615 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003616 if( md_info == NULL )
3617 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003618 if( mbedtls_md_get_size( md_info ) != hash_length )
3619 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003620 }
John Durkop0e005192020-10-31 22:06:54 -07003621#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003622
John Durkop0e005192020-10-31 22:06:54 -07003623#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003624 /* PSS requires a hash internally. */
3625 if( PSA_ALG_IS_RSA_PSS( alg ) )
3626 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003627 if( md_info == NULL )
3628 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003629 }
John Durkop0e005192020-10-31 22:06:54 -07003630#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003631
Gilles Peskine61b91d42018-06-08 16:09:36 +02003632 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003633}
3634
Gilles Peskine2b450e32018-06-27 15:42:46 +02003635static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3636 psa_algorithm_t alg,
3637 const uint8_t *hash,
3638 size_t hash_length,
3639 uint8_t *signature,
3640 size_t signature_size,
3641 size_t *signature_length )
3642{
3643 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003644 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003645 mbedtls_md_type_t md_alg;
3646
3647 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3648 if( status != PSA_SUCCESS )
3649 return( status );
3650
Gilles Peskine630a18a2018-06-29 17:49:35 +02003651 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003652 return( PSA_ERROR_BUFFER_TOO_SMALL );
3653
John Durkop0e005192020-10-31 22:06:54 -07003654#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003655 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3656 {
3657 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3658 MBEDTLS_MD_NONE );
3659 ret = mbedtls_rsa_pkcs1_sign( rsa,
3660 mbedtls_ctr_drbg_random,
3661 &global_data.ctr_drbg,
3662 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003663 md_alg,
3664 (unsigned int) hash_length,
3665 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003666 signature );
3667 }
3668 else
John Durkop0e005192020-10-31 22:06:54 -07003669#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3670#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003671 if( PSA_ALG_IS_RSA_PSS( alg ) )
3672 {
3673 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3674 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3675 mbedtls_ctr_drbg_random,
3676 &global_data.ctr_drbg,
3677 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003678 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003679 (unsigned int) hash_length,
3680 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003681 signature );
3682 }
3683 else
John Durkop0e005192020-10-31 22:06:54 -07003684#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003685 {
3686 return( PSA_ERROR_INVALID_ARGUMENT );
3687 }
3688
3689 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003690 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003691 return( mbedtls_to_psa_error( ret ) );
3692}
3693
3694static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3695 psa_algorithm_t alg,
3696 const uint8_t *hash,
3697 size_t hash_length,
3698 const uint8_t *signature,
3699 size_t signature_length )
3700{
3701 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003702 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003703 mbedtls_md_type_t md_alg;
3704
3705 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3706 if( status != PSA_SUCCESS )
3707 return( status );
3708
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003709 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3710 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003711
John Durkop0e005192020-10-31 22:06:54 -07003712#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003713 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3714 {
3715 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3716 MBEDTLS_MD_NONE );
3717 ret = mbedtls_rsa_pkcs1_verify( rsa,
3718 mbedtls_ctr_drbg_random,
3719 &global_data.ctr_drbg,
3720 MBEDTLS_RSA_PUBLIC,
3721 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003722 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003723 hash,
3724 signature );
3725 }
3726 else
John Durkop0e005192020-10-31 22:06:54 -07003727#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3728#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003729 if( PSA_ALG_IS_RSA_PSS( alg ) )
3730 {
3731 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3732 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3733 mbedtls_ctr_drbg_random,
3734 &global_data.ctr_drbg,
3735 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003736 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003737 (unsigned int) hash_length,
3738 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003739 signature );
3740 }
3741 else
John Durkop0e005192020-10-31 22:06:54 -07003742#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003743 {
3744 return( PSA_ERROR_INVALID_ARGUMENT );
3745 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003746
3747 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3748 * the rest of the signature is invalid". This has little use in
3749 * practice and PSA doesn't report this distinction. */
3750 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3751 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003752 return( mbedtls_to_psa_error( ret ) );
3753}
John Durkop6ba40d12020-11-10 08:50:04 -08003754#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3755 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003756
John Durkop6ba40d12020-11-10 08:50:04 -08003757#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3758 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003759/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3760 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3761 * (even though these functions don't modify it). */
3762static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3763 psa_algorithm_t alg,
3764 const uint8_t *hash,
3765 size_t hash_length,
3766 uint8_t *signature,
3767 size_t signature_size,
3768 size_t *signature_length )
3769{
Janos Follath24eed8d2019-11-22 13:21:35 +00003770 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003771 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003772 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003773 mbedtls_mpi_init( &r );
3774 mbedtls_mpi_init( &s );
3775
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003776 if( signature_size < 2 * curve_bytes )
3777 {
3778 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3779 goto cleanup;
3780 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003781
John Durkop0ea39e02020-10-13 19:58:20 -07003782#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003783 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3784 {
3785 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3786 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3787 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003788 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3789 &ecp->d, hash,
3790 hash_length, md_alg,
3791 mbedtls_ctr_drbg_random,
3792 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003793 }
3794 else
John Durkop0ea39e02020-10-13 19:58:20 -07003795#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003796 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003797 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003798 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3799 hash, hash_length,
3800 mbedtls_ctr_drbg_random,
3801 &global_data.ctr_drbg ) );
3802 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003803
3804 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3805 signature,
3806 curve_bytes ) );
3807 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3808 signature + curve_bytes,
3809 curve_bytes ) );
3810
3811cleanup:
3812 mbedtls_mpi_free( &r );
3813 mbedtls_mpi_free( &s );
3814 if( ret == 0 )
3815 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003816 return( mbedtls_to_psa_error( ret ) );
3817}
3818
3819static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3820 const uint8_t *hash,
3821 size_t hash_length,
3822 const uint8_t *signature,
3823 size_t signature_length )
3824{
Janos Follath24eed8d2019-11-22 13:21:35 +00003825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003826 mbedtls_mpi r, s;
3827 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3828 mbedtls_mpi_init( &r );
3829 mbedtls_mpi_init( &s );
3830
3831 if( signature_length != 2 * curve_bytes )
3832 return( PSA_ERROR_INVALID_SIGNATURE );
3833
3834 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3835 signature,
3836 curve_bytes ) );
3837 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3838 signature + curve_bytes,
3839 curve_bytes ) );
3840
Steven Cooremanacda8342020-07-24 23:09:52 +02003841 /* Check whether the public part is loaded. If not, load it. */
3842 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3843 {
3844 MBEDTLS_MPI_CHK(
3845 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3846 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3847 }
3848
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003849 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3850 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003851
3852cleanup:
3853 mbedtls_mpi_free( &r );
3854 mbedtls_mpi_free( &s );
3855 return( mbedtls_to_psa_error( ret ) );
3856}
John Durkop6ba40d12020-11-10 08:50:04 -08003857#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3858 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003859
Ronald Croncf56a0a2020-08-04 09:51:30 +02003860psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003861 psa_algorithm_t alg,
3862 const uint8_t *hash,
3863 size_t hash_length,
3864 uint8_t *signature,
3865 size_t signature_size,
3866 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003867{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003868 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003869 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003870 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003871
3872 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003873 /* Immediately reject a zero-length signature buffer. This guarantees
3874 * that signature must be a valid pointer. (On the other hand, the hash
3875 * buffer can in principle be empty since it doesn't actually have
3876 * to be a hash.) */
3877 if( signature_size == 0 )
3878 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003879
Ronald Cron5c522922020-11-14 16:35:34 +01003880 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3881 PSA_KEY_USAGE_SIGN_HASH,
3882 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003883 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003884 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003885 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003886 {
3887 status = PSA_ERROR_INVALID_ARGUMENT;
3888 goto exit;
3889 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003890
Steven Cooremancd84cb42020-07-16 20:28:36 +02003891 /* Try any of the available accelerators first */
3892 status = psa_driver_wrapper_sign_hash( slot,
3893 alg,
3894 hash,
3895 hash_length,
3896 signature,
3897 signature_size,
3898 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003899 if( status != PSA_ERROR_NOT_SUPPORTED ||
3900 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003901 goto exit;
3902
Steven Cooreman7a250572020-07-17 16:43:05 +02003903 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003904#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3905 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003906 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003907 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003908 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003909
Steven Cooreman4fed4552020-08-03 14:46:03 +02003910 status = psa_load_rsa_representation( slot->attr.type,
3911 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003912 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003913 &rsa );
3914 if( status != PSA_SUCCESS )
3915 goto exit;
3916
Steven Cooremana2371e52020-07-28 14:30:39 +02003917 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003918 alg,
3919 hash, hash_length,
3920 signature, signature_size,
3921 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003922
Steven Cooremana2371e52020-07-28 14:30:39 +02003923 mbedtls_rsa_free( rsa );
3924 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003925 }
3926 else
John Durkop6ba40d12020-11-10 08:50:04 -08003927#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3928 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003929 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003930 {
John Durkop9814fa22020-11-04 12:28:15 -08003931#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3932 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003933 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003934#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003935 PSA_ALG_IS_ECDSA( alg )
3936#else
3937 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3938#endif
3939 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003940 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003941 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003942 status = psa_load_ecp_representation( slot->attr.type,
3943 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003944 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003945 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003946 if( status != PSA_SUCCESS )
3947 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003948 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003949 alg,
3950 hash, hash_length,
3951 signature, signature_size,
3952 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003953 mbedtls_ecp_keypair_free( ecp );
3954 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003955 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003956 else
John Durkop9814fa22020-11-04 12:28:15 -08003957#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3958 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003959 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003960 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003961 }
itayzafrir5c753392018-05-08 11:18:38 +03003962 }
3963 else
itayzafrir5c753392018-05-08 11:18:38 +03003964 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003965 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003966 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003967
3968exit:
3969 /* Fill the unused part of the output buffer (the whole buffer on error,
3970 * the trailing part on success) with something that isn't a valid mac
3971 * (barring an attack on the mac and deliberately-crafted input),
3972 * in case the caller doesn't check the return status properly. */
3973 if( status == PSA_SUCCESS )
3974 memset( signature + *signature_length, '!',
3975 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003976 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003977 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003978 /* If signature_size is 0 then we have nothing to do. We must not call
3979 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003980
Ronald Cron5c522922020-11-14 16:35:34 +01003981 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003982
Ronald Cron5c522922020-11-14 16:35:34 +01003983 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003984}
3985
Ronald Croncf56a0a2020-08-04 09:51:30 +02003986psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003987 psa_algorithm_t alg,
3988 const uint8_t *hash,
3989 size_t hash_length,
3990 const uint8_t *signature,
3991 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003992{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003993 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003994 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003995 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003996
Ronald Cron5c522922020-11-14 16:35:34 +01003997 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3998 PSA_KEY_USAGE_VERIFY_HASH,
3999 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004000 if( status != PSA_SUCCESS )
4001 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03004002
Steven Cooreman55ae2172020-07-17 19:46:15 +02004003 /* Try any of the available accelerators first */
4004 status = psa_driver_wrapper_verify_hash( slot,
4005 alg,
4006 hash,
4007 hash_length,
4008 signature,
4009 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02004010 if( status != PSA_ERROR_NOT_SUPPORTED ||
4011 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004012 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02004013
John Durkop6ba40d12020-11-10 08:50:04 -08004014#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
4015 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02004016 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004017 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004018 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02004019
Steven Cooreman4fed4552020-08-03 14:46:03 +02004020 status = psa_load_rsa_representation( slot->attr.type,
4021 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004022 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004023 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004024 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004025 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004026
Steven Cooremana2371e52020-07-28 14:30:39 +02004027 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02004028 alg,
4029 hash, hash_length,
4030 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004031 mbedtls_rsa_free( rsa );
4032 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004033 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004034 }
4035 else
John Durkop6ba40d12020-11-10 08:50:04 -08004036#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
4037 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02004038 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03004039 {
John Durkop9814fa22020-11-04 12:28:15 -08004040#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4041 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004042 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02004043 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004044 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004045 status = psa_load_ecp_representation( slot->attr.type,
4046 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004047 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004048 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004049 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004050 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004051 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004052 hash, hash_length,
4053 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004054 mbedtls_ecp_keypair_free( ecp );
4055 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004056 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02004057 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004058 else
John Durkop9814fa22020-11-04 12:28:15 -08004059#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4060 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004061 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004062 status = PSA_ERROR_INVALID_ARGUMENT;
4063 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004064 }
itayzafrir5c753392018-05-08 11:18:38 +03004065 }
Gilles Peskine20035e32018-02-03 22:44:14 +01004066 else
Gilles Peskine20035e32018-02-03 22:44:14 +01004067 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004068 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01004069 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004070
4071exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004072 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004073
Ronald Cron5c522922020-11-14 16:35:34 +01004074 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01004075}
4076
John Durkop0e005192020-10-31 22:06:54 -07004077#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02004078static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
4079 mbedtls_rsa_context *rsa )
4080{
4081 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
4082 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
4083 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
4084 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
4085}
John Durkop0e005192020-10-31 22:06:54 -07004086#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02004087
Ronald Croncf56a0a2020-08-04 09:51:30 +02004088psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004089 psa_algorithm_t alg,
4090 const uint8_t *input,
4091 size_t input_length,
4092 const uint8_t *salt,
4093 size_t salt_length,
4094 uint8_t *output,
4095 size_t output_size,
4096 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004097{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004098 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004099 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004100 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004101
Darryl Green5cc689a2018-07-24 15:34:10 +01004102 (void) input;
4103 (void) input_length;
4104 (void) salt;
4105 (void) output;
4106 (void) output_size;
4107
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004108 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004109
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004110 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4111 return( PSA_ERROR_INVALID_ARGUMENT );
4112
Ronald Cron5c522922020-11-14 16:35:34 +01004113 status = psa_get_and_lock_transparent_key_slot_with_policy(
4114 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004115 if( status != PSA_SUCCESS )
4116 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004117 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4118 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004119 {
4120 status = PSA_ERROR_INVALID_ARGUMENT;
4121 goto exit;
4122 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004123
John Durkop6ba40d12020-11-10 08:50:04 -08004124#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4125 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004126 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004127 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004128 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004129 status = psa_load_rsa_representation( slot->attr.type,
4130 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004131 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004132 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004133 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004134 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004135
4136 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004137 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004138 status = PSA_ERROR_BUFFER_TOO_SMALL;
4139 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004140 }
John Durkop0e005192020-10-31 22:06:54 -07004141#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004142 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004143 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004144 status = mbedtls_to_psa_error(
4145 mbedtls_rsa_pkcs1_encrypt( rsa,
4146 mbedtls_ctr_drbg_random,
4147 &global_data.ctr_drbg,
4148 MBEDTLS_RSA_PUBLIC,
4149 input_length,
4150 input,
4151 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004152 }
4153 else
John Durkop0e005192020-10-31 22:06:54 -07004154#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4155#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004156 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004157 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004158 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004159 status = mbedtls_to_psa_error(
4160 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
4161 mbedtls_ctr_drbg_random,
4162 &global_data.ctr_drbg,
4163 MBEDTLS_RSA_PUBLIC,
4164 salt, salt_length,
4165 input_length,
4166 input,
4167 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004168 }
4169 else
John Durkop0e005192020-10-31 22:06:54 -07004170#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004171 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004172 status = PSA_ERROR_INVALID_ARGUMENT;
4173 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004174 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004175rsa_exit:
4176 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004177 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004178
Steven Cooremana2371e52020-07-28 14:30:39 +02004179 mbedtls_rsa_free( rsa );
4180 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004181 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004182 else
John Durkop9814fa22020-11-04 12:28:15 -08004183#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08004184 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004185 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004186 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004187 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004188
4189exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004190 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004191
Ronald Cron5c522922020-11-14 16:35:34 +01004192 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004193}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004194
Ronald Croncf56a0a2020-08-04 09:51:30 +02004195psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004196 psa_algorithm_t alg,
4197 const uint8_t *input,
4198 size_t input_length,
4199 const uint8_t *salt,
4200 size_t salt_length,
4201 uint8_t *output,
4202 size_t output_size,
4203 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004204{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004206 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004207 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004208
Darryl Green5cc689a2018-07-24 15:34:10 +01004209 (void) input;
4210 (void) input_length;
4211 (void) salt;
4212 (void) output;
4213 (void) output_size;
4214
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004215 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004216
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004217 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4218 return( PSA_ERROR_INVALID_ARGUMENT );
4219
Ronald Cron5c522922020-11-14 16:35:34 +01004220 status = psa_get_and_lock_transparent_key_slot_with_policy(
4221 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004222 if( status != PSA_SUCCESS )
4223 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004224 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004225 {
4226 status = PSA_ERROR_INVALID_ARGUMENT;
4227 goto exit;
4228 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004229
John Durkop6ba40d12020-11-10 08:50:04 -08004230#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4231 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004232 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004233 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004234 mbedtls_rsa_context *rsa = NULL;
4235 status = psa_load_rsa_representation( slot->attr.type,
4236 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004237 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004238 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004239 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004240 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004241
Steven Cooremana2371e52020-07-28 14:30:39 +02004242 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004243 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004244 status = PSA_ERROR_INVALID_ARGUMENT;
4245 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004246 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004247
John Durkop0e005192020-10-31 22:06:54 -07004248#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004249 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004250 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004251 status = mbedtls_to_psa_error(
4252 mbedtls_rsa_pkcs1_decrypt( rsa,
4253 mbedtls_ctr_drbg_random,
4254 &global_data.ctr_drbg,
4255 MBEDTLS_RSA_PRIVATE,
4256 output_length,
4257 input,
4258 output,
4259 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004260 }
4261 else
John Durkop0e005192020-10-31 22:06:54 -07004262#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4263#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004264 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004265 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004266 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004267 status = mbedtls_to_psa_error(
4268 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4269 mbedtls_ctr_drbg_random,
4270 &global_data.ctr_drbg,
4271 MBEDTLS_RSA_PRIVATE,
4272 salt, salt_length,
4273 output_length,
4274 input,
4275 output,
4276 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004277 }
4278 else
John Durkop0e005192020-10-31 22:06:54 -07004279#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004280 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004281 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004282 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004283
Steven Cooreman4fed4552020-08-03 14:46:03 +02004284rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004285 mbedtls_rsa_free( rsa );
4286 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004287 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004288 else
John Durkop6ba40d12020-11-10 08:50:04 -08004289#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
4290 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004291 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004292 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004293 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004294
4295exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004296 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004297
Ronald Cron5c522922020-11-14 16:35:34 +01004298 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004299}
Gilles Peskine20035e32018-02-03 22:44:14 +01004300
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004301
4302
mohammad1603503973b2018-03-12 15:59:30 +02004303/****************************************************************/
4304/* Symmetric cryptography */
4305/****************************************************************/
4306
Gilles Peskinee553c652018-06-04 16:22:46 +02004307static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004308 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004309 psa_algorithm_t alg,
4310 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004311{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004312 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004313 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004314 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004315 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004316 size_t key_bits;
4317 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004318 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4319 PSA_KEY_USAGE_ENCRYPT :
4320 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004321
Steven Cooremand3feccd2020-09-01 15:56:14 +02004322 /* A context must be freshly initialized before it can be set up. */
4323 if( operation->alg != 0 )
4324 return( PSA_ERROR_BAD_STATE );
4325
Steven Cooremana07b9972020-09-10 14:54:14 +02004326 /* The requested algorithm must be one that can be processed by cipher. */
4327 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004328 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004329
Steven Cooremanef8575e2020-09-11 11:44:50 +02004330 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004331 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004332 if( status != PSA_SUCCESS )
4333 goto exit;
4334
4335 /* Initialize the operation struct members, except for alg. The alg member
4336 * is used to indicate to psa_cipher_abort that there are resources to free,
4337 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004338 operation->key_set = 0;
4339 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004340 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004341 operation->iv_size = 0;
4342 operation->block_size = 0;
4343 if( alg == PSA_ALG_ECB_NO_PADDING )
4344 operation->iv_required = 0;
4345 else
4346 operation->iv_required = 1;
4347
Steven Cooremana07b9972020-09-10 14:54:14 +02004348 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004349 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004350 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004351 slot,
4352 alg );
4353 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004354 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004355 slot,
4356 alg );
4357
Steven Cooremanef8575e2020-09-11 11:44:50 +02004358 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004359 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004360 /* Once the driver context is initialised, it needs to be freed using
4361 * psa_cipher_abort. Indicate this through setting alg. */
4362 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004363 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004364
Steven Cooremand3feccd2020-09-01 15:56:14 +02004365 if( status != PSA_ERROR_NOT_SUPPORTED ||
4366 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4367 goto exit;
4368
Steven Cooremana07b9972020-09-10 14:54:14 +02004369 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004370 * available for the given algorithm & key. */
4371 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004372
Steven Cooremana07b9972020-09-10 14:54:14 +02004373 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004374 * psa_cipher_abort. Indicate there is something to be freed through setting
4375 * alg, and indicate the operation is being done using mbedtls crypto through
4376 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004377 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004378 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004379
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004380 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004381 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004382 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004383 {
4384 status = PSA_ERROR_NOT_SUPPORTED;
4385 goto exit;
4386 }
mohammad1603503973b2018-03-12 15:59:30 +02004387
mohammad1603503973b2018-03-12 15:59:30 +02004388 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004389 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004390 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004391
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004392#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004393 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004394 {
4395 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004396 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004397 memcpy( keys, slot->data.key.data, 16 );
4398 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004399 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4400 keys,
4401 192, cipher_operation );
4402 }
4403 else
4404#endif
4405 {
4406 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004407 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004408 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004409 }
Moran Peker41deec42018-04-04 15:43:05 +03004410 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004411 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004412
mohammad16038481e742018-03-18 13:57:31 +02004413#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004414 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004415 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004416 case PSA_ALG_CBC_NO_PADDING:
4417 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4418 MBEDTLS_PADDING_NONE );
4419 break;
4420 case PSA_ALG_CBC_PKCS7:
4421 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4422 MBEDTLS_PADDING_PKCS7 );
4423 break;
4424 default:
4425 /* The algorithm doesn't involve padding. */
4426 ret = 0;
4427 break;
4428 }
4429 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004430 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004431#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4432
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004433 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004434 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004435 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4436 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004437 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004438 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004439 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004440#if defined(MBEDTLS_CHACHA20_C)
4441 else
4442 if( alg == PSA_ALG_CHACHA20 )
4443 operation->iv_size = 12;
4444#endif
mohammad1603503973b2018-03-12 15:59:30 +02004445
Steven Cooreman7df02922020-09-09 15:28:49 +02004446 status = PSA_SUCCESS;
4447
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004448exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004449 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004450 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004451 if( status == PSA_SUCCESS )
4452 {
4453 /* Update operation flags for both driver and software implementations */
4454 operation->key_set = 1;
4455 }
4456 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004457 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004458
Ronald Cron5c522922020-11-14 16:35:34 +01004459 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004460
Ronald Cron5c522922020-11-14 16:35:34 +01004461 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004462}
4463
Gilles Peskinefe119512018-07-08 21:39:34 +02004464psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004465 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004466 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004467{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004468 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004469}
4470
Gilles Peskinefe119512018-07-08 21:39:34 +02004471psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004472 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004473 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004474{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004475 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004476}
4477
Gilles Peskinefe119512018-07-08 21:39:34 +02004478psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004479 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004480 size_t iv_size,
4481 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004482{
itayzafrir534bd7c2018-08-02 13:56:32 +03004483 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004484 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004485 if( operation->iv_set || ! operation->iv_required )
4486 {
4487 return( PSA_ERROR_BAD_STATE );
4488 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004489
Steven Cooremanef8575e2020-09-11 11:44:50 +02004490 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004491 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004492 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004493 iv,
4494 iv_size,
4495 iv_length );
4496 goto exit;
4497 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004498
Moran Peker41deec42018-04-04 15:43:05 +03004499 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004500 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004501 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004502 goto exit;
4503 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004504 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4505 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004506 if( ret != 0 )
4507 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004508 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004509 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004510 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004511
mohammad16038481e742018-03-18 13:57:31 +02004512 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004513 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004514
Moran Peker395db872018-05-31 14:07:14 +03004515exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004516 if( status == PSA_SUCCESS )
4517 operation->iv_set = 1;
4518 else
Moran Peker395db872018-05-31 14:07:14 +03004519 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004520 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004521}
4522
Gilles Peskinefe119512018-07-08 21:39:34 +02004523psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004524 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004525 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004526{
itayzafrir534bd7c2018-08-02 13:56:32 +03004527 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004528 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004529 if( operation->iv_set || ! operation->iv_required )
4530 {
4531 return( PSA_ERROR_BAD_STATE );
4532 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004533
Steven Cooremanef8575e2020-09-11 11:44:50 +02004534 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004535 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004536 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004537 iv,
4538 iv_length );
4539 goto exit;
4540 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004541
Moran Pekera28258c2018-05-29 16:25:04 +03004542 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004543 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004544 status = PSA_ERROR_INVALID_ARGUMENT;
4545 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004546 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004547 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4548 status = mbedtls_to_psa_error( ret );
4549exit:
4550 if( status == PSA_SUCCESS )
4551 operation->iv_set = 1;
4552 else
mohammad1603503973b2018-03-12 15:59:30 +02004553 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004554 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004555}
4556
Steven Cooreman177deba2020-09-07 17:14:14 +02004557/* Process input for which the algorithm is set to ECB mode. This requires
4558 * manual processing, since the PSA API is defined as being able to process
4559 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4560 * underlying mbedtls_cipher_update only takes full blocks. */
4561static psa_status_t psa_cipher_update_ecb_internal(
4562 mbedtls_cipher_context_t *ctx,
4563 const uint8_t *input,
4564 size_t input_length,
4565 uint8_t *output,
4566 size_t output_size,
4567 size_t *output_length )
4568{
4569 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4570 size_t block_size = ctx->cipher_info->block_size;
4571 size_t internal_output_length = 0;
4572 *output_length = 0;
4573
4574 if( input_length == 0 )
4575 {
4576 status = PSA_SUCCESS;
4577 goto exit;
4578 }
4579
4580 if( ctx->unprocessed_len > 0 )
4581 {
4582 /* Fill up to block size, and run the block if there's a full one. */
4583 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4584
4585 if( input_length < bytes_to_copy )
4586 bytes_to_copy = input_length;
4587
4588 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4589 input, bytes_to_copy );
4590 input_length -= bytes_to_copy;
4591 input += bytes_to_copy;
4592 ctx->unprocessed_len += bytes_to_copy;
4593
4594 if( ctx->unprocessed_len == block_size )
4595 {
4596 status = mbedtls_to_psa_error(
4597 mbedtls_cipher_update( ctx,
4598 ctx->unprocessed_data,
4599 block_size,
4600 output, &internal_output_length ) );
4601
4602 if( status != PSA_SUCCESS )
4603 goto exit;
4604
4605 output += internal_output_length;
4606 output_size -= internal_output_length;
4607 *output_length += internal_output_length;
4608 ctx->unprocessed_len = 0;
4609 }
4610 }
4611
4612 while( input_length >= block_size )
4613 {
4614 /* Run all full blocks we have, one by one */
4615 status = mbedtls_to_psa_error(
4616 mbedtls_cipher_update( ctx, input,
4617 block_size,
4618 output, &internal_output_length ) );
4619
4620 if( status != PSA_SUCCESS )
4621 goto exit;
4622
4623 input_length -= block_size;
4624 input += block_size;
4625
4626 output += internal_output_length;
4627 output_size -= internal_output_length;
4628 *output_length += internal_output_length;
4629 }
4630
4631 if( input_length > 0 )
4632 {
4633 /* Save unprocessed bytes for later processing */
4634 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4635 input, input_length );
4636 ctx->unprocessed_len += input_length;
4637 }
4638
4639 status = PSA_SUCCESS;
4640
4641exit:
4642 return( status );
4643}
4644
Gilles Peskinee553c652018-06-04 16:22:46 +02004645psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4646 const uint8_t *input,
4647 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004648 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004649 size_t output_size,
4650 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004651{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004652 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004653 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004654 if( operation->alg == 0 )
4655 {
4656 return( PSA_ERROR_BAD_STATE );
4657 }
4658 if( operation->iv_required && ! operation->iv_set )
4659 {
4660 return( PSA_ERROR_BAD_STATE );
4661 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004662
Steven Cooremanef8575e2020-09-11 11:44:50 +02004663 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004664 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004665 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004666 input,
4667 input_length,
4668 output,
4669 output_size,
4670 output_length );
4671 goto exit;
4672 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004673
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004674 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004675 {
4676 /* Take the unprocessed partial block left over from previous
4677 * update calls, if any, plus the input to this call. Remove
4678 * the last partial block, if any. You get the data that will be
4679 * output in this call. */
4680 expected_output_size =
4681 ( operation->ctx.cipher.unprocessed_len + input_length )
4682 / operation->block_size * operation->block_size;
4683 }
4684 else
4685 {
4686 expected_output_size = input_length;
4687 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004688
Gilles Peskine89d789c2018-06-04 17:17:16 +02004689 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004690 {
4691 status = PSA_ERROR_BUFFER_TOO_SMALL;
4692 goto exit;
4693 }
mohammad160382759612018-03-12 18:16:40 +02004694
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004695 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4696 {
4697 /* mbedtls_cipher_update has an API inconsistency: it will only
4698 * process a single block at a time in ECB mode. Abstract away that
4699 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004700 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4701 input,
4702 input_length,
4703 output,
4704 output_size,
4705 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004706 }
4707 else
4708 {
4709 status = mbedtls_to_psa_error(
4710 mbedtls_cipher_update( &operation->ctx.cipher, input,
4711 input_length, output, output_length ) );
4712 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004713exit:
4714 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004715 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004716 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004717}
4718
Gilles Peskinee553c652018-06-04 16:22:46 +02004719psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4720 uint8_t *output,
4721 size_t output_size,
4722 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004723{
David Saadab4ecc272019-02-14 13:48:10 +02004724 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004725 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004726 if( operation->alg == 0 )
4727 {
4728 return( PSA_ERROR_BAD_STATE );
4729 }
4730 if( operation->iv_required && ! operation->iv_set )
4731 {
4732 return( PSA_ERROR_BAD_STATE );
4733 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004734
Steven Cooremanef8575e2020-09-11 11:44:50 +02004735 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004736 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004737 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004738 output,
4739 output_size,
4740 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004741 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004742 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004743
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004744 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004745 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004746 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004747 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004748 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004749 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004750 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004751 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004752 }
4753
Steven Cooremanef8575e2020-09-11 11:44:50 +02004754 status = mbedtls_to_psa_error(
4755 mbedtls_cipher_finish( &operation->ctx.cipher,
4756 temp_output_buffer,
4757 output_length ) );
4758 if( status != PSA_SUCCESS )
4759 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004760
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004761 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004762 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004763 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004764 memcpy( output, temp_output_buffer, *output_length );
4765 else
Janos Follath315b51c2018-07-09 16:04:51 +01004766 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004767
Steven Cooremanef8575e2020-09-11 11:44:50 +02004768exit:
4769 if( operation->mbedtls_in_use == 1 )
4770 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004771
Steven Cooremanef8575e2020-09-11 11:44:50 +02004772 if( status == PSA_SUCCESS )
4773 return( psa_cipher_abort( operation ) );
4774 else
4775 {
4776 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004777 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004778
Steven Cooremanef8575e2020-09-11 11:44:50 +02004779 return( status );
4780 }
mohammad1603503973b2018-03-12 15:59:30 +02004781}
4782
Gilles Peskinee553c652018-06-04 16:22:46 +02004783psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4784{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004785 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004786 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004787 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004788 * in use. It's ok to call abort on such an object, and there's
4789 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004790 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004791 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004792
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004793 /* Sanity check (shouldn't happen: operation->alg should
4794 * always have been initialized to a valid value). */
4795 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4796 return( PSA_ERROR_BAD_STATE );
4797
Steven Cooremanef8575e2020-09-11 11:44:50 +02004798 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004799 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004800 else
4801 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004802
Moran Peker41deec42018-04-04 15:43:05 +03004803 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004804 operation->key_set = 0;
4805 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004806 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004807 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004808 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004809 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004810
Moran Peker395db872018-05-31 14:07:14 +03004811 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004812}
4813
Gilles Peskinea0655c32018-04-30 17:06:50 +02004814
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004815
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004816
mohammad16035955c982018-04-26 00:53:03 +03004817/****************************************************************/
4818/* AEAD */
4819/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004820
Gilles Peskineedf9a652018-08-17 18:11:56 +02004821typedef struct
4822{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004823 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004824 const mbedtls_cipher_info_t *cipher_info;
4825 union
4826 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004827 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004828#if defined(MBEDTLS_CCM_C)
4829 mbedtls_ccm_context ccm;
4830#endif /* MBEDTLS_CCM_C */
4831#if defined(MBEDTLS_GCM_C)
4832 mbedtls_gcm_context gcm;
4833#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004834#if defined(MBEDTLS_CHACHAPOLY_C)
4835 mbedtls_chachapoly_context chachapoly;
4836#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004837 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004838 psa_algorithm_t core_alg;
4839 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004840 uint8_t tag_length;
4841} aead_operation_t;
4842
Ronald Cronf95a2b12020-10-22 15:24:49 +02004843#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4844
Gilles Peskine30a9e412019-01-14 18:36:12 +01004845static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004846{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004847 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004848 {
4849#if defined(MBEDTLS_CCM_C)
4850 case PSA_ALG_CCM:
4851 mbedtls_ccm_free( &operation->ctx.ccm );
4852 break;
4853#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004854#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004855 case PSA_ALG_GCM:
4856 mbedtls_gcm_free( &operation->ctx.gcm );
4857 break;
4858#endif /* MBEDTLS_GCM_C */
4859 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004860
Ronald Cron5c522922020-11-14 16:35:34 +01004861 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004862}
4863
4864static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004865 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004866 psa_key_usage_t usage,
4867 psa_algorithm_t alg )
4868{
4869 psa_status_t status;
4870 size_t key_bits;
4871 mbedtls_cipher_id_t cipher_id;
4872
Ronald Cron5c522922020-11-14 16:35:34 +01004873 status = psa_get_and_lock_transparent_key_slot_with_policy(
4874 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004875 if( status != PSA_SUCCESS )
4876 return( status );
4877
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004878 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004879
4880 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004881 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004882 &cipher_id );
4883 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004884 {
4885 status = PSA_ERROR_NOT_SUPPORTED;
4886 goto cleanup;
4887 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004888
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004889 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004890 {
4891#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004892 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4893 operation->core_alg = PSA_ALG_CCM;
4894 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004895 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4896 * The call to mbedtls_ccm_encrypt_and_tag or
4897 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004898 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004899 {
4900 status = PSA_ERROR_INVALID_ARGUMENT;
4901 goto cleanup;
4902 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004903 mbedtls_ccm_init( &operation->ctx.ccm );
4904 status = mbedtls_to_psa_error(
4905 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004906 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004907 (unsigned int) key_bits ) );
4908 if( status != 0 )
4909 goto cleanup;
4910 break;
4911#endif /* MBEDTLS_CCM_C */
4912
4913#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004914 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4915 operation->core_alg = PSA_ALG_GCM;
4916 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004917 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4918 * The call to mbedtls_gcm_crypt_and_tag or
4919 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004920 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004921 {
4922 status = PSA_ERROR_INVALID_ARGUMENT;
4923 goto cleanup;
4924 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004925 mbedtls_gcm_init( &operation->ctx.gcm );
4926 status = mbedtls_to_psa_error(
4927 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004928 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004929 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004930 if( status != 0 )
4931 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004932 break;
4933#endif /* MBEDTLS_GCM_C */
4934
Gilles Peskine26869f22019-05-06 15:25:00 +02004935#if defined(MBEDTLS_CHACHAPOLY_C)
4936 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4937 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4938 operation->full_tag_length = 16;
4939 /* We only support the default tag length. */
4940 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004941 {
4942 status = PSA_ERROR_NOT_SUPPORTED;
4943 goto cleanup;
4944 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004945 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4946 status = mbedtls_to_psa_error(
4947 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004948 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004949 if( status != 0 )
4950 goto cleanup;
4951 break;
4952#endif /* MBEDTLS_CHACHAPOLY_C */
4953
Gilles Peskineedf9a652018-08-17 18:11:56 +02004954 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004955 status = PSA_ERROR_NOT_SUPPORTED;
4956 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004957 }
4958
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004959 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4960 {
4961 status = PSA_ERROR_INVALID_ARGUMENT;
4962 goto cleanup;
4963 }
4964 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004965
Gilles Peskineedf9a652018-08-17 18:11:56 +02004966 return( PSA_SUCCESS );
4967
4968cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004969 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004970 return( status );
4971}
4972
Ronald Croncf56a0a2020-08-04 09:51:30 +02004973psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004974 psa_algorithm_t alg,
4975 const uint8_t *nonce,
4976 size_t nonce_length,
4977 const uint8_t *additional_data,
4978 size_t additional_data_length,
4979 const uint8_t *plaintext,
4980 size_t plaintext_length,
4981 uint8_t *ciphertext,
4982 size_t ciphertext_size,
4983 size_t *ciphertext_length )
4984{
mohammad16035955c982018-04-26 00:53:03 +03004985 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004986 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004987 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004988
mohammad1603f08a5502018-06-03 15:05:47 +03004989 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004990
Ronald Croncf56a0a2020-08-04 09:51:30 +02004991 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004992 if( status != PSA_SUCCESS )
4993 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004994
Gilles Peskineedf9a652018-08-17 18:11:56 +02004995 /* For all currently supported modes, the tag is at the end of the
4996 * ciphertext. */
4997 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4998 {
4999 status = PSA_ERROR_BUFFER_TOO_SMALL;
5000 goto exit;
5001 }
5002 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03005003
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005004#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005005 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005006 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005007 status = mbedtls_to_psa_error(
5008 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
5009 MBEDTLS_GCM_ENCRYPT,
5010 plaintext_length,
5011 nonce, nonce_length,
5012 additional_data, additional_data_length,
5013 plaintext, ciphertext,
5014 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03005015 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005016 else
5017#endif /* MBEDTLS_GCM_C */
5018#if defined(MBEDTLS_CCM_C)
5019 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005020 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005021 status = mbedtls_to_psa_error(
5022 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
5023 plaintext_length,
5024 nonce, nonce_length,
5025 additional_data,
5026 additional_data_length,
5027 plaintext, ciphertext,
5028 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005029 }
mohammad16035c8845f2018-05-09 05:40:09 -07005030 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005031#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005032#if defined(MBEDTLS_CHACHAPOLY_C)
5033 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5034 {
5035 if( nonce_length != 12 || operation.tag_length != 16 )
5036 {
5037 status = PSA_ERROR_NOT_SUPPORTED;
5038 goto exit;
5039 }
5040 status = mbedtls_to_psa_error(
5041 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
5042 plaintext_length,
5043 nonce,
5044 additional_data,
5045 additional_data_length,
5046 plaintext,
5047 ciphertext,
5048 tag ) );
5049 }
5050 else
5051#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07005052 {
mohammad1603554faad2018-06-03 15:07:38 +03005053 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07005054 }
Gilles Peskine2d277862018-06-18 15:41:12 +02005055
Gilles Peskineedf9a652018-08-17 18:11:56 +02005056 if( status != PSA_SUCCESS && ciphertext_size != 0 )
5057 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02005058
Gilles Peskineedf9a652018-08-17 18:11:56 +02005059exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005060 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005061 if( status == PSA_SUCCESS )
5062 *ciphertext_length = plaintext_length + operation.tag_length;
5063 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005064}
5065
Gilles Peskineee652a32018-06-01 19:23:52 +02005066/* Locate the tag in a ciphertext buffer containing the encrypted data
5067 * followed by the tag. Return the length of the part preceding the tag in
5068 * *plaintext_length. This is the size of the plaintext in modes where
5069 * the encrypted data has the same size as the plaintext, such as
5070 * CCM and GCM. */
5071static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
5072 const uint8_t *ciphertext,
5073 size_t ciphertext_length,
5074 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02005075 const uint8_t **p_tag )
5076{
5077 size_t payload_length;
5078 if( tag_length > ciphertext_length )
5079 return( PSA_ERROR_INVALID_ARGUMENT );
5080 payload_length = ciphertext_length - tag_length;
5081 if( payload_length > plaintext_size )
5082 return( PSA_ERROR_BUFFER_TOO_SMALL );
5083 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02005084 return( PSA_SUCCESS );
5085}
5086
Ronald Croncf56a0a2020-08-04 09:51:30 +02005087psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03005088 psa_algorithm_t alg,
5089 const uint8_t *nonce,
5090 size_t nonce_length,
5091 const uint8_t *additional_data,
5092 size_t additional_data_length,
5093 const uint8_t *ciphertext,
5094 size_t ciphertext_length,
5095 uint8_t *plaintext,
5096 size_t plaintext_size,
5097 size_t *plaintext_length )
5098{
mohammad16035955c982018-04-26 00:53:03 +03005099 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005100 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02005101 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02005102
Gilles Peskineee652a32018-06-01 19:23:52 +02005103 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005104
Ronald Croncf56a0a2020-08-04 09:51:30 +02005105 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005106 if( status != PSA_SUCCESS )
5107 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005108
Gilles Peskinef7e7b012019-05-06 15:27:16 +02005109 status = psa_aead_unpadded_locate_tag( operation.tag_length,
5110 ciphertext, ciphertext_length,
5111 plaintext_size, &tag );
5112 if( status != PSA_SUCCESS )
5113 goto exit;
5114
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005115#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005116 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005117 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005118 status = mbedtls_to_psa_error(
5119 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5120 ciphertext_length - operation.tag_length,
5121 nonce, nonce_length,
5122 additional_data,
5123 additional_data_length,
5124 tag, operation.tag_length,
5125 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005126 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005127 else
5128#endif /* MBEDTLS_GCM_C */
5129#if defined(MBEDTLS_CCM_C)
5130 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005131 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005132 status = mbedtls_to_psa_error(
5133 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5134 ciphertext_length - operation.tag_length,
5135 nonce, nonce_length,
5136 additional_data,
5137 additional_data_length,
5138 ciphertext, plaintext,
5139 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005140 }
mohammad160339574652018-06-01 04:39:53 -07005141 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005142#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005143#if defined(MBEDTLS_CHACHAPOLY_C)
5144 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5145 {
5146 if( nonce_length != 12 || operation.tag_length != 16 )
5147 {
5148 status = PSA_ERROR_NOT_SUPPORTED;
5149 goto exit;
5150 }
5151 status = mbedtls_to_psa_error(
5152 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5153 ciphertext_length - operation.tag_length,
5154 nonce,
5155 additional_data,
5156 additional_data_length,
5157 tag,
5158 ciphertext,
5159 plaintext ) );
5160 }
5161 else
5162#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005163 {
mohammad1603554faad2018-06-03 15:07:38 +03005164 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005165 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005166
Gilles Peskineedf9a652018-08-17 18:11:56 +02005167 if( status != PSA_SUCCESS && plaintext_size != 0 )
5168 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005169
Gilles Peskineedf9a652018-08-17 18:11:56 +02005170exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005171 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005172 if( status == PSA_SUCCESS )
5173 *plaintext_length = ciphertext_length - operation.tag_length;
5174 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005175}
5176
Gilles Peskinea0655c32018-04-30 17:06:50 +02005177
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005178
Gilles Peskine20035e32018-02-03 22:44:14 +01005179/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005180/* Generators */
5181/****************************************************************/
5182
John Durkop07cc04a2020-11-16 22:08:34 -08005183#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
5184 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5185 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5186#define AT_LEAST_ONE_BUILTIN_KDF
5187#endif
5188
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005189#define HKDF_STATE_INIT 0 /* no input yet */
5190#define HKDF_STATE_STARTED 1 /* got salt */
5191#define HKDF_STATE_KEYED 2 /* got key */
5192#define HKDF_STATE_OUTPUT 3 /* output started */
5193
Gilles Peskinecbe66502019-05-16 16:59:18 +02005194static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005195 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005196{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005197 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5198 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005199 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005200 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005201}
5202
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005203psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005204{
5205 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005206 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005207 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005208 {
5209 /* The object has (apparently) been initialized but it is not
5210 * in use. It's ok to call abort on such an object, and there's
5211 * nothing to do. */
5212 }
5213 else
John Durkopd0321952020-10-29 21:37:36 -07005214#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005215 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005216 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005217 mbedtls_free( operation->ctx.hkdf.info );
5218 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005219 }
John Durkop07cc04a2020-11-16 22:08:34 -08005220 else
5221#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5222#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5223 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5224 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005225 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005226 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005227 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005228 if( operation->ctx.tls12_prf.seed != NULL )
5229 {
5230 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5231 operation->ctx.tls12_prf.seed_length );
5232 mbedtls_free( operation->ctx.tls12_prf.seed );
5233 }
5234
5235 if( operation->ctx.tls12_prf.label != NULL )
5236 {
5237 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5238 operation->ctx.tls12_prf.label_length );
5239 mbedtls_free( operation->ctx.tls12_prf.label );
5240 }
5241
5242 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5243
5244 /* We leave the fields Ai and output_block to be erased safely by the
5245 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005246 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005247 else
John Durkop07cc04a2020-11-16 22:08:34 -08005248#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5249 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005250 {
5251 status = PSA_ERROR_BAD_STATE;
5252 }
Janos Follath083036a2019-06-11 10:22:26 +01005253 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005254 return( status );
5255}
5256
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005257psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005258 size_t *capacity)
5259{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005260 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005261 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005262 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005263 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005264 }
5265
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005266 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005267 return( PSA_SUCCESS );
5268}
5269
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005270psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005271 size_t capacity )
5272{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005273 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005274 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005275 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005276 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005277 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005278 return( PSA_SUCCESS );
5279}
5280
John Durkopd0321952020-10-29 21:37:36 -07005281#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005282/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005283 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005284static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005285 psa_algorithm_t hash_alg,
5286 uint8_t *output,
5287 size_t output_length )
5288{
5289 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5290 psa_status_t status;
5291
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005292 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5293 return( PSA_ERROR_BAD_STATE );
5294 hkdf->state = HKDF_STATE_OUTPUT;
5295
Gilles Peskinebef7f142018-07-12 17:22:21 +02005296 while( output_length != 0 )
5297 {
5298 /* Copy what remains of the current block */
5299 uint8_t n = hash_length - hkdf->offset_in_block;
5300 if( n > output_length )
5301 n = (uint8_t) output_length;
5302 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5303 output += n;
5304 output_length -= n;
5305 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005306 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005307 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005308 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005309 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005310 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005311 * object was corrupted or if this function is called directly
5312 * inside the library. */
5313 if( hkdf->block_number == 0xff )
5314 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005315
5316 /* We need a new block */
5317 ++hkdf->block_number;
5318 hkdf->offset_in_block = 0;
5319 status = psa_hmac_setup_internal( &hkdf->hmac,
5320 hkdf->prk, hash_length,
5321 hash_alg );
5322 if( status != PSA_SUCCESS )
5323 return( status );
5324 if( hkdf->block_number != 1 )
5325 {
5326 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5327 hkdf->output_block,
5328 hash_length );
5329 if( status != PSA_SUCCESS )
5330 return( status );
5331 }
5332 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5333 hkdf->info,
5334 hkdf->info_length );
5335 if( status != PSA_SUCCESS )
5336 return( status );
5337 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5338 &hkdf->block_number, 1 );
5339 if( status != PSA_SUCCESS )
5340 return( status );
5341 status = psa_hmac_finish_internal( &hkdf->hmac,
5342 hkdf->output_block,
5343 sizeof( hkdf->output_block ) );
5344 if( status != PSA_SUCCESS )
5345 return( status );
5346 }
5347
5348 return( PSA_SUCCESS );
5349}
John Durkop07cc04a2020-11-16 22:08:34 -08005350#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005351
John Durkop07cc04a2020-11-16 22:08:34 -08005352#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5353 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005354static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5355 psa_tls12_prf_key_derivation_t *tls12_prf,
5356 psa_algorithm_t alg )
5357{
5358 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5359 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005360 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5361 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005362
Janos Follath7742fee2019-06-17 12:58:10 +01005363 /* We can't be wanting more output after block 0xff, otherwise
5364 * the capacity check in psa_key_derivation_output_bytes() would have
5365 * prevented this call. It could happen only if the operation
5366 * object was corrupted or if this function is called directly
5367 * inside the library. */
5368 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005369 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005370
5371 /* We need a new block */
5372 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005373 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005374
5375 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5376 *
5377 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5378 *
5379 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5380 * HMAC_hash(secret, A(2) + seed) +
5381 * HMAC_hash(secret, A(3) + seed) + ...
5382 *
5383 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005384 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005385 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005386 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005387 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005388 * is currently extracted as `output_block` and where i is
5389 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005390 */
5391
Janos Follathea29bfb2019-06-19 12:21:20 +01005392 /* Save the hash context before using it, to preserve the hash state with
5393 * only the inner padding in it. We need this, because inner padding depends
5394 * on the key (secret in the RFC's terminology). */
5395 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5396 if( status != PSA_SUCCESS )
5397 goto cleanup;
5398
5399 /* Calculate A(i) where i = tls12_prf->block_number. */
5400 if( tls12_prf->block_number == 1 )
5401 {
5402 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5403 * the variable seed and in this instance means it in the context of the
5404 * P_hash function, where seed = label + seed.) */
5405 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5406 tls12_prf->label, tls12_prf->label_length );
5407 if( status != PSA_SUCCESS )
5408 goto cleanup;
5409 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5410 tls12_prf->seed, tls12_prf->seed_length );
5411 if( status != PSA_SUCCESS )
5412 goto cleanup;
5413 }
5414 else
5415 {
5416 /* A(i) = HMAC_hash(secret, A(i-1)) */
5417 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5418 tls12_prf->Ai, hash_length );
5419 if( status != PSA_SUCCESS )
5420 goto cleanup;
5421 }
5422
5423 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5424 tls12_prf->Ai, hash_length );
5425 if( status != PSA_SUCCESS )
5426 goto cleanup;
5427 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5428 if( status != PSA_SUCCESS )
5429 goto cleanup;
5430
5431 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5432 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5433 tls12_prf->Ai, hash_length );
5434 if( status != PSA_SUCCESS )
5435 goto cleanup;
5436 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5437 tls12_prf->label, tls12_prf->label_length );
5438 if( status != PSA_SUCCESS )
5439 goto cleanup;
5440 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5441 tls12_prf->seed, tls12_prf->seed_length );
5442 if( status != PSA_SUCCESS )
5443 goto cleanup;
5444 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5445 tls12_prf->output_block, hash_length );
5446 if( status != PSA_SUCCESS )
5447 goto cleanup;
5448 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5449 if( status != PSA_SUCCESS )
5450 goto cleanup;
5451
Janos Follath7742fee2019-06-17 12:58:10 +01005452
5453cleanup:
5454
Janos Follathea29bfb2019-06-19 12:21:20 +01005455 cleanup_status = psa_hash_abort( &backup );
5456 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5457 status = cleanup_status;
5458
5459 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005460}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005461
Janos Follath844eb0e2019-06-19 12:10:49 +01005462static psa_status_t psa_key_derivation_tls12_prf_read(
5463 psa_tls12_prf_key_derivation_t *tls12_prf,
5464 psa_algorithm_t alg,
5465 uint8_t *output,
5466 size_t output_length )
5467{
5468 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5469 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5470 psa_status_t status;
5471 uint8_t offset, length;
5472
5473 while( output_length != 0 )
5474 {
5475 /* Check if we have fully processed the current block. */
5476 if( tls12_prf->left_in_block == 0 )
5477 {
5478 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5479 alg );
5480 if( status != PSA_SUCCESS )
5481 return( status );
5482
5483 continue;
5484 }
5485
5486 if( tls12_prf->left_in_block > output_length )
5487 length = (uint8_t) output_length;
5488 else
5489 length = tls12_prf->left_in_block;
5490
5491 offset = hash_length - tls12_prf->left_in_block;
5492 memcpy( output, tls12_prf->output_block + offset, length );
5493 output += length;
5494 output_length -= length;
5495 tls12_prf->left_in_block -= length;
5496 }
5497
5498 return( PSA_SUCCESS );
5499}
John Durkop07cc04a2020-11-16 22:08:34 -08005500#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5501 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005502
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005503psa_status_t psa_key_derivation_output_bytes(
5504 psa_key_derivation_operation_t *operation,
5505 uint8_t *output,
5506 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005507{
5508 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005509 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005510
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005511 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005512 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005513 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005514 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005515 }
5516
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005517 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005518 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005519 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005520 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005521 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005522 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005523 goto exit;
5524 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005525 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005526 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005527 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005528 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005529 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5530 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005531 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005532 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005533 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005534 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005535 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005536
John Durkopd0321952020-10-29 21:37:36 -07005537#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005538 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005539 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005540 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005541 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005542 output, output_length );
5543 }
Janos Follathadbec812019-06-14 11:05:39 +01005544 else
John Durkop07cc04a2020-11-16 22:08:34 -08005545#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5546#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5547 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005548 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005549 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005550 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005551 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005552 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005553 output_length );
5554 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005555 else
John Durkop07cc04a2020-11-16 22:08:34 -08005556#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5557 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005558 {
5559 return( PSA_ERROR_BAD_STATE );
5560 }
5561
5562exit:
5563 if( status != PSA_SUCCESS )
5564 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005565 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005566 * This allows us to differentiate between exhausted operations and
5567 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5568 * operations. */
5569 psa_algorithm_t alg = operation->alg;
5570 psa_key_derivation_abort( operation );
5571 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005572 memset( output, '!', output_length );
5573 }
5574 return( status );
5575}
5576
Gilles Peskine08542d82018-07-19 17:05:42 +02005577#if defined(MBEDTLS_DES_C)
5578static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5579{
5580 if( data_size >= 8 )
5581 mbedtls_des_key_set_parity( data );
5582 if( data_size >= 16 )
5583 mbedtls_des_key_set_parity( data + 8 );
5584 if( data_size >= 24 )
5585 mbedtls_des_key_set_parity( data + 16 );
5586}
5587#endif /* MBEDTLS_DES_C */
5588
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005589static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005590 psa_key_slot_t *slot,
5591 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005592 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005593{
5594 uint8_t *data = NULL;
5595 size_t bytes = PSA_BITS_TO_BYTES( bits );
5596 psa_status_t status;
5597
Gilles Peskine8e338702019-07-30 20:06:31 +02005598 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005599 return( PSA_ERROR_INVALID_ARGUMENT );
5600 if( bits % 8 != 0 )
5601 return( PSA_ERROR_INVALID_ARGUMENT );
5602 data = mbedtls_calloc( 1, bytes );
5603 if( data == NULL )
5604 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5605
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005606 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005607 if( status != PSA_SUCCESS )
5608 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005609#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005610 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005611 psa_des_set_key_parity( data, bytes );
5612#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005613 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005614
5615exit:
5616 mbedtls_free( data );
5617 return( status );
5618}
5619
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005620psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005621 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005622 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005623{
5624 psa_status_t status;
5625 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005626 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005627
Ronald Cron81709fc2020-11-14 12:10:32 +01005628 *key = MBEDTLS_SVC_KEY_ID_INIT;
5629
Gilles Peskine0f84d622019-09-12 19:03:13 +02005630 /* Reject any attempt to create a zero-length key so that we don't
5631 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5632 if( psa_get_key_bits( attributes ) == 0 )
5633 return( PSA_ERROR_INVALID_ARGUMENT );
5634
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005635 if( ! operation->can_output_key )
5636 return( PSA_ERROR_NOT_PERMITTED );
5637
Ronald Cron81709fc2020-11-14 12:10:32 +01005638 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5639 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005640#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5641 if( driver != NULL )
5642 {
5643 /* Deriving a key in a secure element is not implemented yet. */
5644 status = PSA_ERROR_NOT_SUPPORTED;
5645 }
5646#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005647 if( status == PSA_SUCCESS )
5648 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005649 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005650 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005651 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005652 }
5653 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005654 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005655 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005656 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005657
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005658 return( status );
5659}
5660
Gilles Peskineeab56e42018-07-12 17:12:33 +02005661
5662
5663/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005664/* Key derivation */
5665/****************************************************************/
5666
John Durkop07cc04a2020-11-16 22:08:34 -08005667#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005668static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005669 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005670 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005671{
John Durkop07cc04a2020-11-16 22:08:34 -08005672 int is_kdf_alg_supported;
5673
Janos Follath5fe19732019-06-20 15:09:30 +01005674 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5675 * initialisers for this union leave some bytes unspecified.) */
5676 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5677
Gilles Peskine969c5d62019-01-16 15:53:06 +01005678 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005679#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005680 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5681 is_kdf_alg_supported = 1;
5682 else
5683#endif
5684#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5685 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5686 is_kdf_alg_supported = 1;
5687 else
5688#endif
5689#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5690 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5691 is_kdf_alg_supported = 1;
5692 else
5693#endif
5694 is_kdf_alg_supported = 0;
5695
5696 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005697 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005698 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005699 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5700 if( hash_size == 0 )
5701 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005702 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5703 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005704 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005705 {
5706 return( PSA_ERROR_NOT_SUPPORTED );
5707 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005708 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005709 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005710 }
John Durkop07cc04a2020-11-16 22:08:34 -08005711
5712 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005713}
John Durkop07cc04a2020-11-16 22:08:34 -08005714#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005715
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005716psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005717 psa_algorithm_t alg )
5718{
5719 psa_status_t status;
5720
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005721 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005722 return( PSA_ERROR_BAD_STATE );
5723
Gilles Peskine6843c292019-01-18 16:44:49 +01005724 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5725 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005726#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005727 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005728 {
5729 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005730 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005731 }
5732 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5733 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005734 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005735 }
John Durkop07cc04a2020-11-16 22:08:34 -08005736#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005737 else
5738 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005739
5740 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005741 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005742 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005743}
5744
John Durkopd0321952020-10-29 21:37:36 -07005745#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005746static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005747 psa_algorithm_t hash_alg,
5748 psa_key_derivation_step_t step,
5749 const uint8_t *data,
5750 size_t data_length )
5751{
5752 psa_status_t status;
5753 switch( step )
5754 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005755 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005756 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005757 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005758 status = psa_hmac_setup_internal( &hkdf->hmac,
5759 data, data_length,
5760 hash_alg );
5761 if( status != PSA_SUCCESS )
5762 return( status );
5763 hkdf->state = HKDF_STATE_STARTED;
5764 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005765 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005766 /* If no salt was provided, use an empty salt. */
5767 if( hkdf->state == HKDF_STATE_INIT )
5768 {
5769 status = psa_hmac_setup_internal( &hkdf->hmac,
5770 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005771 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005772 if( status != PSA_SUCCESS )
5773 return( status );
5774 hkdf->state = HKDF_STATE_STARTED;
5775 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005776 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005777 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005778 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5779 data, data_length );
5780 if( status != PSA_SUCCESS )
5781 return( status );
5782 status = psa_hmac_finish_internal( &hkdf->hmac,
5783 hkdf->prk,
5784 sizeof( hkdf->prk ) );
5785 if( status != PSA_SUCCESS )
5786 return( status );
5787 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5788 hkdf->block_number = 0;
5789 hkdf->state = HKDF_STATE_KEYED;
5790 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005791 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005792 if( hkdf->state == HKDF_STATE_OUTPUT )
5793 return( PSA_ERROR_BAD_STATE );
5794 if( hkdf->info_set )
5795 return( PSA_ERROR_BAD_STATE );
5796 hkdf->info_length = data_length;
5797 if( data_length != 0 )
5798 {
5799 hkdf->info = mbedtls_calloc( 1, data_length );
5800 if( hkdf->info == NULL )
5801 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5802 memcpy( hkdf->info, data, data_length );
5803 }
5804 hkdf->info_set = 1;
5805 return( PSA_SUCCESS );
5806 default:
5807 return( PSA_ERROR_INVALID_ARGUMENT );
5808 }
5809}
John Durkop07cc04a2020-11-16 22:08:34 -08005810#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005811
John Durkop07cc04a2020-11-16 22:08:34 -08005812#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5813 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005814static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5815 const uint8_t *data,
5816 size_t data_length )
5817{
5818 if( prf->state != TLS12_PRF_STATE_INIT )
5819 return( PSA_ERROR_BAD_STATE );
5820
Janos Follathd6dce9f2019-07-04 09:11:38 +01005821 if( data_length != 0 )
5822 {
5823 prf->seed = mbedtls_calloc( 1, data_length );
5824 if( prf->seed == NULL )
5825 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005826
Janos Follathd6dce9f2019-07-04 09:11:38 +01005827 memcpy( prf->seed, data, data_length );
5828 prf->seed_length = data_length;
5829 }
Janos Follathf08e2652019-06-13 09:05:41 +01005830
5831 prf->state = TLS12_PRF_STATE_SEED_SET;
5832
5833 return( PSA_SUCCESS );
5834}
5835
Janos Follath81550542019-06-13 14:26:34 +01005836static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5837 psa_algorithm_t hash_alg,
5838 const uint8_t *data,
5839 size_t data_length )
5840{
5841 psa_status_t status;
5842 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5843 return( PSA_ERROR_BAD_STATE );
5844
5845 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5846 if( status != PSA_SUCCESS )
5847 return( status );
5848
5849 prf->state = TLS12_PRF_STATE_KEY_SET;
5850
5851 return( PSA_SUCCESS );
5852}
5853
Janos Follath63028dd2019-06-13 09:15:47 +01005854static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5855 const uint8_t *data,
5856 size_t data_length )
5857{
5858 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5859 return( PSA_ERROR_BAD_STATE );
5860
Janos Follathd6dce9f2019-07-04 09:11:38 +01005861 if( data_length != 0 )
5862 {
5863 prf->label = mbedtls_calloc( 1, data_length );
5864 if( prf->label == NULL )
5865 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005866
Janos Follathd6dce9f2019-07-04 09:11:38 +01005867 memcpy( prf->label, data, data_length );
5868 prf->label_length = data_length;
5869 }
Janos Follath63028dd2019-06-13 09:15:47 +01005870
5871 prf->state = TLS12_PRF_STATE_LABEL_SET;
5872
5873 return( PSA_SUCCESS );
5874}
5875
Janos Follathb03233e2019-06-11 15:30:30 +01005876static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5877 psa_algorithm_t hash_alg,
5878 psa_key_derivation_step_t step,
5879 const uint8_t *data,
5880 size_t data_length )
5881{
Janos Follathb03233e2019-06-11 15:30:30 +01005882 switch( step )
5883 {
Janos Follathf08e2652019-06-13 09:05:41 +01005884 case PSA_KEY_DERIVATION_INPUT_SEED:
5885 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005886 case PSA_KEY_DERIVATION_INPUT_SECRET:
5887 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005888 case PSA_KEY_DERIVATION_INPUT_LABEL:
5889 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005890 default:
5891 return( PSA_ERROR_INVALID_ARGUMENT );
5892 }
5893}
John Durkop07cc04a2020-11-16 22:08:34 -08005894#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5895 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5896
5897#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5898static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5899 psa_tls12_prf_key_derivation_t *prf,
5900 psa_algorithm_t hash_alg,
5901 const uint8_t *data,
5902 size_t data_length )
5903{
5904 psa_status_t status;
5905 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5906 uint8_t *cur = pms;
5907
5908 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5909 return( PSA_ERROR_INVALID_ARGUMENT );
5910
5911 /* Quoting RFC 4279, Section 2:
5912 *
5913 * The premaster secret is formed as follows: if the PSK is N octets
5914 * long, concatenate a uint16 with the value N, N zero octets, a second
5915 * uint16 with the value N, and the PSK itself.
5916 */
5917
5918 *cur++ = ( data_length >> 8 ) & 0xff;
5919 *cur++ = ( data_length >> 0 ) & 0xff;
5920 memset( cur, 0, data_length );
5921 cur += data_length;
5922 *cur++ = pms[0];
5923 *cur++ = pms[1];
5924 memcpy( cur, data, data_length );
5925 cur += data_length;
5926
5927 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5928
5929 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5930 return( status );
5931}
Janos Follath6660f0e2019-06-17 08:44:03 +01005932
5933static psa_status_t psa_tls12_prf_psk_to_ms_input(
5934 psa_tls12_prf_key_derivation_t *prf,
5935 psa_algorithm_t hash_alg,
5936 psa_key_derivation_step_t step,
5937 const uint8_t *data,
5938 size_t data_length )
5939{
5940 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005941 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005942 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5943 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005944 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005945
5946 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5947}
John Durkop07cc04a2020-11-16 22:08:34 -08005948#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005949
Gilles Peskineb8965192019-09-24 16:21:10 +02005950/** Check whether the given key type is acceptable for the given
5951 * input step of a key derivation.
5952 *
5953 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5954 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5955 * Both secret and non-secret inputs can alternatively have the type
5956 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5957 * that the input was passed as a buffer rather than via a key object.
5958 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005959static int psa_key_derivation_check_input_type(
5960 psa_key_derivation_step_t step,
5961 psa_key_type_t key_type )
5962{
5963 switch( step )
5964 {
5965 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005966 if( key_type == PSA_KEY_TYPE_DERIVE )
5967 return( PSA_SUCCESS );
5968 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005969 return( PSA_SUCCESS );
5970 break;
5971 case PSA_KEY_DERIVATION_INPUT_LABEL:
5972 case PSA_KEY_DERIVATION_INPUT_SALT:
5973 case PSA_KEY_DERIVATION_INPUT_INFO:
5974 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005975 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5976 return( PSA_SUCCESS );
5977 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005978 return( PSA_SUCCESS );
5979 break;
5980 }
5981 return( PSA_ERROR_INVALID_ARGUMENT );
5982}
5983
Janos Follathb80a94e2019-06-12 15:54:46 +01005984static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005985 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005986 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005987 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005988 const uint8_t *data,
5989 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005990{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005991 psa_status_t status;
5992 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5993
5994 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005995 if( status != PSA_SUCCESS )
5996 goto exit;
5997
John Durkopd0321952020-10-29 21:37:36 -07005998#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005999 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006000 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006001 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006002 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006003 step, data, data_length );
6004 }
John Durkop07cc04a2020-11-16 22:08:34 -08006005 else
6006#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
6007#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
6008 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006009 {
Janos Follathb03233e2019-06-11 15:30:30 +01006010 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
6011 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
6012 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01006013 }
John Durkop07cc04a2020-11-16 22:08:34 -08006014 else
6015#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6016#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6017 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01006018 {
6019 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
6020 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
6021 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006022 }
6023 else
John Durkop07cc04a2020-11-16 22:08:34 -08006024#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006025 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006026 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006027 return( PSA_ERROR_BAD_STATE );
6028 }
6029
Gilles Peskine224b0d62019-09-23 18:13:17 +02006030exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006031 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006032 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006033 return( status );
6034}
6035
Janos Follath51f4a0f2019-06-14 11:35:55 +01006036psa_status_t psa_key_derivation_input_bytes(
6037 psa_key_derivation_operation_t *operation,
6038 psa_key_derivation_step_t step,
6039 const uint8_t *data,
6040 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006041{
Gilles Peskineb8965192019-09-24 16:21:10 +02006042 return( psa_key_derivation_input_internal( operation, step,
6043 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01006044 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006045}
6046
Janos Follath51f4a0f2019-06-14 11:35:55 +01006047psa_status_t psa_key_derivation_input_key(
6048 psa_key_derivation_operation_t *operation,
6049 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006050 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006051{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006052 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006053 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006054 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006055
Ronald Cron5c522922020-11-14 16:35:34 +01006056 status = psa_get_and_lock_transparent_key_slot_with_policy(
6057 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006058 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02006059 {
6060 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006061 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02006062 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006063
6064 /* Passing a key object as a SECRET input unlocks the permission
6065 * to output to a key object. */
6066 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6067 operation->can_output_key = 1;
6068
Ronald Cronf95a2b12020-10-22 15:24:49 +02006069 status = psa_key_derivation_input_internal( operation,
6070 step, slot->attr.type,
6071 slot->data.key.data,
6072 slot->data.key.bytes );
6073
Ronald Cron5c522922020-11-14 16:35:34 +01006074 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006075
Ronald Cron5c522922020-11-14 16:35:34 +01006076 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006077}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006078
6079
6080
6081/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006082/* Key agreement */
6083/****************************************************************/
6084
John Durkop6ba40d12020-11-10 08:50:04 -08006085#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006086static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
6087 size_t peer_key_length,
6088 const mbedtls_ecp_keypair *our_key,
6089 uint8_t *shared_secret,
6090 size_t shared_secret_size,
6091 size_t *shared_secret_length )
6092{
Steven Cooremand4867872020-08-05 16:31:39 +02006093 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006094 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00006095 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006096 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01006097 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006098 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006099
Steven Cooreman4fed4552020-08-03 14:46:03 +02006100 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
6101 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02006102 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02006103 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00006104 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006105 goto exit;
6106
Jaeden Amero97271b32019-01-10 19:38:51 +00006107 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02006108 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00006109 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006110 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00006111 status = mbedtls_to_psa_error(
6112 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
6113 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006114 goto exit;
6115
Jaeden Amero97271b32019-01-10 19:38:51 +00006116 status = mbedtls_to_psa_error(
6117 mbedtls_ecdh_calc_secret( &ecdh,
6118 shared_secret_length,
6119 shared_secret, shared_secret_size,
6120 mbedtls_ctr_drbg_random,
6121 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006122 if( status != PSA_SUCCESS )
6123 goto exit;
6124 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
6125 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006126
6127exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01006128 if( status != PSA_SUCCESS )
6129 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006130 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02006131 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02006132 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02006133
Jaeden Amero97271b32019-01-10 19:38:51 +00006134 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006135}
John Durkop6ba40d12020-11-10 08:50:04 -08006136#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006137
Gilles Peskine01d718c2018-09-18 12:01:02 +02006138#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6139
Gilles Peskine0216fe12019-04-11 21:23:21 +02006140static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6141 psa_key_slot_t *private_key,
6142 const uint8_t *peer_key,
6143 size_t peer_key_length,
6144 uint8_t *shared_secret,
6145 size_t shared_secret_size,
6146 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006147{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006148 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006149 {
John Durkop6ba40d12020-11-10 08:50:04 -08006150#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006151 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006152 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006153 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006154 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02006155 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02006156 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02006157 private_key->data.key.data,
6158 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02006159 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006160 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006161 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006162 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006163 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006164 shared_secret, shared_secret_size,
6165 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006166 mbedtls_ecp_keypair_free( ecp );
6167 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006168 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08006169#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006170 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006171 (void) private_key;
6172 (void) peer_key;
6173 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006174 (void) shared_secret;
6175 (void) shared_secret_size;
6176 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006177 return( PSA_ERROR_NOT_SUPPORTED );
6178 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006179}
6180
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006181/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006182 * to potentially free embedded data structures and wipe confidential data.
6183 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006184static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006185 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006186 psa_key_slot_t *private_key,
6187 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006188 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006189{
6190 psa_status_t status;
6191 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6192 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006193 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006194
6195 /* Step 1: run the secret agreement algorithm to generate the shared
6196 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006197 status = psa_key_agreement_raw_internal( ka_alg,
6198 private_key,
6199 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006200 shared_secret,
6201 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006202 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006203 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006204 goto exit;
6205
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006206 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006207 * the shared secret. A shared secret is permitted wherever a key
6208 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006209 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006210 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006211 shared_secret,
6212 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006213exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006214 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006215 return( status );
6216}
6217
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006218psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006219 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006220 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006221 const uint8_t *peer_key,
6222 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006223{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006224 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006225 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006226 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006227
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006228 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006229 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01006230 status = psa_get_and_lock_transparent_key_slot_with_policy(
6231 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006232 if( status != PSA_SUCCESS )
6233 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006234 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006235 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006236 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006237 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006238 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006239 else
6240 {
6241 /* If a private key has been added as SECRET, we allow the derived
6242 * key material to be used as a key in PSA Crypto. */
6243 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6244 operation->can_output_key = 1;
6245 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006246
Ronald Cron5c522922020-11-14 16:35:34 +01006247 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006248
Ronald Cron5c522922020-11-14 16:35:34 +01006249 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006250}
6251
Gilles Peskinebe697d82019-05-16 18:00:41 +02006252psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006253 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006254 const uint8_t *peer_key,
6255 size_t peer_key_length,
6256 uint8_t *output,
6257 size_t output_size,
6258 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006259{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006260 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006261 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006262 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006263
6264 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6265 {
6266 status = PSA_ERROR_INVALID_ARGUMENT;
6267 goto exit;
6268 }
Ronald Cron5c522922020-11-14 16:35:34 +01006269 status = psa_get_and_lock_transparent_key_slot_with_policy(
6270 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006271 if( status != PSA_SUCCESS )
6272 goto exit;
6273
6274 status = psa_key_agreement_raw_internal( alg, slot,
6275 peer_key, peer_key_length,
6276 output, output_size,
6277 output_length );
6278
6279exit:
6280 if( status != PSA_SUCCESS )
6281 {
6282 /* If an error happens and is not handled properly, the output
6283 * may be used as a key to protect sensitive data. Arrange for such
6284 * a key to be random, which is likely to result in decryption or
6285 * verification errors. This is better than filling the buffer with
6286 * some constant data such as zeros, which would result in the data
6287 * being protected with a reproducible, easily knowable key.
6288 */
6289 psa_generate_random( output, output_size );
6290 *output_length = output_size;
6291 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006292
Ronald Cron5c522922020-11-14 16:35:34 +01006293 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006294
Ronald Cron5c522922020-11-14 16:35:34 +01006295 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006296}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006297
6298
6299/****************************************************************/
6300/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006301/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006302
Gilles Peskine4c317f42018-07-12 01:24:09 +02006303psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006304 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006305{
Janos Follath24eed8d2019-11-22 13:21:35 +00006306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006307 GUARD_MODULE_INITIALIZED;
6308
Gilles Peskinef181eca2019-08-07 13:49:00 +02006309 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6310 {
6311 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6312 output,
6313 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6314 if( ret != 0 )
6315 return( mbedtls_to_psa_error( ret ) );
6316 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6317 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6318 }
6319
Gilles Peskinee59236f2018-01-27 23:32:46 +01006320 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6321 return( mbedtls_to_psa_error( ret ) );
6322}
6323
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006324#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6325#include "mbedtls/entropy_poll.h"
6326
Gilles Peskine7228da22019-07-15 11:06:15 +02006327psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006328 size_t seed_size )
6329{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006330 if( global_data.initialized )
6331 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006332
6333 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6334 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6335 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6336 return( PSA_ERROR_INVALID_ARGUMENT );
6337
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006338 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006339}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006340#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006341
John Durkop07cc04a2020-11-16 22:08:34 -08006342#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006343static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6344 size_t domain_parameters_size,
6345 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006346{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006347 size_t i;
6348 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006349
Gilles Peskinee56e8782019-04-26 17:34:02 +02006350 if( domain_parameters_size == 0 )
6351 {
6352 *exponent = 65537;
6353 return( PSA_SUCCESS );
6354 }
6355
6356 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6357 * support values that fit in a 32-bit integer, which is larger than
6358 * int on just about every platform anyway. */
6359 if( domain_parameters_size > sizeof( acc ) )
6360 return( PSA_ERROR_NOT_SUPPORTED );
6361 for( i = 0; i < domain_parameters_size; i++ )
6362 acc = ( acc << 8 ) | domain_parameters[i];
6363 if( acc > INT_MAX )
6364 return( PSA_ERROR_NOT_SUPPORTED );
6365 *exponent = acc;
6366 return( PSA_SUCCESS );
6367}
John Durkop07cc04a2020-11-16 22:08:34 -08006368#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006369
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006370static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006371 psa_key_slot_t *slot, size_t bits,
6372 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006373{
Gilles Peskine8e338702019-07-30 20:06:31 +02006374 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006375
Gilles Peskinee56e8782019-04-26 17:34:02 +02006376 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006377 return( PSA_ERROR_INVALID_ARGUMENT );
6378
Gilles Peskinee59236f2018-01-27 23:32:46 +01006379 if( key_type_is_raw_bytes( type ) )
6380 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006381 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006382
6383 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006384 if( status != PSA_SUCCESS )
6385 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006386
6387 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006388 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6389 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006390 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006391
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006392 status = psa_generate_random( slot->data.key.data,
6393 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006394 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006395 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006396
6397 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006398#if defined(MBEDTLS_DES_C)
6399 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006400 psa_des_set_key_parity( slot->data.key.data,
6401 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006402#endif /* MBEDTLS_DES_C */
6403 }
6404 else
6405
John Durkop07cc04a2020-11-16 22:08:34 -08006406#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006407 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006408 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006409 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006410 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006411 int exponent;
6412 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006413 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6414 return( PSA_ERROR_NOT_SUPPORTED );
6415 /* Accept only byte-aligned keys, for the same reasons as
6416 * in psa_import_rsa_key(). */
6417 if( bits % 8 != 0 )
6418 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006419 status = psa_read_rsa_exponent( domain_parameters,
6420 domain_parameters_size,
6421 &exponent );
6422 if( status != PSA_SUCCESS )
6423 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006424 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6425 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006426 mbedtls_ctr_drbg_random,
6427 &global_data.ctr_drbg,
6428 (unsigned int) bits,
6429 exponent );
6430 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006431 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006432
6433 /* Make sure to always have an export representation available */
6434 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6435
Steven Cooreman75b74362020-07-28 14:30:13 +02006436 status = psa_allocate_buffer_to_slot( slot, bytes );
6437 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006438 {
6439 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006440 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006441 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006442
6443 status = psa_export_rsa_key( type,
6444 &rsa,
6445 slot->data.key.data,
6446 bytes,
6447 &slot->data.key.bytes );
6448 mbedtls_rsa_free( &rsa );
6449 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006450 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006451 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006452 }
6453 else
John Durkop07cc04a2020-11-16 22:08:34 -08006454#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006455
John Durkop9814fa22020-11-04 12:28:15 -08006456#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006457 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006458 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006459 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006460 mbedtls_ecp_group_id grp_id =
6461 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006462 const mbedtls_ecp_curve_info *curve_info =
6463 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006464 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006465 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006466 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006467 return( PSA_ERROR_NOT_SUPPORTED );
6468 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6469 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006470 mbedtls_ecp_keypair_init( &ecp );
6471 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006472 mbedtls_ctr_drbg_random,
6473 &global_data.ctr_drbg );
6474 if( ret != 0 )
6475 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006476 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006477 return( mbedtls_to_psa_error( ret ) );
6478 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006479
6480
6481 /* Make sure to always have an export representation available */
6482 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006483 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6484 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006485 {
6486 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006487 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006488 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006489
6490 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006491 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6492
6493 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006494 if( status != PSA_SUCCESS ) {
6495 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006496 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006497 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006498 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006499 }
6500 else
John Durkop9814fa22020-11-04 12:28:15 -08006501#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006502 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006503 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006504 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006505
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006506 return( PSA_SUCCESS );
6507}
Darryl Green0c6575a2018-11-07 16:05:30 +00006508
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006509psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006510 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006511{
6512 psa_status_t status;
6513 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006514 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006515
Ronald Cron81709fc2020-11-14 12:10:32 +01006516 *key = MBEDTLS_SVC_KEY_ID_INIT;
6517
Gilles Peskine0f84d622019-09-12 19:03:13 +02006518 /* Reject any attempt to create a zero-length key so that we don't
6519 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6520 if( psa_get_key_bits( attributes ) == 0 )
6521 return( PSA_ERROR_INVALID_ARGUMENT );
6522
Ronald Cron81709fc2020-11-14 12:10:32 +01006523 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6524 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006525 if( status != PSA_SUCCESS )
6526 goto exit;
6527
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006528 status = psa_driver_wrapper_generate_key( attributes,
6529 slot );
6530 if( status != PSA_ERROR_NOT_SUPPORTED ||
6531 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6532 goto exit;
6533
6534 status = psa_generate_key_internal(
6535 slot, attributes->core.bits,
6536 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006537
6538exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006539 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006540 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006541 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006542 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006543
Darryl Green0c6575a2018-11-07 16:05:30 +00006544 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006545}
6546
6547
Gilles Peskinee59236f2018-01-27 23:32:46 +01006548
6549/****************************************************************/
6550/* Module setup */
6551/****************************************************************/
6552
Gilles Peskine5e769522018-11-20 21:59:56 +01006553psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6554 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6555 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6556{
6557 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6558 return( PSA_ERROR_BAD_STATE );
6559 global_data.entropy_init = entropy_init;
6560 global_data.entropy_free = entropy_free;
6561 return( PSA_SUCCESS );
6562}
6563
Gilles Peskinee59236f2018-01-27 23:32:46 +01006564void mbedtls_psa_crypto_free( void )
6565{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006566 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006567 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6568 {
6569 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006570 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006571 }
6572 /* Wipe all remaining data, including configuration.
6573 * In particular, this sets all state indicator to the value
6574 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006575 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006576#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006577 /* Unregister all secure element drivers, so that we restart from
6578 * a pristine state. */
6579 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006580#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006581}
6582
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006583#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6584/** Recover a transaction that was interrupted by a power failure.
6585 *
6586 * This function is called during initialization, before psa_crypto_init()
6587 * returns. If this function returns a failure status, the initialization
6588 * fails.
6589 */
6590static psa_status_t psa_crypto_recover_transaction(
6591 const psa_crypto_transaction_t *transaction )
6592{
6593 switch( transaction->unknown.type )
6594 {
6595 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6596 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006597 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006598 * is implemented.
6599 * https://github.com/ARMmbed/mbed-crypto/issues/218
6600 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006601 default:
6602 /* We found an unsupported transaction in the storage.
6603 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006604 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006605 }
6606}
6607#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6608
Gilles Peskinee59236f2018-01-27 23:32:46 +01006609psa_status_t psa_crypto_init( void )
6610{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006611 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006612 const unsigned char drbg_seed[] = "PSA";
6613
Gilles Peskinec6b69072018-11-20 21:42:52 +01006614 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006615 if( global_data.initialized != 0 )
6616 return( PSA_SUCCESS );
6617
Gilles Peskine5e769522018-11-20 21:59:56 +01006618 /* Set default configuration if
6619 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6620 if( global_data.entropy_init == NULL )
6621 global_data.entropy_init = mbedtls_entropy_init;
6622 if( global_data.entropy_free == NULL )
6623 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006624
Gilles Peskinec6b69072018-11-20 21:42:52 +01006625 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006626 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006627#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6628 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6629 /* The PSA entropy injection feature depends on using NV seed as an entropy
6630 * source. Add NV seed as an entropy source for PSA entropy injection. */
6631 mbedtls_entropy_add_source( &global_data.entropy,
6632 mbedtls_nv_seed_poll, NULL,
6633 MBEDTLS_ENTROPY_BLOCK_SIZE,
6634 MBEDTLS_ENTROPY_SOURCE_STRONG );
6635#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006636 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006637 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006638 status = mbedtls_to_psa_error(
6639 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6640 mbedtls_entropy_func,
6641 &global_data.entropy,
6642 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6643 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006644 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006645 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006646
Gilles Peskine66fb1262018-12-10 16:29:04 +01006647 status = psa_initialize_key_slots( );
6648 if( status != PSA_SUCCESS )
6649 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006650
Gilles Peskined9348f22019-10-01 15:22:29 +02006651#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6652 status = psa_init_all_se_drivers( );
6653 if( status != PSA_SUCCESS )
6654 goto exit;
6655#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6656
Gilles Peskine4b734222019-07-24 15:56:31 +02006657#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006658 status = psa_crypto_load_transaction( );
6659 if( status == PSA_SUCCESS )
6660 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006661 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6662 if( status != PSA_SUCCESS )
6663 goto exit;
6664 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006665 }
6666 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6667 {
6668 /* There's no transaction to complete. It's all good. */
6669 status = PSA_SUCCESS;
6670 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006671#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006672
Gilles Peskinec6b69072018-11-20 21:42:52 +01006673 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006674 global_data.initialized = 1;
6675
6676exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006677 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006678 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006679 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006680}
6681
6682#endif /* MBEDTLS_PSA_CRYPTO_C */