blob: 30261a519444195156d4f08b09603a82f0618f4c [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020036#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010038#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010039/* Include internal declarations that are useful for implementing persistently
40 * stored keys. */
41#include "psa_crypto_storage.h"
42
Gilles Peskineb46bef22019-07-30 21:32:04 +020043#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include <stdlib.h>
45#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010046#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020047#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#define mbedtls_calloc calloc
49#define mbedtls_free free
50#endif
51
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020053#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000054#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020055#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/blowfish.h"
57#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020058#include "mbedtls/chacha20.h"
59#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/cipher.h"
61#include "mbedtls/ccm.h"
62#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020065#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010067#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/error.h"
69#include "mbedtls/gcm.h"
70#include "mbedtls/md2.h"
71#include "mbedtls/md4.h"
72#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010073#include "mbedtls/md.h"
74#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010075#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010077#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000078#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010079#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010080#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010081#include "mbedtls/sha1.h"
82#include "mbedtls/sha256.h"
83#include "mbedtls/sha512.h"
84#include "mbedtls/xtea.h"
85
Gilles Peskine996deb12018-08-01 15:45:45 +020086#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
87
Gilles Peskine9ef733f2018-02-07 21:05:37 +010088/* constant-time buffer comparison */
89static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
90{
91 size_t i;
92 unsigned char diff = 0;
93
94 for( i = 0; i < n; i++ )
95 diff |= a[i] ^ b[i];
96
97 return( diff );
98}
99
100
101
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100102/****************************************************************/
103/* Global data, support functions and library management */
104/****************************************************************/
105
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200106static int key_type_is_raw_bytes( psa_key_type_t type )
107{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200108 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200109}
110
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100111/* Values for psa_global_data_t::rng_state */
112#define RNG_NOT_INITIALIZED 0
113#define RNG_INITIALIZED 1
114#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100115
Gilles Peskine2d277862018-06-18 15:41:12 +0200116typedef struct
117{
Gilles Peskine5e769522018-11-20 21:59:56 +0100118 void (* entropy_init )( mbedtls_entropy_context *ctx );
119 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120 mbedtls_entropy_context entropy;
121 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100122 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100123 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100124} psa_global_data_t;
125
126static psa_global_data_t global_data;
127
itayzafrir0adf0fc2018-09-06 16:24:41 +0300128#define GUARD_MODULE_INITIALIZED \
129 if( global_data.initialized == 0 ) \
130 return( PSA_ERROR_BAD_STATE );
131
Steven Cooreman01164162020-07-20 15:31:37 +0200132psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133{
Gilles Peskinea5905292018-02-07 20:59:33 +0100134 /* If there's both a high-level code and low-level code, dispatch on
135 * the high-level code. */
136 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100137 {
138 case 0:
139 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100140
141 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
142 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
143 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
144 return( PSA_ERROR_NOT_SUPPORTED );
145 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
146 return( PSA_ERROR_HARDWARE_FAILURE );
147
148 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
149 return( PSA_ERROR_HARDWARE_FAILURE );
150
Gilles Peskine9a944802018-06-21 09:35:35 +0200151 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
152 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
153 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
154 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
155 case MBEDTLS_ERR_ASN1_INVALID_DATA:
156 return( PSA_ERROR_INVALID_ARGUMENT );
157 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
158 return( PSA_ERROR_INSUFFICIENT_MEMORY );
159 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
160 return( PSA_ERROR_BUFFER_TOO_SMALL );
161
Jaeden Amero93e21112019-02-20 13:57:28 +0000162#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000163 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000164#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
165 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
166#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
168 return( PSA_ERROR_NOT_SUPPORTED );
169 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
170 return( PSA_ERROR_HARDWARE_FAILURE );
171
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000173 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000174#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
175 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
178 return( PSA_ERROR_NOT_SUPPORTED );
179 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
180 return( PSA_ERROR_HARDWARE_FAILURE );
181
182 case MBEDTLS_ERR_CCM_BAD_INPUT:
183 return( PSA_ERROR_INVALID_ARGUMENT );
184 case MBEDTLS_ERR_CCM_AUTH_FAILED:
185 return( PSA_ERROR_INVALID_SIGNATURE );
186 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
187 return( PSA_ERROR_HARDWARE_FAILURE );
188
Gilles Peskine26869f22019-05-06 15:25:00 +0200189 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
190 return( PSA_ERROR_INVALID_ARGUMENT );
191
192 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
193 return( PSA_ERROR_BAD_STATE );
194 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
195 return( PSA_ERROR_INVALID_SIGNATURE );
196
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
198 return( PSA_ERROR_NOT_SUPPORTED );
199 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
200 return( PSA_ERROR_INVALID_ARGUMENT );
201 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
202 return( PSA_ERROR_INSUFFICIENT_MEMORY );
203 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
204 return( PSA_ERROR_INVALID_PADDING );
205 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200206 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
208 return( PSA_ERROR_INVALID_SIGNATURE );
209 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200210 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
212 return( PSA_ERROR_HARDWARE_FAILURE );
213
214 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
215 return( PSA_ERROR_HARDWARE_FAILURE );
216
217 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
218 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
219 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
220 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
223 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
224
225 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
226 return( PSA_ERROR_NOT_SUPPORTED );
227 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
228 return( PSA_ERROR_HARDWARE_FAILURE );
229
Gilles Peskinee59236f2018-01-27 23:32:46 +0100230 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
231 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
232 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
233 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100234
235 case MBEDTLS_ERR_GCM_AUTH_FAILED:
236 return( PSA_ERROR_INVALID_SIGNATURE );
237 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200238 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100239 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
240 return( PSA_ERROR_HARDWARE_FAILURE );
241
242 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
243 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
244 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
245 return( PSA_ERROR_HARDWARE_FAILURE );
246
247 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
248 return( PSA_ERROR_NOT_SUPPORTED );
249 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_MD_ALLOC_FAILED:
252 return( PSA_ERROR_INSUFFICIENT_MEMORY );
253 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
254 return( PSA_ERROR_STORAGE_FAILURE );
255 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
256 return( PSA_ERROR_HARDWARE_FAILURE );
257
Gilles Peskinef76aa772018-10-29 19:24:33 +0100258 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
259 return( PSA_ERROR_STORAGE_FAILURE );
260 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
261 return( PSA_ERROR_INVALID_ARGUMENT );
262 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
265 return( PSA_ERROR_BUFFER_TOO_SMALL );
266 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
269 return( PSA_ERROR_INVALID_ARGUMENT );
270 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
271 return( PSA_ERROR_INVALID_ARGUMENT );
272 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
274
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100275 case MBEDTLS_ERR_PK_ALLOC_FAILED:
276 return( PSA_ERROR_INSUFFICIENT_MEMORY );
277 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
278 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
279 return( PSA_ERROR_INVALID_ARGUMENT );
280 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100281 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100282 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
283 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
286 return( PSA_ERROR_NOT_SUPPORTED );
287 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
288 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
289 return( PSA_ERROR_NOT_PERMITTED );
290 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
291 return( PSA_ERROR_INVALID_ARGUMENT );
292 case MBEDTLS_ERR_PK_INVALID_ALG:
293 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
294 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
295 return( PSA_ERROR_NOT_SUPPORTED );
296 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
297 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100298 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
299 return( PSA_ERROR_HARDWARE_FAILURE );
300
Gilles Peskineff2d2002019-05-06 15:26:23 +0200301 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
302 return( PSA_ERROR_HARDWARE_FAILURE );
303 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
304 return( PSA_ERROR_NOT_SUPPORTED );
305
Gilles Peskinea5905292018-02-07 20:59:33 +0100306 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
307 return( PSA_ERROR_HARDWARE_FAILURE );
308
309 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
310 return( PSA_ERROR_INVALID_ARGUMENT );
311 case MBEDTLS_ERR_RSA_INVALID_PADDING:
312 return( PSA_ERROR_INVALID_PADDING );
313 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
314 return( PSA_ERROR_HARDWARE_FAILURE );
315 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
316 return( PSA_ERROR_INVALID_ARGUMENT );
317 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
318 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200319 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
321 return( PSA_ERROR_INVALID_SIGNATURE );
322 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
323 return( PSA_ERROR_BUFFER_TOO_SMALL );
324 case MBEDTLS_ERR_RSA_RNG_FAILED:
325 return( PSA_ERROR_INSUFFICIENT_MEMORY );
326 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
327 return( PSA_ERROR_NOT_SUPPORTED );
328 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
329 return( PSA_ERROR_HARDWARE_FAILURE );
330
331 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
332 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
333 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
334 return( PSA_ERROR_HARDWARE_FAILURE );
335
336 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
337 return( PSA_ERROR_INVALID_ARGUMENT );
338 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
339 return( PSA_ERROR_HARDWARE_FAILURE );
340
itayzafrir5c753392018-05-08 11:18:38 +0300341 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300342 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300343 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
345 return( PSA_ERROR_BUFFER_TOO_SMALL );
346 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
347 return( PSA_ERROR_NOT_SUPPORTED );
348 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
349 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
350 return( PSA_ERROR_INVALID_SIGNATURE );
351 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
352 return( PSA_ERROR_INSUFFICIENT_MEMORY );
353 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
354 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000355 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
356 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300357
Gilles Peskinee59236f2018-01-27 23:32:46 +0100358 default:
David Saadab4ecc272019-02-14 13:48:10 +0200359 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100360 }
361}
362
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200363
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200364
365
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100366/****************************************************************/
367/* Key management */
368/****************************************************************/
369
Gilles Peskine73167e12019-07-12 23:44:37 +0200370#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
371static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
372{
Gilles Peskine8e338702019-07-30 20:06:31 +0200373 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200374}
375#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
376
John Durkop07cc04a2020-11-16 22:08:34 -0800377/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
378 * current test driver in key_management.c is using this function
379 * when accelerators are used for ECC key pair and public key.
380 * Once that dependency is resolved these guards can be removed.
381 */
John Durkop9814fa22020-11-04 12:28:15 -0800382#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800383 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
384 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
385 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100386mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100387 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200388{
389 switch( curve )
390 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100391 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 switch( byte_length )
393 {
394 case PSA_BITS_TO_BYTES( 192 ):
395 return( MBEDTLS_ECP_DP_SECP192R1 );
396 case PSA_BITS_TO_BYTES( 224 ):
397 return( MBEDTLS_ECP_DP_SECP224R1 );
398 case PSA_BITS_TO_BYTES( 256 ):
399 return( MBEDTLS_ECP_DP_SECP256R1 );
400 case PSA_BITS_TO_BYTES( 384 ):
401 return( MBEDTLS_ECP_DP_SECP384R1 );
402 case PSA_BITS_TO_BYTES( 521 ):
403 return( MBEDTLS_ECP_DP_SECP521R1 );
404 default:
405 return( MBEDTLS_ECP_DP_NONE );
406 }
407 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100408
Paul Elliott8ff510a2020-06-02 17:19:28 +0100409 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 switch( byte_length )
411 {
412 case PSA_BITS_TO_BYTES( 256 ):
413 return( MBEDTLS_ECP_DP_BP256R1 );
414 case PSA_BITS_TO_BYTES( 384 ):
415 return( MBEDTLS_ECP_DP_BP384R1 );
416 case PSA_BITS_TO_BYTES( 512 ):
417 return( MBEDTLS_ECP_DP_BP512R1 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 255 ):
427 return( MBEDTLS_ECP_DP_CURVE25519 );
428 case PSA_BITS_TO_BYTES( 448 ):
429 return( MBEDTLS_ECP_DP_CURVE448 );
430 default:
431 return( MBEDTLS_ECP_DP_NONE );
432 }
433 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100434
Paul Elliott8ff510a2020-06-02 17:19:28 +0100435 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100436 switch( byte_length )
437 {
438 case PSA_BITS_TO_BYTES( 192 ):
439 return( MBEDTLS_ECP_DP_SECP192K1 );
440 case PSA_BITS_TO_BYTES( 224 ):
441 return( MBEDTLS_ECP_DP_SECP224K1 );
442 case PSA_BITS_TO_BYTES( 256 ):
443 return( MBEDTLS_ECP_DP_SECP256K1 );
444 default:
445 return( MBEDTLS_ECP_DP_NONE );
446 }
447 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100448
Gilles Peskine12313cd2018-06-20 00:20:32 +0200449 default:
450 return( MBEDTLS_ECP_DP_NONE );
451 }
452}
John Durkop9814fa22020-11-04 12:28:15 -0800453#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800454 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
455 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
456 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200457
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200458static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
459 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200460{
461 /* Check that the bit size is acceptable for the key type */
462 switch( type )
463 {
464 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200465 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200466 case PSA_KEY_TYPE_DERIVE:
467 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200468#if defined(MBEDTLS_AES_C)
469 case PSA_KEY_TYPE_AES:
470 if( bits != 128 && bits != 192 && bits != 256 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
472 break;
473#endif
474#if defined(MBEDTLS_CAMELLIA_C)
475 case PSA_KEY_TYPE_CAMELLIA:
476 if( bits != 128 && bits != 192 && bits != 256 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
478 break;
479#endif
480#if defined(MBEDTLS_DES_C)
481 case PSA_KEY_TYPE_DES:
482 if( bits != 64 && bits != 128 && bits != 192 )
483 return( PSA_ERROR_INVALID_ARGUMENT );
484 break;
485#endif
486#if defined(MBEDTLS_ARC4_C)
487 case PSA_KEY_TYPE_ARC4:
488 if( bits < 8 || bits > 2048 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
490 break;
491#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200492#if defined(MBEDTLS_CHACHA20_C)
493 case PSA_KEY_TYPE_CHACHA20:
494 if( bits != 256 )
495 return( PSA_ERROR_INVALID_ARGUMENT );
496 break;
497#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200498 default:
499 return( PSA_ERROR_NOT_SUPPORTED );
500 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200501 if( bits % 8 != 0 )
502 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200503
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200504 return( PSA_SUCCESS );
505}
506
John Durkop0e005192020-10-31 22:06:54 -0700507#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
508 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
509 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
John Durkop9814fa22020-11-04 12:28:15 -0800510 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
511 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
512 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooremana01795d2020-07-24 22:48:15 +0200513
Gilles Peskine86a440b2018-11-12 18:39:40 +0100514/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
515 * that are not a multiple of 8) well. For example, there is only
516 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
517 * way to return the exact bit size of a key.
518 * To keep things simple, reject non-byte-aligned key sizes. */
519static psa_status_t psa_check_rsa_key_byte_aligned(
520 const mbedtls_rsa_context *rsa )
521{
522 mbedtls_mpi n;
523 psa_status_t status;
524 mbedtls_mpi_init( &n );
525 status = mbedtls_to_psa_error(
526 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
527 if( status == PSA_SUCCESS )
528 {
529 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
530 status = PSA_ERROR_NOT_SUPPORTED;
531 }
532 mbedtls_mpi_free( &n );
533 return( status );
534}
535
Steven Cooreman7f391872020-07-30 14:57:44 +0200536/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200538 * \param[in] type The type of key contained in \p data.
539 * \param[in] data The buffer from which to load the representation.
540 * \param[in] data_length The size in bytes of \p data.
541 * \param[out] p_rsa Returns a pointer to an RSA context on success.
542 * The caller is responsible for freeing both the
543 * contents of the context and the context itself
544 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200545 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200546static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
547 const uint8_t *data,
548 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200549 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200550{
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000551 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200552 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000553 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200554 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555
556 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200557 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200559 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200560 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000561 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200562 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( status != PSA_SUCCESS )
564 goto exit;
565
566 /* We have something that the pkparse module recognizes. If it is a
567 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200569 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000570 status = PSA_ERROR_INVALID_ARGUMENT;
571 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200572 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000573
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000574 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
575 * supports non-byte-aligned key sizes, but not well. For example,
576 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200577 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000578 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
579 {
580 status = PSA_ERROR_NOT_SUPPORTED;
581 goto exit;
582 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200583 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 if( status != PSA_SUCCESS )
585 goto exit;
586
Steven Cooremana2371e52020-07-28 14:30:39 +0200587 /* Copy out the pointer to the RSA context, and reset the PK context
588 * such that pk_free doesn't free the RSA context we just grabbed. */
589 *p_rsa = mbedtls_pk_rsa( ctx );
590 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000591
592exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200593 mbedtls_pk_free( &ctx );
594 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +0200595}
596
John Durkop6ba40d12020-11-10 08:50:04 -0800597#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
598 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
599 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
600 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
601 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
602 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
603
604#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
605 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
606
Steven Cooremana01795d2020-07-24 22:48:15 +0200607/** Export an RSA key to export representation
608 *
609 * \param[in] type The type of key (public/private) to export
610 * \param[in] rsa The internal RSA representation from which to export
611 * \param[out] data The buffer to export to
612 * \param[in] data_size The length of the buffer to export to
613 * \param[out] data_length The amount of bytes written to \p data
614 */
615static psa_status_t psa_export_rsa_key( psa_key_type_t type,
616 mbedtls_rsa_context *rsa,
617 uint8_t *data,
618 size_t data_size,
619 size_t *data_length )
620{
621#if defined(MBEDTLS_PK_WRITE_C)
622 int ret;
623 mbedtls_pk_context pk;
624 uint8_t *pos = data + data_size;
625
626 mbedtls_pk_init( &pk );
627 pk.pk_info = &mbedtls_rsa_info;
628 pk.pk_ctx = rsa;
629
630 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200631 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
632 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200633 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
634 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
635 else
636 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
637
638 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200639 {
640 /* Clean up in case pk_write failed halfway through. */
641 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200642 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200643 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200644
645 /* The mbedtls_pk_xxx functions write to the end of the buffer.
646 * Move the data to the beginning and erase remaining data
647 * at the original location. */
648 if( 2 * (size_t) ret <= data_size )
649 {
650 memcpy( data, data + data_size - ret, ret );
651 memset( data + data_size - ret, 0, ret );
652 }
653 else if( (size_t) ret < data_size )
654 {
655 memmove( data, data + data_size - ret, ret );
656 memset( data + ret, 0, data_size - ret );
657 }
658
659 *data_length = ret;
660 return( PSA_SUCCESS );
661#else
662 (void) type;
663 (void) rsa;
664 (void) data;
665 (void) data_size;
666 (void) data_length;
667 return( PSA_ERROR_NOT_SUPPORTED );
668#endif /* MBEDTLS_PK_WRITE_C */
669}
670
671/** Import an RSA key from import representation to a slot
672 *
673 * \param[in,out] slot The slot where to store the export representation to
674 * \param[in] data The buffer containing the import representation
675 * \param[in] data_length The amount of bytes in \p data
676 */
677static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
678 const uint8_t *data,
679 size_t data_length )
680{
681 psa_status_t status;
682 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200683 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200684
Steven Cooremana01795d2020-07-24 22:48:15 +0200685 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200686 status = psa_load_rsa_representation( slot->attr.type,
687 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200688 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200689 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200690 if( status != PSA_SUCCESS )
691 goto exit;
692
693 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200694 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200695
Steven Cooreman75b74362020-07-28 14:30:13 +0200696 /* Re-export the data to PSA export format, such that we can store export
697 * representation in the key slot. Export representation in case of RSA is
698 * the smallest representation that's allowed as input, so a straight-up
699 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200700 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200701 if( output == NULL )
702 {
703 status = PSA_ERROR_INSUFFICIENT_MEMORY;
704 goto exit;
705 }
706
Steven Cooremana01795d2020-07-24 22:48:15 +0200707 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200708 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200709 output,
710 data_length,
711 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200712exit:
713 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200714 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200715 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200716
717 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000718 if( status != PSA_SUCCESS )
719 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200720 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000721 return( status );
722 }
723
Steven Cooremana01795d2020-07-24 22:48:15 +0200724 /* On success, store the allocated export-formatted key. */
725 slot->data.key.data = output;
726 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000727
728 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200729}
John Durkop6ba40d12020-11-10 08:50:04 -0800730
731#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -0800732 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200733
John Durkop9814fa22020-11-04 12:28:15 -0800734#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800735 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
736 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
737 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) || \
738 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Steven Cooreman7f391872020-07-30 14:57:44 +0200739/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200740 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200741 * \param[in] type The type of key contained in \p data.
742 * \param[in] data The buffer from which to load the representation.
743 * \param[in] data_length The size in bytes of \p data.
744 * \param[out] p_ecp Returns a pointer to an ECP context on success.
745 * The caller is responsible for freeing both the
746 * contents of the context and the context itself
747 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200748 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200749static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
750 const uint8_t *data,
751 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200752 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100753{
754 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200755 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200756 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200757 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100758
Steven Cooreman4fed4552020-08-03 14:46:03 +0200759 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
760 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100761 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200762 /* A Weierstrass public key is represented as:
763 * - The byte 0x04;
764 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
765 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200766 * So its data length is 2m+1 where m is the curve size in bits.
Steven Cooreman4fed4552020-08-03 14:46:03 +0200767 */
768 if( ( data_length & 1 ) == 0 )
769 return( PSA_ERROR_INVALID_ARGUMENT );
770 curve_size = data_length / 2;
771
772 /* Montgomery public keys are represented in compressed format, meaning
773 * their curve_size is equal to the amount of input. */
774
775 /* Private keys are represented in uncompressed private random integer
776 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100777 }
778
Steven Cooreman6d839f02020-07-30 11:36:45 +0200779 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200780 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200781 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200782 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200783 mbedtls_ecp_keypair_init( ecp );
784
Gilles Peskine4cd32772019-12-02 20:49:42 +0100785 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200786 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
787 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100788 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200789 {
790 status = PSA_ERROR_INVALID_ARGUMENT;
791 goto exit;
792 }
793
Steven Cooremanacda8342020-07-24 23:09:52 +0200794 status = mbedtls_to_psa_error(
795 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
796 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200797 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200798
Steven Cooreman6d839f02020-07-30 11:36:45 +0200799 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200800 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200801 {
802 /* Load the public value. */
803 status = mbedtls_to_psa_error(
804 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200805 data,
806 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200807 if( status != PSA_SUCCESS )
808 goto exit;
809
810 /* Check that the point is on the curve. */
811 status = mbedtls_to_psa_error(
812 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
813 if( status != PSA_SUCCESS )
814 goto exit;
815 }
816 else
817 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200818 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200819 status = mbedtls_to_psa_error(
820 mbedtls_ecp_read_key( ecp->grp.id,
821 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200822 data,
823 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200824 if( status != PSA_SUCCESS )
825 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200826 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200827
828 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200829exit:
830 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200831 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200832 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200833 mbedtls_free( ecp );
834 }
835
Steven Cooreman29149862020-08-05 15:43:42 +0200836 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100837}
John Durkop6ba40d12020-11-10 08:50:04 -0800838#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
839 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
840 * defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
841 * defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) ||
842 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Jaeden Ameroccdce902019-01-10 11:42:27 +0000843
John Durkop6ba40d12020-11-10 08:50:04 -0800844#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
845 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman4fed4552020-08-03 14:46:03 +0200846/** Export an ECP key to export representation
847 *
848 * \param[in] type The type of key (public/private) to export
849 * \param[in] ecp The internal ECP representation from which to export
850 * \param[out] data The buffer to export to
851 * \param[in] data_size The length of the buffer to export to
852 * \param[out] data_length The amount of bytes written to \p data
853 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200854static psa_status_t psa_export_ecp_key( psa_key_type_t type,
855 mbedtls_ecp_keypair *ecp,
856 uint8_t *data,
857 size_t data_size,
858 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200859{
Steven Cooremanacda8342020-07-24 23:09:52 +0200860 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000861
Steven Cooremanacda8342020-07-24 23:09:52 +0200862 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200863 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 /* Check whether the public part is loaded */
865 if( mbedtls_ecp_is_zero( &ecp->Q ) )
866 {
867 /* Calculate the public key */
868 status = mbedtls_to_psa_error(
869 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
870 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
871 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200872 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200873 }
874
Steven Cooreman4fed4552020-08-03 14:46:03 +0200875 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200876 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
877 MBEDTLS_ECP_PF_UNCOMPRESSED,
878 data_length,
879 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200880 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200881 if( status != PSA_SUCCESS )
882 memset( data, 0, data_size );
883
Steven Cooreman29149862020-08-05 15:43:42 +0200884 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200885 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200886 else
887 {
Steven Cooreman29149862020-08-05 15:43:42 +0200888 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200889 return( PSA_ERROR_BUFFER_TOO_SMALL );
890
891 status = mbedtls_to_psa_error(
892 mbedtls_ecp_write_key( ecp,
893 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200894 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200896 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200897 else
898 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200899
900 return( status );
901 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200902}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200903
Steven Cooreman4fed4552020-08-03 14:46:03 +0200904/** Import an ECP key from import representation to a slot
905 *
906 * \param[in,out] slot The slot where to store the export representation to
907 * \param[in] data The buffer containing the import representation
908 * \param[in] data_length The amount of bytes in \p data
909 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200910static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
911 const uint8_t *data,
912 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100913{
Steven Cooremanacda8342020-07-24 23:09:52 +0200914 psa_status_t status;
915 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100917
Steven Cooremanacda8342020-07-24 23:09:52 +0200918 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200919 status = psa_load_ecp_representation( slot->attr.type,
920 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200921 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200922 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100923 if( status != PSA_SUCCESS )
924 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100925
Steven Cooremanacda8342020-07-24 23:09:52 +0200926 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200927 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200928 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200929 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200930
Steven Cooremanacda8342020-07-24 23:09:52 +0200931 /* Re-export the data to PSA export format. There is currently no support
932 * for other input formats then the export format, so this is a 1-1
933 * copy operation. */
934 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200935 if( output == NULL )
936 {
937 status = PSA_ERROR_INSUFFICIENT_MEMORY;
938 goto exit;
939 }
940
941 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200942 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200943 output,
944 data_length,
945 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100946exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200947 /* Always free the PK object (will also free contained ECP context) */
948 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200949 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200950
951 /* Free the allocated buffer only on error. */
952 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100953 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200954 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200955 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100956 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200957
958 /* On success, store the allocated export-formatted key. */
959 slot->data.key.data = output;
960 slot->data.key.bytes = data_length;
961
962 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100963}
John Durkop9814fa22020-11-04 12:28:15 -0800964#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
965 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskinef76aa772018-10-29 19:24:33 +0100966
Gilles Peskineb46bef22019-07-30 21:32:04 +0200967/** Return the size of the key in the given slot, in bits.
968 *
969 * \param[in] slot A key slot.
970 *
971 * \return The key size in bits, read from the metadata in the slot.
972 */
973static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
974{
975 return( slot->attr.bits );
976}
977
Steven Cooreman75b74362020-07-28 14:30:13 +0200978/** Try to allocate a buffer to an empty key slot.
979 *
980 * \param[in,out] slot Key slot to attach buffer to.
981 * \param[in] buffer_length Requested size of the buffer.
982 *
983 * \retval #PSA_SUCCESS
984 * The buffer has been successfully allocated.
985 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
986 * Not enough memory was available for allocation.
987 * \retval #PSA_ERROR_ALREADY_EXISTS
988 * Trying to allocate a buffer to a non-empty key slot.
989 */
990static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
991 size_t buffer_length )
992{
993 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200994 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200995
996 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
997 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200998 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200999
1000 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +02001001 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +02001002}
1003
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001004psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
1005 const uint8_t* data,
1006 size_t data_length )
1007{
1008 psa_status_t status = psa_allocate_buffer_to_slot( slot,
1009 data_length );
1010 if( status != PSA_SUCCESS )
1011 return( status );
1012
1013 memcpy( slot->data.key.data, data, data_length );
1014 return( PSA_SUCCESS );
1015}
1016
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001017/** Import key data into a slot.
1018 *
1019 * `slot->type` must have been set previously.
1020 * This function assumes that the slot does not contain any key material yet.
1021 * On failure, the slot content is unchanged.
1022 *
1023 * Persistent storage is not affected.
1024 *
1025 * \param[in,out] slot The key slot to import data into.
1026 * Its `type` field must have previously been set to
1027 * the desired key type.
1028 * It must not contain any key material yet.
1029 * \param[in] data Buffer containing the key material to parse and import.
1030 * \param data_length Size of \p data in bytes.
1031 *
1032 * \retval #PSA_SUCCESS
1033 * \retval #PSA_ERROR_INVALID_ARGUMENT
1034 * \retval #PSA_ERROR_NOT_SUPPORTED
1035 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1036 */
1037static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
1038 const uint8_t *data,
1039 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040{
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001041 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +02001042 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001043
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001044 /* zero-length keys are never supported. */
1045 if( data_length == 0 )
1046 return( PSA_ERROR_NOT_SUPPORTED );
1047
Gilles Peskine8e338702019-07-30 20:06:31 +02001048 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001049 {
Steven Cooreman04524762020-10-13 17:43:44 +02001050 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001051
Steven Cooreman75b74362020-07-28 14:30:13 +02001052 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1053 if( data_length > SIZE_MAX / 8 )
1054 return( PSA_ERROR_NOT_SUPPORTED );
1055
Gilles Peskine1b9505c2019-08-07 10:59:45 +02001056 /* Enforce a size limit, and in particular ensure that the bit
1057 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +02001058 if( bit_size > PSA_MAX_KEY_BITS )
1059 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001060
1061 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001062 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001063 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001064
1065 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001066 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +02001067 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001068 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001069
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001070 /* Write the actual key size to the slot.
1071 * psa_start_key_creation() wrote the size declared by the
1072 * caller, which may be 0 (meaning unspecified) or wrong. */
1073 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +01001074
1075 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001076 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001077 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +02001078 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001079 /* Try validation through accelerators first. */
1080 bit_size = slot->attr.bits;
1081 psa_key_attributes_t attributes = {
1082 .core = slot->attr
1083 };
1084 status = psa_driver_wrapper_validate_key( &attributes,
1085 data,
1086 data_length,
1087 &bit_size );
1088 if( status == PSA_SUCCESS )
1089 {
1090 /* Key has been validated successfully by an accelerator.
1091 * Copy key material into slot. */
1092 status = psa_copy_key_material_into_slot( slot, data, data_length );
1093 if( status != PSA_SUCCESS )
1094 return( status );
1095
1096 slot->attr.bits = (psa_key_bits_t) bit_size;
1097 return( PSA_SUCCESS );
1098 }
1099 else if( status != PSA_ERROR_NOT_SUPPORTED )
1100 return( status );
1101
1102 /* Key format is not supported by any accelerator, try software fallback
1103 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -08001104#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1105 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001106 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1107 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001108 return( psa_import_ecp_key( slot, data, data_length ) );
1109 }
John Durkop9814fa22020-11-04 12:28:15 -08001110#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1111 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -07001112#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1113 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +01001114 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001115 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001116 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001117 }
John Durkop9814fa22020-11-04 12:28:15 -08001118#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1119 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +01001120
1121 /* Fell through the fallback as well, so have nothing else to try. */
1122 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001123 }
1124 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001125 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001126 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001127 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001128 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001129}
1130
Gilles Peskinef603c712019-01-19 13:40:11 +01001131/** Calculate the intersection of two algorithm usage policies.
1132 *
1133 * Return 0 (which allows no operation) on incompatibility.
1134 */
1135static psa_algorithm_t psa_key_policy_algorithm_intersection(
1136 psa_algorithm_t alg1,
1137 psa_algorithm_t alg2 )
1138{
Gilles Peskine549ea862019-05-22 11:45:59 +02001139 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001140 if( alg1 == alg2 )
1141 return( alg1 );
1142 /* If the policies are from the same hash-and-sign family, check
1143 * if one is a wildcard. If so the other has the specific algorithm. */
1144 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1145 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1146 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1147 {
1148 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1149 return( alg2 );
1150 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1151 return( alg1 );
1152 }
1153 /* If the policies are incompatible, allow nothing. */
1154 return( 0 );
1155}
1156
Gilles Peskined6f371b2019-05-10 19:33:38 +02001157static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1158 psa_algorithm_t requested_alg )
1159{
Gilles Peskine549ea862019-05-22 11:45:59 +02001160 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001161 if( requested_alg == policy_alg )
1162 return( 1 );
1163 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001164 * and requested_alg is the same hash-and-sign family with any hash,
1165 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001166 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1167 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1168 {
1169 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1170 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1171 }
Steven Cooremance48e852020-10-05 16:02:45 +02001172 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001173 * a key derivation with that key agreement should also be allowed. This
1174 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001175 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1176 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1177 {
1178 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1179 policy_alg );
1180 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001181 /* If it isn't permitted, it's forbidden. */
1182 return( 0 );
1183}
1184
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001185/** Test whether a policy permits an algorithm.
1186 *
1187 * The caller must test usage flags separately.
1188 */
1189static int psa_key_policy_permits( const psa_key_policy_t *policy,
1190 psa_algorithm_t alg )
1191{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001192 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1193 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001194}
1195
Gilles Peskinef603c712019-01-19 13:40:11 +01001196/** Restrict a key policy based on a constraint.
1197 *
1198 * \param[in,out] policy The policy to restrict.
1199 * \param[in] constraint The policy constraint to apply.
1200 *
1201 * \retval #PSA_SUCCESS
1202 * \c *policy contains the intersection of the original value of
1203 * \c *policy and \c *constraint.
1204 * \retval #PSA_ERROR_INVALID_ARGUMENT
1205 * \c *policy and \c *constraint are incompatible.
1206 * \c *policy is unchanged.
1207 */
1208static psa_status_t psa_restrict_key_policy(
1209 psa_key_policy_t *policy,
1210 const psa_key_policy_t *constraint )
1211{
1212 psa_algorithm_t intersection_alg =
1213 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001214 psa_algorithm_t intersection_alg2 =
1215 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001216 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1217 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001218 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1219 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001220 policy->usage &= constraint->usage;
1221 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001222 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001223 return( PSA_SUCCESS );
1224}
1225
Ronald Cron5c522922020-11-14 16:35:34 +01001226/** Get the description of a key given its identifier and policy constraints
1227 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001228 *
Ronald Cron5c522922020-11-14 16:35:34 +01001229 * The key must have allow all the usage flags set in \p usage. If \p alg is
1230 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +01001231 *
Ronald Cron5c522922020-11-14 16:35:34 +01001232 * In case of a persistent key, the function loads the description of the key
1233 * into a key slot if not already done.
1234 *
1235 * On success, the returned key slot is locked. It is the responsibility of
1236 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001237 */
Ronald Cron5c522922020-11-14 16:35:34 +01001238static psa_status_t psa_get_and_lock_key_slot_with_policy(
1239 mbedtls_svc_key_id_t key,
1240 psa_key_slot_t **p_slot,
1241 psa_key_usage_t usage,
1242 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +01001243{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1245 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001246
Ronald Cron5c522922020-11-14 16:35:34 +01001247 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001248 if( status != PSA_SUCCESS )
1249 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001250 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001251
1252 /* Enforce that usage policy for the key slot contains all the flags
1253 * required by the usage parameter. There is one exception: public
1254 * keys can always be exported, so we treat public key objects as
1255 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001256 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001257 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001258
1259 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +02001260 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001261 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001262
1263 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001264 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001265 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +01001266
Darryl Green06fd18d2018-07-16 11:21:11 +01001267 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001268
1269error:
1270 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001271 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001272
1273 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001274}
Darryl Green940d72c2018-07-13 13:18:51 +01001275
Ronald Cron5c522922020-11-14 16:35:34 +01001276/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001277 *
1278 * A transparent key is a key for which the key material is directly
1279 * available, as opposed to a key in a secure element.
1280 *
Ronald Cron5c522922020-11-14 16:35:34 +01001281 * This is a temporary function to use instead of
1282 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1283 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001284 *
Ronald Cron5c522922020-11-14 16:35:34 +01001285 * On success, the returned key slot is locked. It is the responsibility of the
1286 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001287 */
1288#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001289static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1290 mbedtls_svc_key_id_t key,
1291 psa_key_slot_t **p_slot,
1292 psa_key_usage_t usage,
1293 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001294{
Ronald Cron5c522922020-11-14 16:35:34 +01001295 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1296 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001297 if( status != PSA_SUCCESS )
1298 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001299
Gilles Peskineadad8132019-07-25 11:31:23 +02001300 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001301 {
Ronald Cron5c522922020-11-14 16:35:34 +01001302 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001303 *p_slot = NULL;
1304 return( PSA_ERROR_NOT_SUPPORTED );
1305 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001306
Gilles Peskine28f8f302019-07-24 13:30:31 +02001307 return( PSA_SUCCESS );
1308}
1309#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1310/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001311#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1312 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001313#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1314
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001315/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001316static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001317{
Gilles Peskine73167e12019-07-12 23:44:37 +02001318#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1319 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001320 {
1321 /* No key material to clean. */
1322 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001323 else
1324#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001325 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001326 /* Data pointer will always be either a valid pointer or NULL in an
1327 * initialized slot, so we can just free it. */
1328 if( slot->data.key.data != NULL )
1329 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001330 mbedtls_free( slot->data.key.data );
1331 slot->data.key.data = NULL;
1332 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001333 }
Darryl Green40225ba2018-11-15 14:48:15 +00001334
1335 return( PSA_SUCCESS );
1336}
1337
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001338/** Completely wipe a slot in memory, including its policy.
1339 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001340psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001341{
1342 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001343
1344 /*
1345 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001346 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001347 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1348 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001349 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001350 */
Ronald Cron5c522922020-11-14 16:35:34 +01001351 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001352 {
1353#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001354 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001355#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001356 status = PSA_ERROR_CORRUPTION_DETECTED;
1357 }
1358
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001359 /* Multipart operations may still be using the key. This is safe
1360 * because all multipart operation objects are independent from
1361 * the key slot: if they need to access the key after the setup
1362 * phase, they have a copy of the key. Note that this means that
1363 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001364 /* At this point, key material and other type-specific content has
1365 * been wiped. Clear remaining metadata. We can call memset and not
1366 * zeroize because the metadata is not particularly sensitive. */
1367 memset( slot, 0, sizeof( *slot ) );
1368 return( status );
1369}
1370
Ronald Croncf56a0a2020-08-04 09:51:30 +02001371psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001372{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001373 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001374 psa_status_t status; /* status of the last operation */
1375 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001376#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1377 psa_se_drv_table_entry_t *driver;
1378#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001379
Ronald Croncf56a0a2020-08-04 09:51:30 +02001380 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001381 return( PSA_SUCCESS );
1382
Ronald Cronf2911112020-10-29 17:51:10 +01001383 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001384 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001385 * key, this will load the key description from persistent memory if not
1386 * done yet. We cannot avoid this loading as without it we don't know if
1387 * the key is operated by an SE or not and this information is needed by
1388 * the current implementation.
1389 */
Ronald Cron5c522922020-11-14 16:35:34 +01001390 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001391 if( status != PSA_SUCCESS )
1392 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001393
Ronald Cronf2911112020-10-29 17:51:10 +01001394 /*
1395 * If the key slot containing the key description is under access by the
1396 * library (apart from the present access), the key cannot be destroyed
1397 * yet. For the time being, just return in error. Eventually (to be
1398 * implemented), the key should be destroyed when all accesses have
1399 * stopped.
1400 */
Ronald Cron5c522922020-11-14 16:35:34 +01001401 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001402 {
Ronald Cron5c522922020-11-14 16:35:34 +01001403 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001404 return( PSA_ERROR_GENERIC_ERROR );
1405 }
1406
Gilles Peskine354f7672019-07-12 23:46:38 +02001407#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001408 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001409 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001410 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001411 /* For a key in a secure element, we need to do three things:
1412 * remove the key file in internal storage, destroy the
1413 * key inside the secure element, and update the driver's
1414 * persistent data. Start a transaction that will encompass these
1415 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001416 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001417 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001418 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001419 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001420 status = psa_crypto_save_transaction( );
1421 if( status != PSA_SUCCESS )
1422 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001423 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001424 /* We should still try to destroy the key in the secure
1425 * element and the key metadata in storage. This is especially
1426 * important if the error is that the storage is full.
1427 * But how to do it exactly without risking an inconsistent
1428 * state after a reset?
1429 * https://github.com/ARMmbed/mbed-crypto/issues/215
1430 */
1431 overall_status = status;
1432 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001433 }
1434
Gilles Peskine354f7672019-07-12 23:46:38 +02001435 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001436 if( overall_status == PSA_SUCCESS )
1437 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001438 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001439#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1440
Darryl Greend49a4992018-06-18 17:27:26 +01001441#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001442 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001443 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001444 status = psa_destroy_persistent_key( slot->attr.id );
1445 if( overall_status == PSA_SUCCESS )
1446 overall_status = status;
1447
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001448 /* TODO: other slots may have a copy of the same key. We should
1449 * invalidate them.
1450 * https://github.com/ARMmbed/mbed-crypto/issues/214
1451 */
Darryl Greend49a4992018-06-18 17:27:26 +01001452 }
1453#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001454
Gilles Peskinefc762652019-07-22 19:30:34 +02001455#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1456 if( driver != NULL )
1457 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001458 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001459 if( overall_status == PSA_SUCCESS )
1460 overall_status = status;
1461 status = psa_crypto_stop_transaction( );
1462 if( overall_status == PSA_SUCCESS )
1463 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001464 }
1465#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1466
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001467#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1468exit:
1469#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001470 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001471 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1472 if( overall_status == PSA_SUCCESS )
1473 overall_status = status;
1474 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001475}
1476
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001477void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001478{
Gilles Peskineb699f072019-04-26 16:06:02 +02001479 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001480 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001481}
1482
Gilles Peskineb699f072019-04-26 16:06:02 +02001483psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1484 psa_key_type_t type,
1485 const uint8_t *data,
1486 size_t data_length )
1487{
1488 uint8_t *copy = NULL;
1489
1490 if( data_length != 0 )
1491 {
1492 copy = mbedtls_calloc( 1, data_length );
1493 if( copy == NULL )
1494 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1495 memcpy( copy, data, data_length );
1496 }
1497 /* After this point, this function is guaranteed to succeed, so it
1498 * can start modifying `*attributes`. */
1499
1500 if( attributes->domain_parameters != NULL )
1501 {
1502 mbedtls_free( attributes->domain_parameters );
1503 attributes->domain_parameters = NULL;
1504 attributes->domain_parameters_size = 0;
1505 }
1506
1507 attributes->domain_parameters = copy;
1508 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001509 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001510 return( PSA_SUCCESS );
1511}
1512
1513psa_status_t psa_get_key_domain_parameters(
1514 const psa_key_attributes_t *attributes,
1515 uint8_t *data, size_t data_size, size_t *data_length )
1516{
1517 if( attributes->domain_parameters_size > data_size )
1518 return( PSA_ERROR_BUFFER_TOO_SMALL );
1519 *data_length = attributes->domain_parameters_size;
1520 if( attributes->domain_parameters_size != 0 )
1521 memcpy( data, attributes->domain_parameters,
1522 attributes->domain_parameters_size );
1523 return( PSA_SUCCESS );
1524}
1525
John Durkop07cc04a2020-11-16 22:08:34 -08001526#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001527 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001528static psa_status_t psa_get_rsa_public_exponent(
1529 const mbedtls_rsa_context *rsa,
1530 psa_key_attributes_t *attributes )
1531{
1532 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001534 uint8_t *buffer = NULL;
1535 size_t buflen;
1536 mbedtls_mpi_init( &mpi );
1537
1538 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1539 if( ret != 0 )
1540 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001541 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1542 {
1543 /* It's the default value, which is reported as an empty string,
1544 * so there's nothing to do. */
1545 goto exit;
1546 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001547
1548 buflen = mbedtls_mpi_size( &mpi );
1549 buffer = mbedtls_calloc( 1, buflen );
1550 if( buffer == NULL )
1551 {
1552 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1553 goto exit;
1554 }
1555 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1556 if( ret != 0 )
1557 goto exit;
1558 attributes->domain_parameters = buffer;
1559 attributes->domain_parameters_size = buflen;
1560
1561exit:
1562 mbedtls_mpi_free( &mpi );
1563 if( ret != 0 )
1564 mbedtls_free( buffer );
1565 return( mbedtls_to_psa_error( ret ) );
1566}
John Durkop07cc04a2020-11-16 22:08:34 -08001567#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001568 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001569
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001570/** Retrieve all the publicly-accessible attributes of a key.
1571 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001572psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001573 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001574{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001575 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001576 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001577 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001578
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001579 psa_reset_key_attributes( attributes );
1580
Ronald Cron5c522922020-11-14 16:35:34 +01001581 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001582 if( status != PSA_SUCCESS )
1583 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001584
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001585 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001586 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1587 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1588
1589#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1590 if( psa_key_slot_is_external( slot ) )
1591 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1592#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001593
Gilles Peskine8e338702019-07-30 20:06:31 +02001594 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001595 {
John Durkop07cc04a2020-11-16 22:08:34 -08001596#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001597 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001598 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001599 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001600#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001601 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001602 * is not yet implemented.
1603 * https://github.com/ARMmbed/mbed-crypto/issues/216
1604 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001605 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001606 break;
1607#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001608 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001609 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001610
Steven Cooreman4fed4552020-08-03 14:46:03 +02001611 status = psa_load_rsa_representation( slot->attr.type,
1612 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001613 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001614 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001615 if( status != PSA_SUCCESS )
1616 break;
1617
Steven Cooremana2371e52020-07-28 14:30:39 +02001618 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001619 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001620 mbedtls_rsa_free( rsa );
1621 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001622 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001623 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001624#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001625 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001626 default:
1627 /* Nothing else to do. */
1628 break;
1629 }
1630
1631 if( status != PSA_SUCCESS )
1632 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001633
Ronald Cron5c522922020-11-14 16:35:34 +01001634 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001635
Ronald Cron5c522922020-11-14 16:35:34 +01001636 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001637}
1638
Gilles Peskinec8000c02019-08-02 20:15:51 +02001639#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1640psa_status_t psa_get_key_slot_number(
1641 const psa_key_attributes_t *attributes,
1642 psa_key_slot_number_t *slot_number )
1643{
1644 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1645 {
1646 *slot_number = attributes->slot_number;
1647 return( PSA_SUCCESS );
1648 }
1649 else
1650 return( PSA_ERROR_INVALID_ARGUMENT );
1651}
1652#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1653
Steven Cooremana01795d2020-07-24 22:48:15 +02001654static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1655 uint8_t *data,
1656 size_t data_size,
1657 size_t *data_length )
1658{
1659 if( slot->data.key.bytes > data_size )
1660 return( PSA_ERROR_BUFFER_TOO_SMALL );
1661 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1662 memset( data + slot->data.key.bytes, 0,
1663 data_size - slot->data.key.bytes );
1664 *data_length = slot->data.key.bytes;
1665 return( PSA_SUCCESS );
1666}
1667
Gilles Peskinef603c712019-01-19 13:40:11 +01001668static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1669 uint8_t *data,
1670 size_t data_size,
1671 size_t *data_length,
1672 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001673{
Gilles Peskine5d309672019-07-12 23:47:28 +02001674#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1675 const psa_drv_se_t *drv;
1676 psa_drv_se_context_t *drv_context;
1677#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1678
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001679 *data_length = 0;
1680
Gilles Peskine8e338702019-07-30 20:06:31 +02001681 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001682 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001683
Gilles Peskinef9168942019-09-12 19:20:29 +02001684 /* Reject a zero-length output buffer now, since this can never be a
1685 * valid key representation. This way we know that data must be a valid
1686 * pointer and we can do things like memset(data, ..., data_size). */
1687 if( data_size == 0 )
1688 return( PSA_ERROR_BUFFER_TOO_SMALL );
1689
Gilles Peskine5d309672019-07-12 23:47:28 +02001690#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001691 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001692 {
1693 psa_drv_se_export_key_t method;
1694 if( drv->key_management == NULL )
1695 return( PSA_ERROR_NOT_SUPPORTED );
1696 method = ( export_public_key ?
1697 drv->key_management->p_export_public :
1698 drv->key_management->p_export );
1699 if( method == NULL )
1700 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001701 return( method( drv_context,
1702 slot->data.se.slot_number,
1703 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001704 }
1705#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1706
Gilles Peskine8e338702019-07-30 20:06:31 +02001707 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001708 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001709 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001710 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001711 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1712 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001713 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001714 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001715 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001716 /* Exporting public -> public */
1717 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1718 }
1719 else if( !export_public_key )
1720 {
1721 /* Exporting private -> private */
1722 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1723 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001724
Steven Cooreman560c28a2020-07-24 23:20:24 +02001725 /* Need to export the public part of a private key,
Steven Cooremanb9b84422020-10-14 14:39:20 +02001726 * so conversion is needed. Try the accelerators first. */
1727 psa_status_t status = psa_driver_wrapper_export_public_key( slot,
1728 data,
1729 data_size,
1730 data_length );
1731
1732 if( status != PSA_ERROR_NOT_SUPPORTED ||
1733 psa_key_lifetime_is_external( slot->attr.lifetime ) )
1734 return( status );
1735
Steven Cooreman560c28a2020-07-24 23:20:24 +02001736 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1737 {
John Durkop0e005192020-10-31 22:06:54 -07001738#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1739 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001740 mbedtls_rsa_context *rsa = NULL;
Steven Cooremanb9b84422020-10-14 14:39:20 +02001741 status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001742 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001743 slot->data.key.data,
1744 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001745 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001746 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001747 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001748
Steven Cooreman560c28a2020-07-24 23:20:24 +02001749 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001750 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001751 data,
1752 data_size,
1753 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001754
Steven Cooremana2371e52020-07-28 14:30:39 +02001755 mbedtls_rsa_free( rsa );
1756 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001757
Steven Cooreman560c28a2020-07-24 23:20:24 +02001758 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001759#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001760 /* We don't know how to convert a private RSA key to public. */
1761 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001762#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1763 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001764 }
1765 else
Moran Pekera998bc62018-04-16 18:16:20 +03001766 {
John Durkop6ba40d12020-11-10 08:50:04 -08001767#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1768 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001769 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooremanb9b84422020-10-14 14:39:20 +02001770 status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001771 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001772 slot->data.key.data,
1773 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001774 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001775 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001776 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001777
1778 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1779 PSA_KEY_TYPE_ECC_GET_FAMILY(
1780 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001781 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001782 data,
1783 data_size,
1784 data_length );
1785
Steven Cooremana2371e52020-07-28 14:30:39 +02001786 mbedtls_ecp_keypair_free( ecp );
1787 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001788 return( status );
1789#else
1790 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001791 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001792#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1793 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001794 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001795 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001796 else
1797 {
1798 /* This shouldn't happen in the reference implementation, but
1799 it is valid for a special-purpose implementation to omit
1800 support for exporting certain key types. */
1801 return( PSA_ERROR_NOT_SUPPORTED );
1802 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001803}
1804
Ronald Croncf56a0a2020-08-04 09:51:30 +02001805psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001806 uint8_t *data,
1807 size_t data_size,
1808 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001809{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001810 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001811 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001812 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001813
1814 /* Set the key to empty now, so that even when there are errors, we always
1815 * set data_length to a value between 0 and data_size. On error, setting
1816 * the key to empty is a good choice because an empty key representation is
1817 * unlikely to be accepted anywhere. */
1818 *data_length = 0;
1819
1820 /* Export requires the EXPORT flag. There is an exception for public keys,
Ronald Cron5c522922020-11-14 16:35:34 +01001821 * which don't require any flag, but
1822 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1823 */
1824 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1825 PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001826 if( status != PSA_SUCCESS )
1827 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001828
1829 status = psa_internal_export_key( slot, data, data_size, data_length, 0 );
Ronald Cron5c522922020-11-14 16:35:34 +01001830 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001831
Ronald Cron5c522922020-11-14 16:35:34 +01001832 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001833}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001834
Ronald Croncf56a0a2020-08-04 09:51:30 +02001835psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001836 uint8_t *data,
1837 size_t data_size,
1838 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001839{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001840 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001841 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001842 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001843
1844 /* Set the key to empty now, so that even when there are errors, we always
1845 * set data_length to a value between 0 and data_size. On error, setting
1846 * the key to empty is a good choice because an empty key representation is
1847 * unlikely to be accepted anywhere. */
1848 *data_length = 0;
1849
1850 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001851 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001852 if( status != PSA_SUCCESS )
1853 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001854
1855 status = psa_internal_export_key( slot, data, data_size, data_length, 1 );
Ronald Cron5c522922020-11-14 16:35:34 +01001856 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001857
Ronald Cron5c522922020-11-14 16:35:34 +01001858 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001859}
1860
Gilles Peskine91e8c332019-08-02 19:19:39 +02001861#if defined(static_assert)
1862static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1863 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001864static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001865 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001866static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001867 "One or more key attribute flag is listed as both internal-only and external-only" );
1868#endif
1869
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001870/** Validate that a key policy is internally well-formed.
1871 *
1872 * This function only rejects invalid policies. It does not validate the
1873 * consistency of the policy with respect to other attributes of the key
1874 * such as the key type.
1875 */
1876static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001877{
1878 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001879 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 PSA_KEY_USAGE_ENCRYPT |
1881 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001882 PSA_KEY_USAGE_SIGN_HASH |
1883 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1885 return( PSA_ERROR_INVALID_ARGUMENT );
1886
Gilles Peskine4747d192019-04-17 15:05:45 +02001887 return( PSA_SUCCESS );
1888}
1889
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001890/** Validate the internal consistency of key attributes.
1891 *
1892 * This function only rejects invalid attribute values. If does not
1893 * validate the consistency of the attributes with any key data that may
1894 * be involved in the creation of the key.
1895 *
1896 * Call this function early in the key creation process.
1897 *
1898 * \param[in] attributes Key attributes for the new key.
1899 * \param[out] p_drv On any return, the driver for the key, if any.
1900 * NULL for a transparent key.
1901 *
1902 */
1903static psa_status_t psa_validate_key_attributes(
1904 const psa_key_attributes_t *attributes,
1905 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001906{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001907 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001908 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001909 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001910
Ronald Cron54b90082020-10-29 15:26:43 +01001911 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001912 if( status != PSA_SUCCESS )
1913 return( status );
1914
Ronald Crond2ed4812020-07-17 16:11:30 +02001915 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001916 if( status != PSA_SUCCESS )
1917 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001918
Ronald Cron65f38a32020-10-23 17:11:13 +02001919 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1920 {
1921 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1922 return( PSA_ERROR_INVALID_ARGUMENT );
1923 }
1924 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001925 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001926 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001927 if( status != PSA_SUCCESS )
1928 return( status );
1929 }
1930
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001931 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001932 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001933 return( status );
1934
1935 /* Refuse to create overly large keys.
1936 * Note that this doesn't trigger on import if the attributes don't
1937 * explicitly specify a size (so psa_get_key_bits returns 0), so
1938 * psa_import_key() needs its own checks. */
1939 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1940 return( PSA_ERROR_NOT_SUPPORTED );
1941
Gilles Peskine91e8c332019-08-02 19:19:39 +02001942 /* Reject invalid flags. These should not be reachable through the API. */
1943 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1944 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1945 return( PSA_ERROR_INVALID_ARGUMENT );
1946
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001947 return( PSA_SUCCESS );
1948}
1949
Gilles Peskine4747d192019-04-17 15:05:45 +02001950/** Prepare a key slot to receive key material.
1951 *
1952 * This function allocates a key slot and sets its metadata.
1953 *
1954 * If this function fails, call psa_fail_key_creation().
1955 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001956 * This function is intended to be used as follows:
1957 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001958 * it with the specified attributes, and in case of a volatile key assign it
1959 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001960 * -# Populate the slot with the key material.
1961 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1962 * In case of failure at any step, stop the sequence and call
1963 * psa_fail_key_creation().
1964 *
Ronald Cron5c522922020-11-14 16:35:34 +01001965 * On success, the key slot is locked. It is the responsibility of the caller
1966 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001967 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001968 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001969 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001970 * \param[out] p_slot On success, a pointer to the prepared slot.
1971 * \param[out] p_drv On any return, the driver for the key, if any.
1972 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001973 *
1974 * \retval #PSA_SUCCESS
1975 * The key slot is ready to receive key material.
1976 * \return If this function fails, the key slot is an invalid state.
1977 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001978 */
1979static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001980 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001981 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001982 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001983 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001984{
1985 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001986 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001987 psa_key_slot_t *slot;
1988
Gilles Peskinedf179142019-07-15 22:02:14 +02001989 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001990 *p_drv = NULL;
1991
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001992 status = psa_validate_key_attributes( attributes, p_drv );
1993 if( status != PSA_SUCCESS )
1994 return( status );
1995
Ronald Cronc4d1b512020-07-31 11:26:37 +02001996 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001997 if( status != PSA_SUCCESS )
1998 return( status );
1999 slot = *p_slot;
2000
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002001 /* We're storing the declared bit-size of the key. It's up to each
2002 * creation mechanism to verify that this information is correct.
2003 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02002004 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02002005 * is optional (import, copy). In case of a volatile key, assign it the
2006 * volatile key identifier associated to the slot returned to contain its
2007 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002008
2009 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02002010 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
2011 {
2012#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
2013 slot->attr.id = volatile_key_id;
2014#else
2015 slot->attr.id.key_id = volatile_key_id;
2016#endif
2017 }
Gilles Peskinec744d992019-07-30 17:26:54 +02002018
Gilles Peskine91e8c332019-08-02 19:19:39 +02002019 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02002020 * external-only flags, query `attributes`. Thanks to the check
2021 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02002022 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02002023 * may have set. */
2024 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02002025
Gilles Peskinecbaff462019-07-12 23:46:04 +02002026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002027 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002028 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02002029 * create the key file in internal storage, create the
2030 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002031 * persistent data. This is done by starting a transaction that will
2032 * encompass these three actions.
2033 * For registering a volatile key, we just need to find an appropriate
2034 * slot number inside the SE. Since the key is designated volatile, creating
2035 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02002036 /* The first thing to do is to find a slot number for the new key.
2037 * We save the slot number in persistent storage as part of the
2038 * transaction data. It will be needed to recover if the power
2039 * fails during the key creation process, to clean up on the secure
2040 * element side after restarting. Obtaining a slot number from the
2041 * secure element driver updates its persistent state, but we do not yet
2042 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02002043 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002044 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00002045 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02002046 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02002047 &slot->data.se.slot_number );
2048 if( status != PSA_SUCCESS )
2049 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002050
2051 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02002052 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002053 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
2054 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
2055 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
2056 psa_crypto_transaction.key.id = slot->attr.id;
2057 status = psa_crypto_save_transaction( );
2058 if( status != PSA_SUCCESS )
2059 {
2060 (void) psa_crypto_stop_transaction( );
2061 return( status );
2062 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02002063 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002064 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002065
2066 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
2067 {
2068 /* Key registration only makes sense with a secure element. */
2069 return( PSA_ERROR_INVALID_ARGUMENT );
2070 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02002071#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2072
Ronald Cronc4d1b512020-07-31 11:26:37 +02002073 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00002074}
Gilles Peskine4747d192019-04-17 15:05:45 +02002075
2076/** Finalize the creation of a key once its key material has been set.
2077 *
2078 * This entails writing the key to persistent storage.
2079 *
2080 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002081 * See the documentation of psa_start_key_creation() for the intended use
2082 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002083 *
Ronald Cron5c522922020-11-14 16:35:34 +01002084 * If the finalization succeeds, the function unlocks the key slot (it was
2085 * locked by psa_start_key_creation()) and the key slot cannot be accessed
2086 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01002087 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002088 * \param[in,out] slot Pointer to the slot with key material.
2089 * \param[in] driver The secure element driver for the key,
2090 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01002091 * \param[out] key On success, identifier of the key. Note that the
2092 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002093 *
2094 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002095 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002096 * \return If this function fails, the key slot is an invalid state.
2097 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002098 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002099static psa_status_t psa_finish_key_creation(
2100 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002101 psa_se_drv_table_entry_t *driver,
2102 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002103{
2104 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002105 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002106 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002107
2108#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02002109 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02002110 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002111#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2112 if( driver != NULL )
2113 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002114 psa_se_key_data_storage_t data;
2115#if defined(static_assert)
2116 static_assert( sizeof( slot->data.se.slot_number ) ==
2117 sizeof( data.slot_number ),
2118 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002119#endif
2120 memcpy( &data.slot_number, &slot->data.se.slot_number,
2121 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002122 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002123 (uint8_t*) &data,
2124 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002125 }
2126 else
2127#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2128 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002129 /* Key material is saved in export representation in the slot, so
2130 * just pass the slot buffer for storage. */
2131 status = psa_save_persistent_key( &slot->attr,
2132 slot->data.key.data,
2133 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002134 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002135 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002136#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2137
Gilles Peskinecbaff462019-07-12 23:46:04 +02002138#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002139 /* Finish the transaction for a key creation. This does not
2140 * happen when registering an existing key. Detect this case
2141 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002142 * creation of a persistent key in a secure element requires a transaction,
2143 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002144 if( driver != NULL &&
2145 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002146 {
2147 status = psa_save_se_persistent_data( driver );
2148 if( status != PSA_SUCCESS )
2149 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002150 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002151 return( status );
2152 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002153 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002154 }
2155#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2156
Ronald Cron50972942020-11-14 11:28:25 +01002157 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01002158 {
2159 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01002160 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01002161 if( status != PSA_SUCCESS )
2162 *key = MBEDTLS_SVC_KEY_ID_INIT;
2163 }
Ronald Cron50972942020-11-14 11:28:25 +01002164
Gilles Peskine4747d192019-04-17 15:05:45 +02002165 return( status );
2166}
2167
2168/** Abort the creation of a key.
2169 *
2170 * You may call this function after calling psa_start_key_creation(),
2171 * or after psa_finish_key_creation() fails. In other circumstances, this
2172 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002173 * See the documentation of psa_start_key_creation() for the intended use
2174 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002175 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002176 * \param[in,out] slot Pointer to the slot with key material.
2177 * \param[in] driver The secure element driver for the key,
2178 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002179 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002180static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002181 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002182{
Gilles Peskine011e4282019-06-26 18:34:38 +02002183 (void) driver;
2184
Gilles Peskine4747d192019-04-17 15:05:45 +02002185 if( slot == NULL )
2186 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002187
2188#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002189 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002190 * element, and the failure happened later (when saving metadata
2191 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002192 * element.
2193 * https://github.com/ARMmbed/mbed-crypto/issues/217
2194 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002195
Gilles Peskined7729582019-08-05 15:55:54 +02002196 /* Abort the ongoing transaction if any (there may not be one if
2197 * the creation process failed before starting one, or if the
2198 * key creation is a registration of a key in a secure element).
2199 * Earlier functions must already have done what it takes to undo any
2200 * partial creation. All that's left is to update the transaction data
2201 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002202 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002203#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2204
Gilles Peskine4747d192019-04-17 15:05:45 +02002205 psa_wipe_key_slot( slot );
2206}
2207
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002208/** Validate optional attributes during key creation.
2209 *
2210 * Some key attributes are optional during key creation. If they are
2211 * specified in the attributes structure, check that they are consistent
2212 * with the data in the slot.
2213 *
2214 * This function should be called near the end of key creation, after
2215 * the slot in memory is fully populated but before saving persistent data.
2216 */
2217static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002218 const psa_key_slot_t *slot,
2219 const psa_key_attributes_t *attributes )
2220{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002221 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002222 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002223 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002224 return( PSA_ERROR_INVALID_ARGUMENT );
2225 }
2226
2227 if( attributes->domain_parameters_size != 0 )
2228 {
John Durkop0e005192020-10-31 22:06:54 -07002229#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
2230 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02002231 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002232 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002233 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002234 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002235 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002236
Steven Cooreman7f391872020-07-30 14:57:44 +02002237 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002238 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002239 slot->data.key.data,
2240 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002241 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002242 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002243 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002244
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002245 mbedtls_mpi_init( &actual );
2246 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002247 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002248 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002249 mbedtls_rsa_free( rsa );
2250 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002251 if( ret != 0 )
2252 goto rsa_exit;
2253 ret = mbedtls_mpi_read_binary( &required,
2254 attributes->domain_parameters,
2255 attributes->domain_parameters_size );
2256 if( ret != 0 )
2257 goto rsa_exit;
2258 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2259 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2260 rsa_exit:
2261 mbedtls_mpi_free( &actual );
2262 mbedtls_mpi_free( &required );
2263 if( ret != 0)
2264 return( mbedtls_to_psa_error( ret ) );
2265 }
2266 else
John Durkop9814fa22020-11-04 12:28:15 -08002267#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
2268 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002269 {
2270 return( PSA_ERROR_INVALID_ARGUMENT );
2271 }
2272 }
2273
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002274 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002275 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002276 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002277 return( PSA_ERROR_INVALID_ARGUMENT );
2278 }
2279
2280 return( PSA_SUCCESS );
2281}
2282
Gilles Peskine4747d192019-04-17 15:05:45 +02002283psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002284 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002285 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002286 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002287{
2288 psa_status_t status;
2289 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002290 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002291
Ronald Cron81709fc2020-11-14 12:10:32 +01002292 *key = MBEDTLS_SVC_KEY_ID_INIT;
2293
Gilles Peskine0f84d622019-09-12 19:03:13 +02002294 /* Reject zero-length symmetric keys (including raw data key objects).
2295 * This also rejects any key which might be encoded as an empty string,
2296 * which is never valid. */
2297 if( data_length == 0 )
2298 return( PSA_ERROR_INVALID_ARGUMENT );
2299
Gilles Peskinedf179142019-07-15 22:02:14 +02002300 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002301 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002302 if( status != PSA_SUCCESS )
2303 goto exit;
2304
Gilles Peskine5d309672019-07-12 23:47:28 +02002305#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2306 if( driver != NULL )
2307 {
2308 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002309 /* The driver should set the number of key bits, however in
2310 * case it doesn't, we initialize bits to an invalid value. */
2311 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002312 if( drv->key_management == NULL ||
2313 drv->key_management->p_import == NULL )
2314 {
2315 status = PSA_ERROR_NOT_SUPPORTED;
2316 goto exit;
2317 }
2318 status = drv->key_management->p_import(
2319 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002320 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002321 &bits );
2322 if( status != PSA_SUCCESS )
2323 goto exit;
2324 if( bits > PSA_MAX_KEY_BITS )
2325 {
2326 status = PSA_ERROR_NOT_SUPPORTED;
2327 goto exit;
2328 }
2329 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002330 }
2331 else
2332#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2333 {
2334 status = psa_import_key_into_slot( slot, data, data_length );
2335 if( status != PSA_SUCCESS )
2336 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002337 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002338 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002339 if( status != PSA_SUCCESS )
2340 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002341
Ronald Cron81709fc2020-11-14 12:10:32 +01002342 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002343exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002344 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002345 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002346
Gilles Peskine4747d192019-04-17 15:05:45 +02002347 return( status );
2348}
2349
Gilles Peskined7729582019-08-05 15:55:54 +02002350#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2351psa_status_t mbedtls_psa_register_se_key(
2352 const psa_key_attributes_t *attributes )
2353{
2354 psa_status_t status;
2355 psa_key_slot_t *slot = NULL;
2356 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002357 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002358
2359 /* Leaving attributes unspecified is not currently supported.
2360 * It could make sense to query the key type and size from the
2361 * secure element, but not all secure elements support this
2362 * and the driver HAL doesn't currently support it. */
2363 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2364 return( PSA_ERROR_NOT_SUPPORTED );
2365 if( psa_get_key_bits( attributes ) == 0 )
2366 return( PSA_ERROR_NOT_SUPPORTED );
2367
2368 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002369 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002370 if( status != PSA_SUCCESS )
2371 goto exit;
2372
Ronald Cron81709fc2020-11-14 12:10:32 +01002373 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002374
2375exit:
2376 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002377 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002378
Gilles Peskined7729582019-08-05 15:55:54 +02002379 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002380 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002381 return( status );
2382}
2383#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2384
Gilles Peskinef603c712019-01-19 13:40:11 +01002385static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002386 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002387{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002388 psa_status_t status = psa_copy_key_material_into_slot( target,
2389 source->data.key.data,
2390 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002391 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002392 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002393
Steven Cooreman398aee52020-10-13 14:35:45 +02002394 target->attr.type = source->attr.type;
2395 target->attr.bits = source->attr.bits;
2396
2397 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002398}
2399
Ronald Croncf56a0a2020-08-04 09:51:30 +02002400psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002401 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002402 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002403{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002404 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002405 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002406 psa_key_slot_t *source_slot = NULL;
2407 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002408 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002409 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002410
Ronald Cron81709fc2020-11-14 12:10:32 +01002411 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2412
Ronald Cron5c522922020-11-14 16:35:34 +01002413 status = psa_get_and_lock_transparent_key_slot_with_policy(
2414 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002415 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002416 goto exit;
2417
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002418 status = psa_validate_optional_attributes( source_slot,
2419 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002420 if( status != PSA_SUCCESS )
2421 goto exit;
2422
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002423 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002424 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002425 if( status != PSA_SUCCESS )
2426 goto exit;
2427
Ronald Cron81709fc2020-11-14 12:10:32 +01002428 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2429 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002430 if( status != PSA_SUCCESS )
2431 goto exit;
2432
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002433#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2434 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002435 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002436 /* Copying to a secure element is not implemented yet. */
2437 status = PSA_ERROR_NOT_SUPPORTED;
2438 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002439 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002440#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002441
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002442 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002443 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002444 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002445
Ronald Cron81709fc2020-11-14 12:10:32 +01002446 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002447exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002448 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002449 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002450
Ronald Cron5c522922020-11-14 16:35:34 +01002451 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002452
Ronald Cron5c522922020-11-14 16:35:34 +01002453 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002454}
2455
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002456
2457
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002458/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002459/* Message digests */
2460/****************************************************************/
2461
John Durkop07cc04a2020-11-16 22:08:34 -08002462#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002463 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2464 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002465 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002466static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002467{
2468 switch( alg )
2469 {
2470#if defined(MBEDTLS_MD2_C)
2471 case PSA_ALG_MD2:
2472 return( &mbedtls_md2_info );
2473#endif
2474#if defined(MBEDTLS_MD4_C)
2475 case PSA_ALG_MD4:
2476 return( &mbedtls_md4_info );
2477#endif
2478#if defined(MBEDTLS_MD5_C)
2479 case PSA_ALG_MD5:
2480 return( &mbedtls_md5_info );
2481#endif
2482#if defined(MBEDTLS_RIPEMD160_C)
2483 case PSA_ALG_RIPEMD160:
2484 return( &mbedtls_ripemd160_info );
2485#endif
2486#if defined(MBEDTLS_SHA1_C)
2487 case PSA_ALG_SHA_1:
2488 return( &mbedtls_sha1_info );
2489#endif
2490#if defined(MBEDTLS_SHA256_C)
2491 case PSA_ALG_SHA_224:
2492 return( &mbedtls_sha224_info );
2493 case PSA_ALG_SHA_256:
2494 return( &mbedtls_sha256_info );
2495#endif
2496#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002497#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002498 case PSA_ALG_SHA_384:
2499 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002500#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002501 case PSA_ALG_SHA_512:
2502 return( &mbedtls_sha512_info );
2503#endif
2504 default:
2505 return( NULL );
2506 }
2507}
John Durkop07cc04a2020-11-16 22:08:34 -08002508#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002509 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2510 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2511 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002512
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002513psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2514{
2515 switch( operation->alg )
2516 {
Gilles Peskine81736312018-06-26 15:04:31 +02002517 case 0:
2518 /* The object has (apparently) been initialized but it is not
2519 * in use. It's ok to call abort on such an object, and there's
2520 * nothing to do. */
2521 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002522#if defined(MBEDTLS_MD2_C)
2523 case PSA_ALG_MD2:
2524 mbedtls_md2_free( &operation->ctx.md2 );
2525 break;
2526#endif
2527#if defined(MBEDTLS_MD4_C)
2528 case PSA_ALG_MD4:
2529 mbedtls_md4_free( &operation->ctx.md4 );
2530 break;
2531#endif
2532#if defined(MBEDTLS_MD5_C)
2533 case PSA_ALG_MD5:
2534 mbedtls_md5_free( &operation->ctx.md5 );
2535 break;
2536#endif
2537#if defined(MBEDTLS_RIPEMD160_C)
2538 case PSA_ALG_RIPEMD160:
2539 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2540 break;
2541#endif
2542#if defined(MBEDTLS_SHA1_C)
2543 case PSA_ALG_SHA_1:
2544 mbedtls_sha1_free( &operation->ctx.sha1 );
2545 break;
2546#endif
2547#if defined(MBEDTLS_SHA256_C)
2548 case PSA_ALG_SHA_224:
2549 case PSA_ALG_SHA_256:
2550 mbedtls_sha256_free( &operation->ctx.sha256 );
2551 break;
2552#endif
2553#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002554#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002555 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002556#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002557 case PSA_ALG_SHA_512:
2558 mbedtls_sha512_free( &operation->ctx.sha512 );
2559 break;
2560#endif
2561 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002562 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002563 }
2564 operation->alg = 0;
2565 return( PSA_SUCCESS );
2566}
2567
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002568psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002569 psa_algorithm_t alg )
2570{
Janos Follath24eed8d2019-11-22 13:21:35 +00002571 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002572
2573 /* A context must be freshly initialized before it can be set up. */
2574 if( operation->alg != 0 )
2575 {
2576 return( PSA_ERROR_BAD_STATE );
2577 }
2578
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002579 switch( alg )
2580 {
2581#if defined(MBEDTLS_MD2_C)
2582 case PSA_ALG_MD2:
2583 mbedtls_md2_init( &operation->ctx.md2 );
2584 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2585 break;
2586#endif
2587#if defined(MBEDTLS_MD4_C)
2588 case PSA_ALG_MD4:
2589 mbedtls_md4_init( &operation->ctx.md4 );
2590 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2591 break;
2592#endif
2593#if defined(MBEDTLS_MD5_C)
2594 case PSA_ALG_MD5:
2595 mbedtls_md5_init( &operation->ctx.md5 );
2596 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2597 break;
2598#endif
2599#if defined(MBEDTLS_RIPEMD160_C)
2600 case PSA_ALG_RIPEMD160:
2601 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2602 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2603 break;
2604#endif
2605#if defined(MBEDTLS_SHA1_C)
2606 case PSA_ALG_SHA_1:
2607 mbedtls_sha1_init( &operation->ctx.sha1 );
2608 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2609 break;
2610#endif
2611#if defined(MBEDTLS_SHA256_C)
2612 case PSA_ALG_SHA_224:
2613 mbedtls_sha256_init( &operation->ctx.sha256 );
2614 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2615 break;
2616 case PSA_ALG_SHA_256:
2617 mbedtls_sha256_init( &operation->ctx.sha256 );
2618 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2619 break;
2620#endif
2621#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002622#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002623 case PSA_ALG_SHA_384:
2624 mbedtls_sha512_init( &operation->ctx.sha512 );
2625 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2626 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002627#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002628 case PSA_ALG_SHA_512:
2629 mbedtls_sha512_init( &operation->ctx.sha512 );
2630 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2631 break;
2632#endif
2633 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002634 return( PSA_ALG_IS_HASH( alg ) ?
2635 PSA_ERROR_NOT_SUPPORTED :
2636 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002637 }
2638 if( ret == 0 )
2639 operation->alg = alg;
2640 else
2641 psa_hash_abort( operation );
2642 return( mbedtls_to_psa_error( ret ) );
2643}
2644
2645psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2646 const uint8_t *input,
2647 size_t input_length )
2648{
Janos Follath24eed8d2019-11-22 13:21:35 +00002649 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002650
2651 /* Don't require hash implementations to behave correctly on a
2652 * zero-length input, which may have an invalid pointer. */
2653 if( input_length == 0 )
2654 return( PSA_SUCCESS );
2655
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002656 switch( operation->alg )
2657 {
2658#if defined(MBEDTLS_MD2_C)
2659 case PSA_ALG_MD2:
2660 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2661 input, input_length );
2662 break;
2663#endif
2664#if defined(MBEDTLS_MD4_C)
2665 case PSA_ALG_MD4:
2666 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2667 input, input_length );
2668 break;
2669#endif
2670#if defined(MBEDTLS_MD5_C)
2671 case PSA_ALG_MD5:
2672 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2673 input, input_length );
2674 break;
2675#endif
2676#if defined(MBEDTLS_RIPEMD160_C)
2677 case PSA_ALG_RIPEMD160:
2678 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2679 input, input_length );
2680 break;
2681#endif
2682#if defined(MBEDTLS_SHA1_C)
2683 case PSA_ALG_SHA_1:
2684 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2685 input, input_length );
2686 break;
2687#endif
2688#if defined(MBEDTLS_SHA256_C)
2689 case PSA_ALG_SHA_224:
2690 case PSA_ALG_SHA_256:
2691 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2692 input, input_length );
2693 break;
2694#endif
2695#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002696#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002697 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002698#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002699 case PSA_ALG_SHA_512:
2700 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2701 input, input_length );
2702 break;
2703#endif
2704 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002705 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002706 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002707
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002708 if( ret != 0 )
2709 psa_hash_abort( operation );
2710 return( mbedtls_to_psa_error( ret ) );
2711}
2712
2713psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2714 uint8_t *hash,
2715 size_t hash_size,
2716 size_t *hash_length )
2717{
itayzafrir40835d42018-08-02 13:14:17 +03002718 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002719 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002720 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002721
2722 /* Fill the output buffer with something that isn't a valid hash
2723 * (barring an attack on the hash and deliberately-crafted input),
2724 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002725 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002726 /* If hash_size is 0 then hash may be NULL and then the
2727 * call to memset would have undefined behavior. */
2728 if( hash_size != 0 )
2729 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002730
2731 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002732 {
2733 status = PSA_ERROR_BUFFER_TOO_SMALL;
2734 goto exit;
2735 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002736
2737 switch( operation->alg )
2738 {
2739#if defined(MBEDTLS_MD2_C)
2740 case PSA_ALG_MD2:
2741 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2742 break;
2743#endif
2744#if defined(MBEDTLS_MD4_C)
2745 case PSA_ALG_MD4:
2746 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2747 break;
2748#endif
2749#if defined(MBEDTLS_MD5_C)
2750 case PSA_ALG_MD5:
2751 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2752 break;
2753#endif
2754#if defined(MBEDTLS_RIPEMD160_C)
2755 case PSA_ALG_RIPEMD160:
2756 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2757 break;
2758#endif
2759#if defined(MBEDTLS_SHA1_C)
2760 case PSA_ALG_SHA_1:
2761 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2762 break;
2763#endif
2764#if defined(MBEDTLS_SHA256_C)
2765 case PSA_ALG_SHA_224:
2766 case PSA_ALG_SHA_256:
2767 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2768 break;
2769#endif
2770#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002771#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002772 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002773#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002774 case PSA_ALG_SHA_512:
2775 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2776 break;
2777#endif
2778 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002779 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002780 }
itayzafrir40835d42018-08-02 13:14:17 +03002781 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002782
itayzafrir40835d42018-08-02 13:14:17 +03002783exit:
2784 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002785 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002786 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002787 return( psa_hash_abort( operation ) );
2788 }
2789 else
2790 {
2791 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002792 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002793 }
2794}
2795
Gilles Peskine2d277862018-06-18 15:41:12 +02002796psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2797 const uint8_t *hash,
2798 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002799{
2800 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2801 size_t actual_hash_length;
2802 psa_status_t status = psa_hash_finish( operation,
2803 actual_hash, sizeof( actual_hash ),
2804 &actual_hash_length );
2805 if( status != PSA_SUCCESS )
2806 return( status );
2807 if( actual_hash_length != hash_length )
2808 return( PSA_ERROR_INVALID_SIGNATURE );
2809 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2810 return( PSA_ERROR_INVALID_SIGNATURE );
2811 return( PSA_SUCCESS );
2812}
2813
Gilles Peskine0a749c82019-11-28 19:33:58 +01002814psa_status_t psa_hash_compute( psa_algorithm_t alg,
2815 const uint8_t *input, size_t input_length,
2816 uint8_t *hash, size_t hash_size,
2817 size_t *hash_length )
2818{
2819 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2820 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2821
2822 *hash_length = hash_size;
2823 status = psa_hash_setup( &operation, alg );
2824 if( status != PSA_SUCCESS )
2825 goto exit;
2826 status = psa_hash_update( &operation, input, input_length );
2827 if( status != PSA_SUCCESS )
2828 goto exit;
2829 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2830 if( status != PSA_SUCCESS )
2831 goto exit;
2832
2833exit:
2834 if( status == PSA_SUCCESS )
2835 status = psa_hash_abort( &operation );
2836 else
2837 psa_hash_abort( &operation );
2838 return( status );
2839}
2840
2841psa_status_t psa_hash_compare( psa_algorithm_t alg,
2842 const uint8_t *input, size_t input_length,
2843 const uint8_t *hash, size_t hash_length )
2844{
2845 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2847
2848 status = psa_hash_setup( &operation, alg );
2849 if( status != PSA_SUCCESS )
2850 goto exit;
2851 status = psa_hash_update( &operation, input, input_length );
2852 if( status != PSA_SUCCESS )
2853 goto exit;
2854 status = psa_hash_verify( &operation, hash, hash_length );
2855 if( status != PSA_SUCCESS )
2856 goto exit;
2857
2858exit:
2859 if( status == PSA_SUCCESS )
2860 status = psa_hash_abort( &operation );
2861 else
2862 psa_hash_abort( &operation );
2863 return( status );
2864}
2865
Gilles Peskineeb35d782019-01-22 17:56:16 +01002866psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2867 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002868{
2869 if( target_operation->alg != 0 )
2870 return( PSA_ERROR_BAD_STATE );
2871
2872 switch( source_operation->alg )
2873 {
2874 case 0:
2875 return( PSA_ERROR_BAD_STATE );
2876#if defined(MBEDTLS_MD2_C)
2877 case PSA_ALG_MD2:
2878 mbedtls_md2_clone( &target_operation->ctx.md2,
2879 &source_operation->ctx.md2 );
2880 break;
2881#endif
2882#if defined(MBEDTLS_MD4_C)
2883 case PSA_ALG_MD4:
2884 mbedtls_md4_clone( &target_operation->ctx.md4,
2885 &source_operation->ctx.md4 );
2886 break;
2887#endif
2888#if defined(MBEDTLS_MD5_C)
2889 case PSA_ALG_MD5:
2890 mbedtls_md5_clone( &target_operation->ctx.md5,
2891 &source_operation->ctx.md5 );
2892 break;
2893#endif
2894#if defined(MBEDTLS_RIPEMD160_C)
2895 case PSA_ALG_RIPEMD160:
2896 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2897 &source_operation->ctx.ripemd160 );
2898 break;
2899#endif
2900#if defined(MBEDTLS_SHA1_C)
2901 case PSA_ALG_SHA_1:
2902 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2903 &source_operation->ctx.sha1 );
2904 break;
2905#endif
2906#if defined(MBEDTLS_SHA256_C)
2907 case PSA_ALG_SHA_224:
2908 case PSA_ALG_SHA_256:
2909 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2910 &source_operation->ctx.sha256 );
2911 break;
2912#endif
2913#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002914#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002915 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002916#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002917 case PSA_ALG_SHA_512:
2918 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2919 &source_operation->ctx.sha512 );
2920 break;
2921#endif
2922 default:
2923 return( PSA_ERROR_NOT_SUPPORTED );
2924 }
2925
2926 target_operation->alg = source_operation->alg;
2927 return( PSA_SUCCESS );
2928}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002929
2930
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002931/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932/* MAC */
2933/****************************************************************/
2934
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002935static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002936 psa_algorithm_t alg,
2937 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002938 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002939 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002940{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002941 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002942 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002943
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002944 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002945 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002946
Gilles Peskine8c9def32018-02-08 10:02:12 +01002947 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2948 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002949 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002950 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002951 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002952 mode = MBEDTLS_MODE_STREAM;
2953 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002954 case PSA_ALG_CTR:
2955 mode = MBEDTLS_MODE_CTR;
2956 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002957 case PSA_ALG_CFB:
2958 mode = MBEDTLS_MODE_CFB;
2959 break;
2960 case PSA_ALG_OFB:
2961 mode = MBEDTLS_MODE_OFB;
2962 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002963 case PSA_ALG_ECB_NO_PADDING:
2964 mode = MBEDTLS_MODE_ECB;
2965 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002966 case PSA_ALG_CBC_NO_PADDING:
2967 mode = MBEDTLS_MODE_CBC;
2968 break;
2969 case PSA_ALG_CBC_PKCS7:
2970 mode = MBEDTLS_MODE_CBC;
2971 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002972 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002973 mode = MBEDTLS_MODE_CCM;
2974 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002975 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002976 mode = MBEDTLS_MODE_GCM;
2977 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002978 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2979 mode = MBEDTLS_MODE_CHACHAPOLY;
2980 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002981 default:
2982 return( NULL );
2983 }
2984 }
2985 else if( alg == PSA_ALG_CMAC )
2986 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002987 else
2988 return( NULL );
2989
2990 switch( key_type )
2991 {
2992 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002993 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002994 break;
2995 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002996 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2997 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002998 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002999 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003000 else
mohammad1603f4f0d612018-06-03 15:04:51 +03003001 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003002 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
3003 * but two-key Triple-DES is functionally three-key Triple-DES
3004 * with K1=K3, so that's how we present it to mbedtls. */
3005 if( key_bits == 128 )
3006 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003007 break;
3008 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03003009 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003010 break;
3011 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03003012 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003013 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02003014 case PSA_KEY_TYPE_CHACHA20:
3015 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
3016 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003017 default:
3018 return( NULL );
3019 }
mohammad1603f4f0d612018-06-03 15:04:51 +03003020 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03003021 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003022
Jaeden Amero23bbb752018-06-26 14:16:54 +01003023 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
3024 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003025}
3026
John Durkop6ba40d12020-11-10 08:50:04 -08003027#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003028static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003029{
Gilles Peskine2d277862018-06-18 15:41:12 +02003030 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003031 {
3032 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003033 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003034 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003035 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003036 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003037 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003038 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003039 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003040 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003041 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003042 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003043 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003044 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003045 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003046 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003047 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003048 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02003049 return( 128 );
3050 default:
3051 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003052 }
3053}
John Durkop07cc04a2020-11-16 22:08:34 -08003054#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03003055
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003056/* Initialize the MAC operation structure. Once this function has been
3057 * called, psa_mac_abort can run and will do the right thing. */
3058static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
3059 psa_algorithm_t alg )
3060{
3061 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
3062
3063 operation->alg = alg;
3064 operation->key_set = 0;
3065 operation->iv_set = 0;
3066 operation->iv_required = 0;
3067 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003068 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003069
3070#if defined(MBEDTLS_CMAC_C)
3071 if( alg == PSA_ALG_CMAC )
3072 {
3073 operation->iv_required = 0;
3074 mbedtls_cipher_init( &operation->ctx.cmac );
3075 status = PSA_SUCCESS;
3076 }
3077 else
3078#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003079#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003080 if( PSA_ALG_IS_HMAC( operation->alg ) )
3081 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02003082 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
3083 operation->ctx.hmac.hash_ctx.alg = 0;
3084 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003085 }
3086 else
John Durkopd0321952020-10-29 21:37:36 -07003087#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003088 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02003089 if( ! PSA_ALG_IS_MAC( alg ) )
3090 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003091 }
3092
3093 if( status != PSA_SUCCESS )
3094 memset( operation, 0, sizeof( *operation ) );
3095 return( status );
3096}
3097
John Durkop6ba40d12020-11-10 08:50:04 -08003098#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003099static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
3100{
Gilles Peskine3f108122018-12-07 18:14:53 +01003101 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003102 return( psa_hash_abort( &hmac->hash_ctx ) );
3103}
John Durkop6ba40d12020-11-10 08:50:04 -08003104#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003105
Gilles Peskine8c9def32018-02-08 10:02:12 +01003106psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
3107{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003108 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003109 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003110 /* The object has (apparently) been initialized but it is not
3111 * in use. It's ok to call abort on such an object, and there's
3112 * nothing to do. */
3113 return( PSA_SUCCESS );
3114 }
3115 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003116#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003117 if( operation->alg == PSA_ALG_CMAC )
3118 {
3119 mbedtls_cipher_free( &operation->ctx.cmac );
3120 }
3121 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003122#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003123#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003124 if( PSA_ALG_IS_HMAC( operation->alg ) )
3125 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003126 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003127 }
3128 else
John Durkopd0321952020-10-29 21:37:36 -07003129#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003130 {
3131 /* Sanity check (shouldn't happen: operation->alg should
3132 * always have been initialized to a valid value). */
3133 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003134 }
Moran Peker41deec42018-04-04 15:43:05 +03003135
Gilles Peskine8c9def32018-02-08 10:02:12 +01003136 operation->alg = 0;
3137 operation->key_set = 0;
3138 operation->iv_set = 0;
3139 operation->iv_required = 0;
3140 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003141 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003142
Gilles Peskine8c9def32018-02-08 10:02:12 +01003143 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003144
3145bad_state:
3146 /* If abort is called on an uninitialized object, we can't trust
3147 * anything. Wipe the object in case it contains confidential data.
3148 * This may result in a memory leak if a pointer gets overwritten,
3149 * but it's too late to do anything about this. */
3150 memset( operation, 0, sizeof( *operation ) );
3151 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003152}
3153
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003154#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003155static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003156 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003157 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003158 const mbedtls_cipher_info_t *cipher_info )
3159{
Janos Follath24eed8d2019-11-22 13:21:35 +00003160 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003161
3162 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003163
3164 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3165 if( ret != 0 )
3166 return( ret );
3167
3168 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003169 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003170 key_bits );
3171 return( ret );
3172}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003173#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003174
John Durkop6ba40d12020-11-10 08:50:04 -08003175#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003176static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3177 const uint8_t *key,
3178 size_t key_length,
3179 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003180{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003181 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003182 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003183 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003184 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003185 psa_status_t status;
3186
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003187 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3188 * overflow below. This should never trigger if the hash algorithm
3189 * is implemented correctly. */
3190 /* The size checks against the ipad and opad buffers cannot be written
3191 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3192 * because that triggers -Wlogical-op on GCC 7.3. */
3193 if( block_size > sizeof( ipad ) )
3194 return( PSA_ERROR_NOT_SUPPORTED );
3195 if( block_size > sizeof( hmac->opad ) )
3196 return( PSA_ERROR_NOT_SUPPORTED );
3197 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003198 return( PSA_ERROR_NOT_SUPPORTED );
3199
Gilles Peskined223b522018-06-11 18:12:58 +02003200 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003201 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003202 status = psa_hash_compute( hash_alg, key, key_length,
3203 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003204 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003205 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003206 }
Gilles Peskine96889972018-07-12 17:07:03 +02003207 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3208 * but it is permitted. It is common when HMAC is used in HKDF, for
3209 * example. Don't call `memcpy` in the 0-length because `key` could be
3210 * an invalid pointer which would make the behavior undefined. */
3211 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003212 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003213
Gilles Peskined223b522018-06-11 18:12:58 +02003214 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3215 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003216 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003217 ipad[i] ^= 0x36;
3218 memset( ipad + key_length, 0x36, block_size - key_length );
3219
3220 /* Copy the key material from ipad to opad, flipping the requisite bits,
3221 * and filling the rest of opad with the requisite constant. */
3222 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003223 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3224 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003225
Gilles Peskine01126fa2018-07-12 17:04:55 +02003226 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003227 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003228 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003229
Gilles Peskine01126fa2018-07-12 17:04:55 +02003230 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003231
3232cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003233 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003234
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003235 return( status );
3236}
John Durkop6ba40d12020-11-10 08:50:04 -08003237#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003238
Gilles Peskine89167cb2018-07-08 20:12:23 +02003239static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003240 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003241 psa_algorithm_t alg,
3242 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003243{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003245 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003246 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003247 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003248 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003249 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003250 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003251 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003252
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003253 /* A context must be freshly initialized before it can be set up. */
3254 if( operation->alg != 0 )
3255 {
3256 return( PSA_ERROR_BAD_STATE );
3257 }
3258
Gilles Peskined911eb72018-08-14 15:18:45 +02003259 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003260 if( status != PSA_SUCCESS )
3261 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003262 if( is_sign )
3263 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003264
Ronald Cron5c522922020-11-14 16:35:34 +01003265 status = psa_get_and_lock_transparent_key_slot_with_policy(
3266 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003267 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003268 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003269 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003270
Gilles Peskine8c9def32018-02-08 10:02:12 +01003271#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003272 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003273 {
3274 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003275 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003276 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003277 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003278 if( cipher_info == NULL )
3279 {
3280 status = PSA_ERROR_NOT_SUPPORTED;
3281 goto exit;
3282 }
3283 operation->mac_size = cipher_info->block_size;
3284 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3285 status = mbedtls_to_psa_error( ret );
3286 }
3287 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003288#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003289#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02003290 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003291 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003292 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003293 if( hash_alg == 0 )
3294 {
3295 status = PSA_ERROR_NOT_SUPPORTED;
3296 goto exit;
3297 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003298
3299 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3300 /* Sanity check. This shouldn't fail on a valid configuration. */
3301 if( operation->mac_size == 0 ||
3302 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3303 {
3304 status = PSA_ERROR_NOT_SUPPORTED;
3305 goto exit;
3306 }
3307
Gilles Peskine8e338702019-07-30 20:06:31 +02003308 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003309 {
3310 status = PSA_ERROR_INVALID_ARGUMENT;
3311 goto exit;
3312 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003313
Gilles Peskine01126fa2018-07-12 17:04:55 +02003314 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003315 slot->data.key.data,
3316 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003317 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003318 }
3319 else
John Durkopd0321952020-10-29 21:37:36 -07003320#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003321 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003322 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003323 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003324 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003325
Gilles Peskined911eb72018-08-14 15:18:45 +02003326 if( truncated == 0 )
3327 {
3328 /* The "normal" case: untruncated algorithm. Nothing to do. */
3329 }
3330 else if( truncated < 4 )
3331 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003332 /* A very short MAC is too short for security since it can be
3333 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3334 * so we make this our minimum, even though 32 bits is still
3335 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003336 status = PSA_ERROR_NOT_SUPPORTED;
3337 }
3338 else if( truncated > operation->mac_size )
3339 {
3340 /* It's impossible to "truncate" to a larger length. */
3341 status = PSA_ERROR_INVALID_ARGUMENT;
3342 }
3343 else
3344 operation->mac_size = truncated;
3345
Gilles Peskinefbfac682018-07-08 20:51:54 +02003346exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003347 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003348 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003349 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003350 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003351 else
3352 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003353 operation->key_set = 1;
3354 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003355
Ronald Cron5c522922020-11-14 16:35:34 +01003356 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003357
Ronald Cron5c522922020-11-14 16:35:34 +01003358 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003359}
3360
Gilles Peskine89167cb2018-07-08 20:12:23 +02003361psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003362 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003363 psa_algorithm_t alg )
3364{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003365 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003366}
3367
3368psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003369 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003370 psa_algorithm_t alg )
3371{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003372 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003373}
3374
Gilles Peskine8c9def32018-02-08 10:02:12 +01003375psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3376 const uint8_t *input,
3377 size_t input_length )
3378{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003379 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003380 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003381 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003382 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003383 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003384 operation->has_input = 1;
3385
Gilles Peskine8c9def32018-02-08 10:02:12 +01003386#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003387 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003388 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003389 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3390 input, input_length );
3391 status = mbedtls_to_psa_error( ret );
3392 }
3393 else
3394#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003395#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003396 if( PSA_ALG_IS_HMAC( operation->alg ) )
3397 {
3398 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3399 input_length );
3400 }
3401 else
John Durkopd0321952020-10-29 21:37:36 -07003402#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003403 {
3404 /* This shouldn't happen if `operation` was initialized by
3405 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003406 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003407 }
3408
Gilles Peskinefbfac682018-07-08 20:51:54 +02003409 if( status != PSA_SUCCESS )
3410 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003411 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003412}
3413
John Durkop6ba40d12020-11-10 08:50:04 -08003414#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003415static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3416 uint8_t *mac,
3417 size_t mac_size )
3418{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003419 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003420 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3421 size_t hash_size = 0;
3422 size_t block_size = psa_get_hash_block_size( hash_alg );
3423 psa_status_t status;
3424
Gilles Peskine01126fa2018-07-12 17:04:55 +02003425 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3426 if( status != PSA_SUCCESS )
3427 return( status );
3428 /* From here on, tmp needs to be wiped. */
3429
3430 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3431 if( status != PSA_SUCCESS )
3432 goto exit;
3433
3434 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3435 if( status != PSA_SUCCESS )
3436 goto exit;
3437
3438 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3439 if( status != PSA_SUCCESS )
3440 goto exit;
3441
Gilles Peskined911eb72018-08-14 15:18:45 +02003442 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3443 if( status != PSA_SUCCESS )
3444 goto exit;
3445
3446 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003447
3448exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003449 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003450 return( status );
3451}
John Durkop6ba40d12020-11-10 08:50:04 -08003452#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003453
mohammad16036df908f2018-04-02 08:34:15 -07003454static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003455 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003456 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003457{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003458 if( ! operation->key_set )
3459 return( PSA_ERROR_BAD_STATE );
3460 if( operation->iv_required && ! operation->iv_set )
3461 return( PSA_ERROR_BAD_STATE );
3462
Gilles Peskine8c9def32018-02-08 10:02:12 +01003463 if( mac_size < operation->mac_size )
3464 return( PSA_ERROR_BUFFER_TOO_SMALL );
3465
Gilles Peskine8c9def32018-02-08 10:02:12 +01003466#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003467 if( operation->alg == PSA_ALG_CMAC )
3468 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003469 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3470 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3471 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003472 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003473 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003474 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003475 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003476 else
3477#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003478#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003479 if( PSA_ALG_IS_HMAC( operation->alg ) )
3480 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003481 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003482 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003483 }
3484 else
John Durkopd0321952020-10-29 21:37:36 -07003485#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003486 {
3487 /* This shouldn't happen if `operation` was initialized by
3488 * a setup function. */
3489 return( PSA_ERROR_BAD_STATE );
3490 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003491}
3492
Gilles Peskineacd4be32018-07-08 19:56:25 +02003493psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3494 uint8_t *mac,
3495 size_t mac_size,
3496 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003497{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003498 psa_status_t status;
3499
Jaeden Amero252ef282019-02-15 14:05:35 +00003500 if( operation->alg == 0 )
3501 {
3502 return( PSA_ERROR_BAD_STATE );
3503 }
3504
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003505 /* Fill the output buffer with something that isn't a valid mac
3506 * (barring an attack on the mac and deliberately-crafted input),
3507 * in case the caller doesn't check the return status properly. */
3508 *mac_length = mac_size;
3509 /* If mac_size is 0 then mac may be NULL and then the
3510 * call to memset would have undefined behavior. */
3511 if( mac_size != 0 )
3512 memset( mac, '!', mac_size );
3513
Gilles Peskine89167cb2018-07-08 20:12:23 +02003514 if( ! operation->is_sign )
3515 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003516 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003517 }
mohammad16036df908f2018-04-02 08:34:15 -07003518
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003519 status = psa_mac_finish_internal( operation, mac, mac_size );
3520
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003521 if( status == PSA_SUCCESS )
3522 {
3523 status = psa_mac_abort( operation );
3524 if( status == PSA_SUCCESS )
3525 *mac_length = operation->mac_size;
3526 else
3527 memset( mac, '!', mac_size );
3528 }
3529 else
3530 psa_mac_abort( operation );
3531 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003532}
3533
Gilles Peskineacd4be32018-07-08 19:56:25 +02003534psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3535 const uint8_t *mac,
3536 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003537{
Gilles Peskine828ed142018-06-18 23:25:51 +02003538 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003539 psa_status_t status;
3540
Jaeden Amero252ef282019-02-15 14:05:35 +00003541 if( operation->alg == 0 )
3542 {
3543 return( PSA_ERROR_BAD_STATE );
3544 }
3545
Gilles Peskine89167cb2018-07-08 20:12:23 +02003546 if( operation->is_sign )
3547 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003548 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003549 }
3550 if( operation->mac_size != mac_length )
3551 {
3552 status = PSA_ERROR_INVALID_SIGNATURE;
3553 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003554 }
mohammad16036df908f2018-04-02 08:34:15 -07003555
3556 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003557 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003558 if( status != PSA_SUCCESS )
3559 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003560
3561 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3562 status = PSA_ERROR_INVALID_SIGNATURE;
3563
3564cleanup:
3565 if( status == PSA_SUCCESS )
3566 status = psa_mac_abort( operation );
3567 else
3568 psa_mac_abort( operation );
3569
Gilles Peskine3f108122018-12-07 18:14:53 +01003570 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003571
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003572 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003573}
3574
3575
Gilles Peskine20035e32018-02-03 22:44:14 +01003576
Gilles Peskine20035e32018-02-03 22:44:14 +01003577/****************************************************************/
3578/* Asymmetric cryptography */
3579/****************************************************************/
3580
John Durkop6ba40d12020-11-10 08:50:04 -08003581#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3582 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003583/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003584 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003585static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3586 size_t hash_length,
3587 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003588{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003589 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003590 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003591 *md_alg = mbedtls_md_get_type( md_info );
3592
3593 /* The Mbed TLS RSA module uses an unsigned int for hash length
3594 * parameters. Validate that it fits so that we don't risk an
3595 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003596#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003597 if( hash_length > UINT_MAX )
3598 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003599#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003600
John Durkop0e005192020-10-31 22:06:54 -07003601#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003602 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3603 * must be correct. */
3604 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3605 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003606 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003607 if( md_info == NULL )
3608 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003609 if( mbedtls_md_get_size( md_info ) != hash_length )
3610 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003611 }
John Durkop0e005192020-10-31 22:06:54 -07003612#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003613
John Durkop0e005192020-10-31 22:06:54 -07003614#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003615 /* PSS requires a hash internally. */
3616 if( PSA_ALG_IS_RSA_PSS( alg ) )
3617 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003618 if( md_info == NULL )
3619 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003620 }
John Durkop0e005192020-10-31 22:06:54 -07003621#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003622
Gilles Peskine61b91d42018-06-08 16:09:36 +02003623 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003624}
3625
Gilles Peskine2b450e32018-06-27 15:42:46 +02003626static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3627 psa_algorithm_t alg,
3628 const uint8_t *hash,
3629 size_t hash_length,
3630 uint8_t *signature,
3631 size_t signature_size,
3632 size_t *signature_length )
3633{
3634 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003635 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003636 mbedtls_md_type_t md_alg;
3637
3638 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3639 if( status != PSA_SUCCESS )
3640 return( status );
3641
Gilles Peskine630a18a2018-06-29 17:49:35 +02003642 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003643 return( PSA_ERROR_BUFFER_TOO_SMALL );
3644
John Durkop0e005192020-10-31 22:06:54 -07003645#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003646 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3647 {
3648 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3649 MBEDTLS_MD_NONE );
3650 ret = mbedtls_rsa_pkcs1_sign( rsa,
3651 mbedtls_ctr_drbg_random,
3652 &global_data.ctr_drbg,
3653 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003654 md_alg,
3655 (unsigned int) hash_length,
3656 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003657 signature );
3658 }
3659 else
John Durkop0e005192020-10-31 22:06:54 -07003660#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3661#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003662 if( PSA_ALG_IS_RSA_PSS( alg ) )
3663 {
3664 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3665 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3666 mbedtls_ctr_drbg_random,
3667 &global_data.ctr_drbg,
3668 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003669 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003670 (unsigned int) hash_length,
3671 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003672 signature );
3673 }
3674 else
John Durkop0e005192020-10-31 22:06:54 -07003675#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003676 {
3677 return( PSA_ERROR_INVALID_ARGUMENT );
3678 }
3679
3680 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003681 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003682 return( mbedtls_to_psa_error( ret ) );
3683}
3684
3685static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3686 psa_algorithm_t alg,
3687 const uint8_t *hash,
3688 size_t hash_length,
3689 const uint8_t *signature,
3690 size_t signature_length )
3691{
3692 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003693 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003694 mbedtls_md_type_t md_alg;
3695
3696 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3697 if( status != PSA_SUCCESS )
3698 return( status );
3699
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003700 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3701 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003702
John Durkop0e005192020-10-31 22:06:54 -07003703#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003704 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3705 {
3706 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3707 MBEDTLS_MD_NONE );
3708 ret = mbedtls_rsa_pkcs1_verify( rsa,
3709 mbedtls_ctr_drbg_random,
3710 &global_data.ctr_drbg,
3711 MBEDTLS_RSA_PUBLIC,
3712 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003713 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003714 hash,
3715 signature );
3716 }
3717 else
John Durkop0e005192020-10-31 22:06:54 -07003718#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3719#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003720 if( PSA_ALG_IS_RSA_PSS( alg ) )
3721 {
3722 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3723 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3724 mbedtls_ctr_drbg_random,
3725 &global_data.ctr_drbg,
3726 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003727 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003728 (unsigned int) hash_length,
3729 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003730 signature );
3731 }
3732 else
John Durkop0e005192020-10-31 22:06:54 -07003733#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003734 {
3735 return( PSA_ERROR_INVALID_ARGUMENT );
3736 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003737
3738 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3739 * the rest of the signature is invalid". This has little use in
3740 * practice and PSA doesn't report this distinction. */
3741 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3742 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003743 return( mbedtls_to_psa_error( ret ) );
3744}
John Durkop6ba40d12020-11-10 08:50:04 -08003745#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3746 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003747
John Durkop6ba40d12020-11-10 08:50:04 -08003748#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3749 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003750/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3751 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3752 * (even though these functions don't modify it). */
3753static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3754 psa_algorithm_t alg,
3755 const uint8_t *hash,
3756 size_t hash_length,
3757 uint8_t *signature,
3758 size_t signature_size,
3759 size_t *signature_length )
3760{
Janos Follath24eed8d2019-11-22 13:21:35 +00003761 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003762 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003763 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003764 mbedtls_mpi_init( &r );
3765 mbedtls_mpi_init( &s );
3766
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003767 if( signature_size < 2 * curve_bytes )
3768 {
3769 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3770 goto cleanup;
3771 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003772
John Durkop0ea39e02020-10-13 19:58:20 -07003773#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003774 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3775 {
3776 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3777 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3778 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003779 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3780 &ecp->d, hash,
3781 hash_length, md_alg,
3782 mbedtls_ctr_drbg_random,
3783 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003784 }
3785 else
John Durkop0ea39e02020-10-13 19:58:20 -07003786#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003787 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003788 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003789 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3790 hash, hash_length,
3791 mbedtls_ctr_drbg_random,
3792 &global_data.ctr_drbg ) );
3793 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003794
3795 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3796 signature,
3797 curve_bytes ) );
3798 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3799 signature + curve_bytes,
3800 curve_bytes ) );
3801
3802cleanup:
3803 mbedtls_mpi_free( &r );
3804 mbedtls_mpi_free( &s );
3805 if( ret == 0 )
3806 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003807 return( mbedtls_to_psa_error( ret ) );
3808}
3809
3810static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3811 const uint8_t *hash,
3812 size_t hash_length,
3813 const uint8_t *signature,
3814 size_t signature_length )
3815{
Janos Follath24eed8d2019-11-22 13:21:35 +00003816 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003817 mbedtls_mpi r, s;
3818 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3819 mbedtls_mpi_init( &r );
3820 mbedtls_mpi_init( &s );
3821
3822 if( signature_length != 2 * curve_bytes )
3823 return( PSA_ERROR_INVALID_SIGNATURE );
3824
3825 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3826 signature,
3827 curve_bytes ) );
3828 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3829 signature + curve_bytes,
3830 curve_bytes ) );
3831
Steven Cooremanacda8342020-07-24 23:09:52 +02003832 /* Check whether the public part is loaded. If not, load it. */
3833 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3834 {
3835 MBEDTLS_MPI_CHK(
3836 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3837 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3838 }
3839
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003840 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3841 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003842
3843cleanup:
3844 mbedtls_mpi_free( &r );
3845 mbedtls_mpi_free( &s );
3846 return( mbedtls_to_psa_error( ret ) );
3847}
John Durkop6ba40d12020-11-10 08:50:04 -08003848#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3849 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003850
Ronald Croncf56a0a2020-08-04 09:51:30 +02003851psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003852 psa_algorithm_t alg,
3853 const uint8_t *hash,
3854 size_t hash_length,
3855 uint8_t *signature,
3856 size_t signature_size,
3857 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003858{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003859 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003860 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003861 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003862
3863 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003864 /* Immediately reject a zero-length signature buffer. This guarantees
3865 * that signature must be a valid pointer. (On the other hand, the hash
3866 * buffer can in principle be empty since it doesn't actually have
3867 * to be a hash.) */
3868 if( signature_size == 0 )
3869 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003870
Ronald Cron5c522922020-11-14 16:35:34 +01003871 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3872 PSA_KEY_USAGE_SIGN_HASH,
3873 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003874 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003875 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003876 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003877 {
3878 status = PSA_ERROR_INVALID_ARGUMENT;
3879 goto exit;
3880 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003881
Steven Cooremancd84cb42020-07-16 20:28:36 +02003882 /* Try any of the available accelerators first */
3883 status = psa_driver_wrapper_sign_hash( slot,
3884 alg,
3885 hash,
3886 hash_length,
3887 signature,
3888 signature_size,
3889 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003890 if( status != PSA_ERROR_NOT_SUPPORTED ||
3891 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003892 goto exit;
3893
Steven Cooreman7a250572020-07-17 16:43:05 +02003894 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003895#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3896 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003897 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003898 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003899 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003900
Steven Cooreman4fed4552020-08-03 14:46:03 +02003901 status = psa_load_rsa_representation( slot->attr.type,
3902 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003903 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003904 &rsa );
3905 if( status != PSA_SUCCESS )
3906 goto exit;
3907
Steven Cooremana2371e52020-07-28 14:30:39 +02003908 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003909 alg,
3910 hash, hash_length,
3911 signature, signature_size,
3912 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003913
Steven Cooremana2371e52020-07-28 14:30:39 +02003914 mbedtls_rsa_free( rsa );
3915 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003916 }
3917 else
John Durkop6ba40d12020-11-10 08:50:04 -08003918#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3919 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003920 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003921 {
John Durkop9814fa22020-11-04 12:28:15 -08003922#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3923 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003924 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003925#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003926 PSA_ALG_IS_ECDSA( alg )
3927#else
3928 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3929#endif
3930 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003931 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003932 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003933 status = psa_load_ecp_representation( slot->attr.type,
3934 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003935 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003936 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003937 if( status != PSA_SUCCESS )
3938 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003939 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003940 alg,
3941 hash, hash_length,
3942 signature, signature_size,
3943 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003944 mbedtls_ecp_keypair_free( ecp );
3945 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003946 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003947 else
John Durkop9814fa22020-11-04 12:28:15 -08003948#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3949 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003950 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003951 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003952 }
itayzafrir5c753392018-05-08 11:18:38 +03003953 }
3954 else
itayzafrir5c753392018-05-08 11:18:38 +03003955 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003956 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003957 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003958
3959exit:
3960 /* Fill the unused part of the output buffer (the whole buffer on error,
3961 * the trailing part on success) with something that isn't a valid mac
3962 * (barring an attack on the mac and deliberately-crafted input),
3963 * in case the caller doesn't check the return status properly. */
3964 if( status == PSA_SUCCESS )
3965 memset( signature + *signature_length, '!',
3966 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003967 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003968 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003969 /* If signature_size is 0 then we have nothing to do. We must not call
3970 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003971
Ronald Cron5c522922020-11-14 16:35:34 +01003972 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003973
Ronald Cron5c522922020-11-14 16:35:34 +01003974 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003975}
3976
Ronald Croncf56a0a2020-08-04 09:51:30 +02003977psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003978 psa_algorithm_t alg,
3979 const uint8_t *hash,
3980 size_t hash_length,
3981 const uint8_t *signature,
3982 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003983{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003984 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003985 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003986 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003987
Ronald Cron5c522922020-11-14 16:35:34 +01003988 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3989 PSA_KEY_USAGE_VERIFY_HASH,
3990 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003991 if( status != PSA_SUCCESS )
3992 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003993
Steven Cooreman55ae2172020-07-17 19:46:15 +02003994 /* Try any of the available accelerators first */
3995 status = psa_driver_wrapper_verify_hash( slot,
3996 alg,
3997 hash,
3998 hash_length,
3999 signature,
4000 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02004001 if( status != PSA_ERROR_NOT_SUPPORTED ||
4002 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004003 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02004004
John Durkop6ba40d12020-11-10 08:50:04 -08004005#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
4006 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02004007 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004008 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004009 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02004010
Steven Cooreman4fed4552020-08-03 14:46:03 +02004011 status = psa_load_rsa_representation( slot->attr.type,
4012 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004013 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004014 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004015 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004016 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004017
Steven Cooremana2371e52020-07-28 14:30:39 +02004018 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02004019 alg,
4020 hash, hash_length,
4021 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004022 mbedtls_rsa_free( rsa );
4023 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004024 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004025 }
4026 else
John Durkop6ba40d12020-11-10 08:50:04 -08004027#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
4028 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02004029 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03004030 {
John Durkop9814fa22020-11-04 12:28:15 -08004031#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4032 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004033 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02004034 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004035 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004036 status = psa_load_ecp_representation( slot->attr.type,
4037 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004038 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004039 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004040 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004041 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004042 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004043 hash, hash_length,
4044 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004045 mbedtls_ecp_keypair_free( ecp );
4046 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004047 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02004048 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004049 else
John Durkop9814fa22020-11-04 12:28:15 -08004050#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4051 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004052 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004053 status = PSA_ERROR_INVALID_ARGUMENT;
4054 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004055 }
itayzafrir5c753392018-05-08 11:18:38 +03004056 }
Gilles Peskine20035e32018-02-03 22:44:14 +01004057 else
Gilles Peskine20035e32018-02-03 22:44:14 +01004058 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004059 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01004060 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004061
4062exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004063 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004064
Ronald Cron5c522922020-11-14 16:35:34 +01004065 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01004066}
4067
John Durkop0e005192020-10-31 22:06:54 -07004068#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02004069static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
4070 mbedtls_rsa_context *rsa )
4071{
4072 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
4073 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
4074 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
4075 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
4076}
John Durkop0e005192020-10-31 22:06:54 -07004077#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02004078
Ronald Croncf56a0a2020-08-04 09:51:30 +02004079psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004080 psa_algorithm_t alg,
4081 const uint8_t *input,
4082 size_t input_length,
4083 const uint8_t *salt,
4084 size_t salt_length,
4085 uint8_t *output,
4086 size_t output_size,
4087 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004088{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004089 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004090 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004091 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004092
Darryl Green5cc689a2018-07-24 15:34:10 +01004093 (void) input;
4094 (void) input_length;
4095 (void) salt;
4096 (void) output;
4097 (void) output_size;
4098
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004099 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004100
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004101 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4102 return( PSA_ERROR_INVALID_ARGUMENT );
4103
Ronald Cron5c522922020-11-14 16:35:34 +01004104 status = psa_get_and_lock_transparent_key_slot_with_policy(
4105 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004106 if( status != PSA_SUCCESS )
4107 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004108 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4109 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004110 {
4111 status = PSA_ERROR_INVALID_ARGUMENT;
4112 goto exit;
4113 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004114
John Durkop6ba40d12020-11-10 08:50:04 -08004115#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4116 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004117 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004118 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004119 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004120 status = psa_load_rsa_representation( slot->attr.type,
4121 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004122 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004123 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004124 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004125 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004126
4127 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004128 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004129 status = PSA_ERROR_BUFFER_TOO_SMALL;
4130 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004131 }
John Durkop0e005192020-10-31 22:06:54 -07004132#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004133 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004134 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004135 status = mbedtls_to_psa_error(
4136 mbedtls_rsa_pkcs1_encrypt( rsa,
4137 mbedtls_ctr_drbg_random,
4138 &global_data.ctr_drbg,
4139 MBEDTLS_RSA_PUBLIC,
4140 input_length,
4141 input,
4142 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004143 }
4144 else
John Durkop0e005192020-10-31 22:06:54 -07004145#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4146#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004147 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004148 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004149 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004150 status = mbedtls_to_psa_error(
4151 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
4152 mbedtls_ctr_drbg_random,
4153 &global_data.ctr_drbg,
4154 MBEDTLS_RSA_PUBLIC,
4155 salt, salt_length,
4156 input_length,
4157 input,
4158 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004159 }
4160 else
John Durkop0e005192020-10-31 22:06:54 -07004161#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004162 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004163 status = PSA_ERROR_INVALID_ARGUMENT;
4164 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004165 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004166rsa_exit:
4167 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004168 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004169
Steven Cooremana2371e52020-07-28 14:30:39 +02004170 mbedtls_rsa_free( rsa );
4171 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004172 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004173 else
John Durkop9814fa22020-11-04 12:28:15 -08004174#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08004175 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004176 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004177 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004178 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004179
4180exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004181 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004182
Ronald Cron5c522922020-11-14 16:35:34 +01004183 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004184}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004185
Ronald Croncf56a0a2020-08-04 09:51:30 +02004186psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004187 psa_algorithm_t alg,
4188 const uint8_t *input,
4189 size_t input_length,
4190 const uint8_t *salt,
4191 size_t salt_length,
4192 uint8_t *output,
4193 size_t output_size,
4194 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004195{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004196 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004197 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004198 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004199
Darryl Green5cc689a2018-07-24 15:34:10 +01004200 (void) input;
4201 (void) input_length;
4202 (void) salt;
4203 (void) output;
4204 (void) output_size;
4205
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004206 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004207
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004208 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4209 return( PSA_ERROR_INVALID_ARGUMENT );
4210
Ronald Cron5c522922020-11-14 16:35:34 +01004211 status = psa_get_and_lock_transparent_key_slot_with_policy(
4212 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004213 if( status != PSA_SUCCESS )
4214 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004215 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004216 {
4217 status = PSA_ERROR_INVALID_ARGUMENT;
4218 goto exit;
4219 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004220
John Durkop6ba40d12020-11-10 08:50:04 -08004221#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4222 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004223 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004224 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004225 mbedtls_rsa_context *rsa = NULL;
4226 status = psa_load_rsa_representation( slot->attr.type,
4227 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004228 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004229 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004230 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004231 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004232
Steven Cooremana2371e52020-07-28 14:30:39 +02004233 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004234 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004235 status = PSA_ERROR_INVALID_ARGUMENT;
4236 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004237 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004238
John Durkop0e005192020-10-31 22:06:54 -07004239#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004240 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004241 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004242 status = mbedtls_to_psa_error(
4243 mbedtls_rsa_pkcs1_decrypt( rsa,
4244 mbedtls_ctr_drbg_random,
4245 &global_data.ctr_drbg,
4246 MBEDTLS_RSA_PRIVATE,
4247 output_length,
4248 input,
4249 output,
4250 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004251 }
4252 else
John Durkop0e005192020-10-31 22:06:54 -07004253#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4254#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004255 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004256 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004257 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004258 status = mbedtls_to_psa_error(
4259 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4260 mbedtls_ctr_drbg_random,
4261 &global_data.ctr_drbg,
4262 MBEDTLS_RSA_PRIVATE,
4263 salt, salt_length,
4264 output_length,
4265 input,
4266 output,
4267 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004268 }
4269 else
John Durkop0e005192020-10-31 22:06:54 -07004270#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004271 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004272 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004273 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004274
Steven Cooreman4fed4552020-08-03 14:46:03 +02004275rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004276 mbedtls_rsa_free( rsa );
4277 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004278 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004279 else
John Durkop6ba40d12020-11-10 08:50:04 -08004280#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
4281 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004282 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004283 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004284 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004285
4286exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004287 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004288
Ronald Cron5c522922020-11-14 16:35:34 +01004289 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004290}
Gilles Peskine20035e32018-02-03 22:44:14 +01004291
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004292
4293
mohammad1603503973b2018-03-12 15:59:30 +02004294/****************************************************************/
4295/* Symmetric cryptography */
4296/****************************************************************/
4297
Gilles Peskinee553c652018-06-04 16:22:46 +02004298static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004299 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004300 psa_algorithm_t alg,
4301 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004302{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004304 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004305 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004306 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004307 size_t key_bits;
4308 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004309 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4310 PSA_KEY_USAGE_ENCRYPT :
4311 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004312
Steven Cooremand3feccd2020-09-01 15:56:14 +02004313 /* A context must be freshly initialized before it can be set up. */
4314 if( operation->alg != 0 )
4315 return( PSA_ERROR_BAD_STATE );
4316
Steven Cooremana07b9972020-09-10 14:54:14 +02004317 /* The requested algorithm must be one that can be processed by cipher. */
4318 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004319 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004320
Steven Cooremanef8575e2020-09-11 11:44:50 +02004321 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004322 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004323 if( status != PSA_SUCCESS )
4324 goto exit;
4325
4326 /* Initialize the operation struct members, except for alg. The alg member
4327 * is used to indicate to psa_cipher_abort that there are resources to free,
4328 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004329 operation->key_set = 0;
4330 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004331 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004332 operation->iv_size = 0;
4333 operation->block_size = 0;
4334 if( alg == PSA_ALG_ECB_NO_PADDING )
4335 operation->iv_required = 0;
4336 else
4337 operation->iv_required = 1;
4338
Steven Cooremana07b9972020-09-10 14:54:14 +02004339 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004340 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004341 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004342 slot,
4343 alg );
4344 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004345 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004346 slot,
4347 alg );
4348
Steven Cooremanef8575e2020-09-11 11:44:50 +02004349 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004350 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004351 /* Once the driver context is initialised, it needs to be freed using
4352 * psa_cipher_abort. Indicate this through setting alg. */
4353 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004354 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004355
Steven Cooremand3feccd2020-09-01 15:56:14 +02004356 if( status != PSA_ERROR_NOT_SUPPORTED ||
4357 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4358 goto exit;
4359
Steven Cooremana07b9972020-09-10 14:54:14 +02004360 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004361 * available for the given algorithm & key. */
4362 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004363
Steven Cooremana07b9972020-09-10 14:54:14 +02004364 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004365 * psa_cipher_abort. Indicate there is something to be freed through setting
4366 * alg, and indicate the operation is being done using mbedtls crypto through
4367 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004368 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004369 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004370
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004371 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004372 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004373 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004374 {
4375 status = PSA_ERROR_NOT_SUPPORTED;
4376 goto exit;
4377 }
mohammad1603503973b2018-03-12 15:59:30 +02004378
mohammad1603503973b2018-03-12 15:59:30 +02004379 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004380 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004381 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004382
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004383#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004384 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004385 {
4386 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004387 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004388 memcpy( keys, slot->data.key.data, 16 );
4389 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004390 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4391 keys,
4392 192, cipher_operation );
4393 }
4394 else
4395#endif
4396 {
4397 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004398 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004399 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004400 }
Moran Peker41deec42018-04-04 15:43:05 +03004401 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004402 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004403
mohammad16038481e742018-03-18 13:57:31 +02004404#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004405 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004406 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004407 case PSA_ALG_CBC_NO_PADDING:
4408 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4409 MBEDTLS_PADDING_NONE );
4410 break;
4411 case PSA_ALG_CBC_PKCS7:
4412 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4413 MBEDTLS_PADDING_PKCS7 );
4414 break;
4415 default:
4416 /* The algorithm doesn't involve padding. */
4417 ret = 0;
4418 break;
4419 }
4420 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004421 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004422#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4423
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004424 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004425 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004426 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4427 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004428 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004429 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004430 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004431#if defined(MBEDTLS_CHACHA20_C)
4432 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004433 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004434 operation->iv_size = 12;
4435#endif
mohammad1603503973b2018-03-12 15:59:30 +02004436
Steven Cooreman7df02922020-09-09 15:28:49 +02004437 status = PSA_SUCCESS;
4438
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004439exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004440 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004441 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004442 if( status == PSA_SUCCESS )
4443 {
4444 /* Update operation flags for both driver and software implementations */
4445 operation->key_set = 1;
4446 }
4447 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004448 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004449
Ronald Cron5c522922020-11-14 16:35:34 +01004450 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004451
Ronald Cron5c522922020-11-14 16:35:34 +01004452 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004453}
4454
Gilles Peskinefe119512018-07-08 21:39:34 +02004455psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004456 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004457 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004458{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004459 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004460}
4461
Gilles Peskinefe119512018-07-08 21:39:34 +02004462psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004463 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004464 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004465{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004466 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004467}
4468
Gilles Peskinefe119512018-07-08 21:39:34 +02004469psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004470 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004471 size_t iv_size,
4472 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004473{
itayzafrir534bd7c2018-08-02 13:56:32 +03004474 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004475 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004476 if( operation->iv_set || ! operation->iv_required )
4477 {
4478 return( PSA_ERROR_BAD_STATE );
4479 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004480
Steven Cooremanef8575e2020-09-11 11:44:50 +02004481 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004482 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004483 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004484 iv,
4485 iv_size,
4486 iv_length );
4487 goto exit;
4488 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004489
Moran Peker41deec42018-04-04 15:43:05 +03004490 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004491 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004492 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004493 goto exit;
4494 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004495 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4496 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004497 if( ret != 0 )
4498 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004499 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004500 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004501 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004502
mohammad16038481e742018-03-18 13:57:31 +02004503 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004504 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004505
Moran Peker395db872018-05-31 14:07:14 +03004506exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004507 if( status == PSA_SUCCESS )
4508 operation->iv_set = 1;
4509 else
Moran Peker395db872018-05-31 14:07:14 +03004510 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004511 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004512}
4513
Gilles Peskinefe119512018-07-08 21:39:34 +02004514psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004515 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004516 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004517{
itayzafrir534bd7c2018-08-02 13:56:32 +03004518 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004519 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004520 if( operation->iv_set || ! operation->iv_required )
4521 {
4522 return( PSA_ERROR_BAD_STATE );
4523 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004524
Steven Cooremanef8575e2020-09-11 11:44:50 +02004525 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004526 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004527 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004528 iv,
4529 iv_length );
4530 goto exit;
4531 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004532
Moran Pekera28258c2018-05-29 16:25:04 +03004533 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004534 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004535 status = PSA_ERROR_INVALID_ARGUMENT;
4536 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004537 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004538 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4539 status = mbedtls_to_psa_error( ret );
4540exit:
4541 if( status == PSA_SUCCESS )
4542 operation->iv_set = 1;
4543 else
mohammad1603503973b2018-03-12 15:59:30 +02004544 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004545 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004546}
4547
Steven Cooreman177deba2020-09-07 17:14:14 +02004548/* Process input for which the algorithm is set to ECB mode. This requires
4549 * manual processing, since the PSA API is defined as being able to process
4550 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4551 * underlying mbedtls_cipher_update only takes full blocks. */
4552static psa_status_t psa_cipher_update_ecb_internal(
4553 mbedtls_cipher_context_t *ctx,
4554 const uint8_t *input,
4555 size_t input_length,
4556 uint8_t *output,
4557 size_t output_size,
4558 size_t *output_length )
4559{
4560 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4561 size_t block_size = ctx->cipher_info->block_size;
4562 size_t internal_output_length = 0;
4563 *output_length = 0;
4564
4565 if( input_length == 0 )
4566 {
4567 status = PSA_SUCCESS;
4568 goto exit;
4569 }
4570
4571 if( ctx->unprocessed_len > 0 )
4572 {
4573 /* Fill up to block size, and run the block if there's a full one. */
4574 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4575
4576 if( input_length < bytes_to_copy )
4577 bytes_to_copy = input_length;
4578
4579 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4580 input, bytes_to_copy );
4581 input_length -= bytes_to_copy;
4582 input += bytes_to_copy;
4583 ctx->unprocessed_len += bytes_to_copy;
4584
4585 if( ctx->unprocessed_len == block_size )
4586 {
4587 status = mbedtls_to_psa_error(
4588 mbedtls_cipher_update( ctx,
4589 ctx->unprocessed_data,
4590 block_size,
4591 output, &internal_output_length ) );
4592
4593 if( status != PSA_SUCCESS )
4594 goto exit;
4595
4596 output += internal_output_length;
4597 output_size -= internal_output_length;
4598 *output_length += internal_output_length;
4599 ctx->unprocessed_len = 0;
4600 }
4601 }
4602
4603 while( input_length >= block_size )
4604 {
4605 /* Run all full blocks we have, one by one */
4606 status = mbedtls_to_psa_error(
4607 mbedtls_cipher_update( ctx, input,
4608 block_size,
4609 output, &internal_output_length ) );
4610
4611 if( status != PSA_SUCCESS )
4612 goto exit;
4613
4614 input_length -= block_size;
4615 input += block_size;
4616
4617 output += internal_output_length;
4618 output_size -= internal_output_length;
4619 *output_length += internal_output_length;
4620 }
4621
4622 if( input_length > 0 )
4623 {
4624 /* Save unprocessed bytes for later processing */
4625 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4626 input, input_length );
4627 ctx->unprocessed_len += input_length;
4628 }
4629
4630 status = PSA_SUCCESS;
4631
4632exit:
4633 return( status );
4634}
4635
Gilles Peskinee553c652018-06-04 16:22:46 +02004636psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4637 const uint8_t *input,
4638 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004639 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004640 size_t output_size,
4641 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004642{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004644 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004645 if( operation->alg == 0 )
4646 {
4647 return( PSA_ERROR_BAD_STATE );
4648 }
4649 if( operation->iv_required && ! operation->iv_set )
4650 {
4651 return( PSA_ERROR_BAD_STATE );
4652 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004653
Steven Cooremanef8575e2020-09-11 11:44:50 +02004654 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004655 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004656 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004657 input,
4658 input_length,
4659 output,
4660 output_size,
4661 output_length );
4662 goto exit;
4663 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004664
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004665 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004666 {
4667 /* Take the unprocessed partial block left over from previous
4668 * update calls, if any, plus the input to this call. Remove
4669 * the last partial block, if any. You get the data that will be
4670 * output in this call. */
4671 expected_output_size =
4672 ( operation->ctx.cipher.unprocessed_len + input_length )
4673 / operation->block_size * operation->block_size;
4674 }
4675 else
4676 {
4677 expected_output_size = input_length;
4678 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004679
Gilles Peskine89d789c2018-06-04 17:17:16 +02004680 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004681 {
4682 status = PSA_ERROR_BUFFER_TOO_SMALL;
4683 goto exit;
4684 }
mohammad160382759612018-03-12 18:16:40 +02004685
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004686 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4687 {
4688 /* mbedtls_cipher_update has an API inconsistency: it will only
4689 * process a single block at a time in ECB mode. Abstract away that
4690 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004691 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4692 input,
4693 input_length,
4694 output,
4695 output_size,
4696 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004697 }
4698 else
4699 {
4700 status = mbedtls_to_psa_error(
4701 mbedtls_cipher_update( &operation->ctx.cipher, input,
4702 input_length, output, output_length ) );
4703 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004704exit:
4705 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004706 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004707 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004708}
4709
Gilles Peskinee553c652018-06-04 16:22:46 +02004710psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4711 uint8_t *output,
4712 size_t output_size,
4713 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004714{
David Saadab4ecc272019-02-14 13:48:10 +02004715 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004716 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004717 if( operation->alg == 0 )
4718 {
4719 return( PSA_ERROR_BAD_STATE );
4720 }
4721 if( operation->iv_required && ! operation->iv_set )
4722 {
4723 return( PSA_ERROR_BAD_STATE );
4724 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004725
Steven Cooremanef8575e2020-09-11 11:44:50 +02004726 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004727 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004728 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004729 output,
4730 output_size,
4731 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004732 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004733 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004734
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004735 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004736 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004737 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004738 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004739 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004740 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004741 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004742 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004743 }
4744
Steven Cooremanef8575e2020-09-11 11:44:50 +02004745 status = mbedtls_to_psa_error(
4746 mbedtls_cipher_finish( &operation->ctx.cipher,
4747 temp_output_buffer,
4748 output_length ) );
4749 if( status != PSA_SUCCESS )
4750 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004751
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004752 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004753 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004754 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004755 memcpy( output, temp_output_buffer, *output_length );
4756 else
Janos Follath315b51c2018-07-09 16:04:51 +01004757 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004758
Steven Cooremanef8575e2020-09-11 11:44:50 +02004759exit:
4760 if( operation->mbedtls_in_use == 1 )
4761 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004762
Steven Cooremanef8575e2020-09-11 11:44:50 +02004763 if( status == PSA_SUCCESS )
4764 return( psa_cipher_abort( operation ) );
4765 else
4766 {
4767 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004768 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004769
Steven Cooremanef8575e2020-09-11 11:44:50 +02004770 return( status );
4771 }
mohammad1603503973b2018-03-12 15:59:30 +02004772}
4773
Gilles Peskinee553c652018-06-04 16:22:46 +02004774psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4775{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004776 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004777 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004778 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004779 * in use. It's ok to call abort on such an object, and there's
4780 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004781 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004782 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004783
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004784 /* Sanity check (shouldn't happen: operation->alg should
4785 * always have been initialized to a valid value). */
4786 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4787 return( PSA_ERROR_BAD_STATE );
4788
Steven Cooremanef8575e2020-09-11 11:44:50 +02004789 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004790 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004791 else
4792 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004793
Moran Peker41deec42018-04-04 15:43:05 +03004794 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004795 operation->key_set = 0;
4796 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004797 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004798 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004799 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004800 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004801
Moran Peker395db872018-05-31 14:07:14 +03004802 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004803}
4804
Gilles Peskinea0655c32018-04-30 17:06:50 +02004805
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004806
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004807
mohammad16035955c982018-04-26 00:53:03 +03004808/****************************************************************/
4809/* AEAD */
4810/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004811
Gilles Peskineedf9a652018-08-17 18:11:56 +02004812typedef struct
4813{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004814 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004815 const mbedtls_cipher_info_t *cipher_info;
4816 union
4817 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004818 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004819#if defined(MBEDTLS_CCM_C)
4820 mbedtls_ccm_context ccm;
4821#endif /* MBEDTLS_CCM_C */
4822#if defined(MBEDTLS_GCM_C)
4823 mbedtls_gcm_context gcm;
4824#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004825#if defined(MBEDTLS_CHACHAPOLY_C)
4826 mbedtls_chachapoly_context chachapoly;
4827#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004828 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004829 psa_algorithm_t core_alg;
4830 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004831 uint8_t tag_length;
4832} aead_operation_t;
4833
Ronald Cronf95a2b12020-10-22 15:24:49 +02004834#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4835
Gilles Peskine30a9e412019-01-14 18:36:12 +01004836static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004837{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004838 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004839 {
4840#if defined(MBEDTLS_CCM_C)
4841 case PSA_ALG_CCM:
4842 mbedtls_ccm_free( &operation->ctx.ccm );
4843 break;
4844#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004845#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004846 case PSA_ALG_GCM:
4847 mbedtls_gcm_free( &operation->ctx.gcm );
4848 break;
4849#endif /* MBEDTLS_GCM_C */
4850 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004851
Ronald Cron5c522922020-11-14 16:35:34 +01004852 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004853}
4854
4855static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004856 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004857 psa_key_usage_t usage,
4858 psa_algorithm_t alg )
4859{
4860 psa_status_t status;
4861 size_t key_bits;
4862 mbedtls_cipher_id_t cipher_id;
4863
Ronald Cron5c522922020-11-14 16:35:34 +01004864 status = psa_get_and_lock_transparent_key_slot_with_policy(
4865 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004866 if( status != PSA_SUCCESS )
4867 return( status );
4868
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004869 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004870
4871 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004872 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004873 &cipher_id );
4874 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004875 {
4876 status = PSA_ERROR_NOT_SUPPORTED;
4877 goto cleanup;
4878 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004879
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004880 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004881 {
4882#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004883 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4884 operation->core_alg = PSA_ALG_CCM;
4885 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004886 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4887 * The call to mbedtls_ccm_encrypt_and_tag or
4888 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004889 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004890 {
4891 status = PSA_ERROR_INVALID_ARGUMENT;
4892 goto cleanup;
4893 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004894 mbedtls_ccm_init( &operation->ctx.ccm );
4895 status = mbedtls_to_psa_error(
4896 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004897 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004898 (unsigned int) key_bits ) );
4899 if( status != 0 )
4900 goto cleanup;
4901 break;
4902#endif /* MBEDTLS_CCM_C */
4903
4904#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004905 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4906 operation->core_alg = PSA_ALG_GCM;
4907 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004908 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4909 * The call to mbedtls_gcm_crypt_and_tag or
4910 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004911 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004912 {
4913 status = PSA_ERROR_INVALID_ARGUMENT;
4914 goto cleanup;
4915 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004916 mbedtls_gcm_init( &operation->ctx.gcm );
4917 status = mbedtls_to_psa_error(
4918 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004919 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004920 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004921 if( status != 0 )
4922 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004923 break;
4924#endif /* MBEDTLS_GCM_C */
4925
Gilles Peskine26869f22019-05-06 15:25:00 +02004926#if defined(MBEDTLS_CHACHAPOLY_C)
4927 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4928 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4929 operation->full_tag_length = 16;
4930 /* We only support the default tag length. */
4931 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004932 {
4933 status = PSA_ERROR_NOT_SUPPORTED;
4934 goto cleanup;
4935 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004936 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4937 status = mbedtls_to_psa_error(
4938 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004939 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004940 if( status != 0 )
4941 goto cleanup;
4942 break;
4943#endif /* MBEDTLS_CHACHAPOLY_C */
4944
Gilles Peskineedf9a652018-08-17 18:11:56 +02004945 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004946 status = PSA_ERROR_NOT_SUPPORTED;
4947 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004948 }
4949
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004950 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4951 {
4952 status = PSA_ERROR_INVALID_ARGUMENT;
4953 goto cleanup;
4954 }
4955 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004956
Gilles Peskineedf9a652018-08-17 18:11:56 +02004957 return( PSA_SUCCESS );
4958
4959cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004960 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004961 return( status );
4962}
4963
Ronald Croncf56a0a2020-08-04 09:51:30 +02004964psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004965 psa_algorithm_t alg,
4966 const uint8_t *nonce,
4967 size_t nonce_length,
4968 const uint8_t *additional_data,
4969 size_t additional_data_length,
4970 const uint8_t *plaintext,
4971 size_t plaintext_length,
4972 uint8_t *ciphertext,
4973 size_t ciphertext_size,
4974 size_t *ciphertext_length )
4975{
mohammad16035955c982018-04-26 00:53:03 +03004976 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004977 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004978 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004979
mohammad1603f08a5502018-06-03 15:05:47 +03004980 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004981
Ronald Croncf56a0a2020-08-04 09:51:30 +02004982 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004983 if( status != PSA_SUCCESS )
4984 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004985
Gilles Peskineedf9a652018-08-17 18:11:56 +02004986 /* For all currently supported modes, the tag is at the end of the
4987 * ciphertext. */
4988 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4989 {
4990 status = PSA_ERROR_BUFFER_TOO_SMALL;
4991 goto exit;
4992 }
4993 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004994
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004995#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004996 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004997 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004998 status = mbedtls_to_psa_error(
4999 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
5000 MBEDTLS_GCM_ENCRYPT,
5001 plaintext_length,
5002 nonce, nonce_length,
5003 additional_data, additional_data_length,
5004 plaintext, ciphertext,
5005 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03005006 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005007 else
5008#endif /* MBEDTLS_GCM_C */
5009#if defined(MBEDTLS_CCM_C)
5010 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005011 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005012 status = mbedtls_to_psa_error(
5013 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
5014 plaintext_length,
5015 nonce, nonce_length,
5016 additional_data,
5017 additional_data_length,
5018 plaintext, ciphertext,
5019 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005020 }
mohammad16035c8845f2018-05-09 05:40:09 -07005021 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005022#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005023#if defined(MBEDTLS_CHACHAPOLY_C)
5024 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5025 {
5026 if( nonce_length != 12 || operation.tag_length != 16 )
5027 {
5028 status = PSA_ERROR_NOT_SUPPORTED;
5029 goto exit;
5030 }
5031 status = mbedtls_to_psa_error(
5032 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
5033 plaintext_length,
5034 nonce,
5035 additional_data,
5036 additional_data_length,
5037 plaintext,
5038 ciphertext,
5039 tag ) );
5040 }
5041 else
5042#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07005043 {
mohammad1603554faad2018-06-03 15:07:38 +03005044 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07005045 }
Gilles Peskine2d277862018-06-18 15:41:12 +02005046
Gilles Peskineedf9a652018-08-17 18:11:56 +02005047 if( status != PSA_SUCCESS && ciphertext_size != 0 )
5048 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02005049
Gilles Peskineedf9a652018-08-17 18:11:56 +02005050exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005051 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005052 if( status == PSA_SUCCESS )
5053 *ciphertext_length = plaintext_length + operation.tag_length;
5054 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005055}
5056
Gilles Peskineee652a32018-06-01 19:23:52 +02005057/* Locate the tag in a ciphertext buffer containing the encrypted data
5058 * followed by the tag. Return the length of the part preceding the tag in
5059 * *plaintext_length. This is the size of the plaintext in modes where
5060 * the encrypted data has the same size as the plaintext, such as
5061 * CCM and GCM. */
5062static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
5063 const uint8_t *ciphertext,
5064 size_t ciphertext_length,
5065 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02005066 const uint8_t **p_tag )
5067{
5068 size_t payload_length;
5069 if( tag_length > ciphertext_length )
5070 return( PSA_ERROR_INVALID_ARGUMENT );
5071 payload_length = ciphertext_length - tag_length;
5072 if( payload_length > plaintext_size )
5073 return( PSA_ERROR_BUFFER_TOO_SMALL );
5074 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02005075 return( PSA_SUCCESS );
5076}
5077
Ronald Croncf56a0a2020-08-04 09:51:30 +02005078psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03005079 psa_algorithm_t alg,
5080 const uint8_t *nonce,
5081 size_t nonce_length,
5082 const uint8_t *additional_data,
5083 size_t additional_data_length,
5084 const uint8_t *ciphertext,
5085 size_t ciphertext_length,
5086 uint8_t *plaintext,
5087 size_t plaintext_size,
5088 size_t *plaintext_length )
5089{
mohammad16035955c982018-04-26 00:53:03 +03005090 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005091 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02005092 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02005093
Gilles Peskineee652a32018-06-01 19:23:52 +02005094 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005095
Ronald Croncf56a0a2020-08-04 09:51:30 +02005096 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005097 if( status != PSA_SUCCESS )
5098 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005099
Gilles Peskinef7e7b012019-05-06 15:27:16 +02005100 status = psa_aead_unpadded_locate_tag( operation.tag_length,
5101 ciphertext, ciphertext_length,
5102 plaintext_size, &tag );
5103 if( status != PSA_SUCCESS )
5104 goto exit;
5105
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005106#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005107 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005108 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005109 status = mbedtls_to_psa_error(
5110 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5111 ciphertext_length - operation.tag_length,
5112 nonce, nonce_length,
5113 additional_data,
5114 additional_data_length,
5115 tag, operation.tag_length,
5116 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005117 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005118 else
5119#endif /* MBEDTLS_GCM_C */
5120#if defined(MBEDTLS_CCM_C)
5121 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005122 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005123 status = mbedtls_to_psa_error(
5124 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5125 ciphertext_length - operation.tag_length,
5126 nonce, nonce_length,
5127 additional_data,
5128 additional_data_length,
5129 ciphertext, plaintext,
5130 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005131 }
mohammad160339574652018-06-01 04:39:53 -07005132 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005133#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005134#if defined(MBEDTLS_CHACHAPOLY_C)
5135 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5136 {
5137 if( nonce_length != 12 || operation.tag_length != 16 )
5138 {
5139 status = PSA_ERROR_NOT_SUPPORTED;
5140 goto exit;
5141 }
5142 status = mbedtls_to_psa_error(
5143 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5144 ciphertext_length - operation.tag_length,
5145 nonce,
5146 additional_data,
5147 additional_data_length,
5148 tag,
5149 ciphertext,
5150 plaintext ) );
5151 }
5152 else
5153#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005154 {
mohammad1603554faad2018-06-03 15:07:38 +03005155 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005156 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005157
Gilles Peskineedf9a652018-08-17 18:11:56 +02005158 if( status != PSA_SUCCESS && plaintext_size != 0 )
5159 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005160
Gilles Peskineedf9a652018-08-17 18:11:56 +02005161exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005162 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005163 if( status == PSA_SUCCESS )
5164 *plaintext_length = ciphertext_length - operation.tag_length;
5165 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005166}
5167
Gilles Peskinea0655c32018-04-30 17:06:50 +02005168
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005169
Gilles Peskine20035e32018-02-03 22:44:14 +01005170/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005171/* Generators */
5172/****************************************************************/
5173
John Durkop07cc04a2020-11-16 22:08:34 -08005174#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
5175 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5176 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5177#define AT_LEAST_ONE_BUILTIN_KDF
5178#endif
5179
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005180#define HKDF_STATE_INIT 0 /* no input yet */
5181#define HKDF_STATE_STARTED 1 /* got salt */
5182#define HKDF_STATE_KEYED 2 /* got key */
5183#define HKDF_STATE_OUTPUT 3 /* output started */
5184
Gilles Peskinecbe66502019-05-16 16:59:18 +02005185static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005186 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005187{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005188 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5189 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005190 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005191 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005192}
5193
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005194psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005195{
5196 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005197 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005198 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005199 {
5200 /* The object has (apparently) been initialized but it is not
5201 * in use. It's ok to call abort on such an object, and there's
5202 * nothing to do. */
5203 }
5204 else
John Durkopd0321952020-10-29 21:37:36 -07005205#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005206 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005207 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005208 mbedtls_free( operation->ctx.hkdf.info );
5209 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005210 }
John Durkop07cc04a2020-11-16 22:08:34 -08005211 else
5212#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5213#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5214 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5215 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005216 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005217 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005218 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005219 if( operation->ctx.tls12_prf.seed != NULL )
5220 {
5221 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5222 operation->ctx.tls12_prf.seed_length );
5223 mbedtls_free( operation->ctx.tls12_prf.seed );
5224 }
5225
5226 if( operation->ctx.tls12_prf.label != NULL )
5227 {
5228 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5229 operation->ctx.tls12_prf.label_length );
5230 mbedtls_free( operation->ctx.tls12_prf.label );
5231 }
5232
5233 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5234
5235 /* We leave the fields Ai and output_block to be erased safely by the
5236 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005237 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005238 else
John Durkop07cc04a2020-11-16 22:08:34 -08005239#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5240 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005241 {
5242 status = PSA_ERROR_BAD_STATE;
5243 }
Janos Follath083036a2019-06-11 10:22:26 +01005244 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005245 return( status );
5246}
5247
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005248psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005249 size_t *capacity)
5250{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005251 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005252 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005253 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005254 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005255 }
5256
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005257 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005258 return( PSA_SUCCESS );
5259}
5260
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005261psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005262 size_t capacity )
5263{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005265 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005266 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005267 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005268 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005269 return( PSA_SUCCESS );
5270}
5271
John Durkopd0321952020-10-29 21:37:36 -07005272#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005273/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005274 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005275static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005276 psa_algorithm_t hash_alg,
5277 uint8_t *output,
5278 size_t output_length )
5279{
5280 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5281 psa_status_t status;
5282
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005283 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5284 return( PSA_ERROR_BAD_STATE );
5285 hkdf->state = HKDF_STATE_OUTPUT;
5286
Gilles Peskinebef7f142018-07-12 17:22:21 +02005287 while( output_length != 0 )
5288 {
5289 /* Copy what remains of the current block */
5290 uint8_t n = hash_length - hkdf->offset_in_block;
5291 if( n > output_length )
5292 n = (uint8_t) output_length;
5293 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5294 output += n;
5295 output_length -= n;
5296 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005297 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005298 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005299 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005300 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005301 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005302 * object was corrupted or if this function is called directly
5303 * inside the library. */
5304 if( hkdf->block_number == 0xff )
5305 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005306
5307 /* We need a new block */
5308 ++hkdf->block_number;
5309 hkdf->offset_in_block = 0;
5310 status = psa_hmac_setup_internal( &hkdf->hmac,
5311 hkdf->prk, hash_length,
5312 hash_alg );
5313 if( status != PSA_SUCCESS )
5314 return( status );
5315 if( hkdf->block_number != 1 )
5316 {
5317 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5318 hkdf->output_block,
5319 hash_length );
5320 if( status != PSA_SUCCESS )
5321 return( status );
5322 }
5323 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5324 hkdf->info,
5325 hkdf->info_length );
5326 if( status != PSA_SUCCESS )
5327 return( status );
5328 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5329 &hkdf->block_number, 1 );
5330 if( status != PSA_SUCCESS )
5331 return( status );
5332 status = psa_hmac_finish_internal( &hkdf->hmac,
5333 hkdf->output_block,
5334 sizeof( hkdf->output_block ) );
5335 if( status != PSA_SUCCESS )
5336 return( status );
5337 }
5338
5339 return( PSA_SUCCESS );
5340}
John Durkop07cc04a2020-11-16 22:08:34 -08005341#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005342
John Durkop07cc04a2020-11-16 22:08:34 -08005343#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5344 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005345static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5346 psa_tls12_prf_key_derivation_t *tls12_prf,
5347 psa_algorithm_t alg )
5348{
5349 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5350 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005351 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5352 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005353
Janos Follath7742fee2019-06-17 12:58:10 +01005354 /* We can't be wanting more output after block 0xff, otherwise
5355 * the capacity check in psa_key_derivation_output_bytes() would have
5356 * prevented this call. It could happen only if the operation
5357 * object was corrupted or if this function is called directly
5358 * inside the library. */
5359 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005360 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005361
5362 /* We need a new block */
5363 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005364 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005365
5366 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5367 *
5368 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5369 *
5370 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5371 * HMAC_hash(secret, A(2) + seed) +
5372 * HMAC_hash(secret, A(3) + seed) + ...
5373 *
5374 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005375 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005376 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005377 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005378 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005379 * is currently extracted as `output_block` and where i is
5380 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005381 */
5382
Janos Follathea29bfb2019-06-19 12:21:20 +01005383 /* Save the hash context before using it, to preserve the hash state with
5384 * only the inner padding in it. We need this, because inner padding depends
5385 * on the key (secret in the RFC's terminology). */
5386 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5387 if( status != PSA_SUCCESS )
5388 goto cleanup;
5389
5390 /* Calculate A(i) where i = tls12_prf->block_number. */
5391 if( tls12_prf->block_number == 1 )
5392 {
5393 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5394 * the variable seed and in this instance means it in the context of the
5395 * P_hash function, where seed = label + seed.) */
5396 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5397 tls12_prf->label, tls12_prf->label_length );
5398 if( status != PSA_SUCCESS )
5399 goto cleanup;
5400 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5401 tls12_prf->seed, tls12_prf->seed_length );
5402 if( status != PSA_SUCCESS )
5403 goto cleanup;
5404 }
5405 else
5406 {
5407 /* A(i) = HMAC_hash(secret, A(i-1)) */
5408 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5409 tls12_prf->Ai, hash_length );
5410 if( status != PSA_SUCCESS )
5411 goto cleanup;
5412 }
5413
5414 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5415 tls12_prf->Ai, hash_length );
5416 if( status != PSA_SUCCESS )
5417 goto cleanup;
5418 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5419 if( status != PSA_SUCCESS )
5420 goto cleanup;
5421
5422 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5423 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5424 tls12_prf->Ai, hash_length );
5425 if( status != PSA_SUCCESS )
5426 goto cleanup;
5427 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5428 tls12_prf->label, tls12_prf->label_length );
5429 if( status != PSA_SUCCESS )
5430 goto cleanup;
5431 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5432 tls12_prf->seed, tls12_prf->seed_length );
5433 if( status != PSA_SUCCESS )
5434 goto cleanup;
5435 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5436 tls12_prf->output_block, hash_length );
5437 if( status != PSA_SUCCESS )
5438 goto cleanup;
5439 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5440 if( status != PSA_SUCCESS )
5441 goto cleanup;
5442
Janos Follath7742fee2019-06-17 12:58:10 +01005443
5444cleanup:
5445
Janos Follathea29bfb2019-06-19 12:21:20 +01005446 cleanup_status = psa_hash_abort( &backup );
5447 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5448 status = cleanup_status;
5449
5450 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005451}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005452
Janos Follath844eb0e2019-06-19 12:10:49 +01005453static psa_status_t psa_key_derivation_tls12_prf_read(
5454 psa_tls12_prf_key_derivation_t *tls12_prf,
5455 psa_algorithm_t alg,
5456 uint8_t *output,
5457 size_t output_length )
5458{
5459 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5460 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5461 psa_status_t status;
5462 uint8_t offset, length;
5463
5464 while( output_length != 0 )
5465 {
5466 /* Check if we have fully processed the current block. */
5467 if( tls12_prf->left_in_block == 0 )
5468 {
5469 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5470 alg );
5471 if( status != PSA_SUCCESS )
5472 return( status );
5473
5474 continue;
5475 }
5476
5477 if( tls12_prf->left_in_block > output_length )
5478 length = (uint8_t) output_length;
5479 else
5480 length = tls12_prf->left_in_block;
5481
5482 offset = hash_length - tls12_prf->left_in_block;
5483 memcpy( output, tls12_prf->output_block + offset, length );
5484 output += length;
5485 output_length -= length;
5486 tls12_prf->left_in_block -= length;
5487 }
5488
5489 return( PSA_SUCCESS );
5490}
John Durkop07cc04a2020-11-16 22:08:34 -08005491#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5492 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005493
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005494psa_status_t psa_key_derivation_output_bytes(
5495 psa_key_derivation_operation_t *operation,
5496 uint8_t *output,
5497 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005498{
5499 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005500 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005501
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005502 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005503 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005504 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005505 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005506 }
5507
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005508 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005509 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005510 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005511 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005512 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005513 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005514 goto exit;
5515 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005516 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005517 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005518 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005519 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005520 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5521 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005522 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005523 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005524 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005525 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005526 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005527
John Durkopd0321952020-10-29 21:37:36 -07005528#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005529 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005530 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005531 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005532 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005533 output, output_length );
5534 }
Janos Follathadbec812019-06-14 11:05:39 +01005535 else
John Durkop07cc04a2020-11-16 22:08:34 -08005536#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5537#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5538 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005539 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005540 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005541 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005542 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005543 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005544 output_length );
5545 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005546 else
John Durkop07cc04a2020-11-16 22:08:34 -08005547#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5548 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005549 {
5550 return( PSA_ERROR_BAD_STATE );
5551 }
5552
5553exit:
5554 if( status != PSA_SUCCESS )
5555 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005556 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005557 * This allows us to differentiate between exhausted operations and
5558 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5559 * operations. */
5560 psa_algorithm_t alg = operation->alg;
5561 psa_key_derivation_abort( operation );
5562 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005563 memset( output, '!', output_length );
5564 }
5565 return( status );
5566}
5567
Gilles Peskine08542d82018-07-19 17:05:42 +02005568#if defined(MBEDTLS_DES_C)
5569static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5570{
5571 if( data_size >= 8 )
5572 mbedtls_des_key_set_parity( data );
5573 if( data_size >= 16 )
5574 mbedtls_des_key_set_parity( data + 8 );
5575 if( data_size >= 24 )
5576 mbedtls_des_key_set_parity( data + 16 );
5577}
5578#endif /* MBEDTLS_DES_C */
5579
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005580static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005581 psa_key_slot_t *slot,
5582 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005583 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005584{
5585 uint8_t *data = NULL;
5586 size_t bytes = PSA_BITS_TO_BYTES( bits );
5587 psa_status_t status;
5588
Gilles Peskine8e338702019-07-30 20:06:31 +02005589 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005590 return( PSA_ERROR_INVALID_ARGUMENT );
5591 if( bits % 8 != 0 )
5592 return( PSA_ERROR_INVALID_ARGUMENT );
5593 data = mbedtls_calloc( 1, bytes );
5594 if( data == NULL )
5595 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5596
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005597 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005598 if( status != PSA_SUCCESS )
5599 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005600#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005601 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005602 psa_des_set_key_parity( data, bytes );
5603#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005604 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005605
5606exit:
5607 mbedtls_free( data );
5608 return( status );
5609}
5610
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005611psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005612 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005613 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005614{
5615 psa_status_t status;
5616 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005617 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005618
Ronald Cron81709fc2020-11-14 12:10:32 +01005619 *key = MBEDTLS_SVC_KEY_ID_INIT;
5620
Gilles Peskine0f84d622019-09-12 19:03:13 +02005621 /* Reject any attempt to create a zero-length key so that we don't
5622 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5623 if( psa_get_key_bits( attributes ) == 0 )
5624 return( PSA_ERROR_INVALID_ARGUMENT );
5625
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005626 if( ! operation->can_output_key )
5627 return( PSA_ERROR_NOT_PERMITTED );
5628
Ronald Cron81709fc2020-11-14 12:10:32 +01005629 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5630 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005631#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5632 if( driver != NULL )
5633 {
5634 /* Deriving a key in a secure element is not implemented yet. */
5635 status = PSA_ERROR_NOT_SUPPORTED;
5636 }
5637#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005638 if( status == PSA_SUCCESS )
5639 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005640 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005641 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005642 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005643 }
5644 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005645 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005646 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005647 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005648
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005649 return( status );
5650}
5651
Gilles Peskineeab56e42018-07-12 17:12:33 +02005652
5653
5654/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005655/* Key derivation */
5656/****************************************************************/
5657
John Durkop07cc04a2020-11-16 22:08:34 -08005658#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005659static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005660 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005661 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005662{
John Durkop07cc04a2020-11-16 22:08:34 -08005663 int is_kdf_alg_supported;
5664
Janos Follath5fe19732019-06-20 15:09:30 +01005665 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5666 * initialisers for this union leave some bytes unspecified.) */
5667 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5668
Gilles Peskine969c5d62019-01-16 15:53:06 +01005669 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005670#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005671 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5672 is_kdf_alg_supported = 1;
5673 else
5674#endif
5675#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5676 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5677 is_kdf_alg_supported = 1;
5678 else
5679#endif
5680#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5681 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5682 is_kdf_alg_supported = 1;
5683 else
5684#endif
5685 is_kdf_alg_supported = 0;
5686
5687 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005688 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005689 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005690 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5691 if( hash_size == 0 )
5692 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005693 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5694 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005695 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005696 {
5697 return( PSA_ERROR_NOT_SUPPORTED );
5698 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005699 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005700 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005701 }
John Durkop07cc04a2020-11-16 22:08:34 -08005702
5703 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005704}
John Durkop07cc04a2020-11-16 22:08:34 -08005705#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005706
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005707psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005708 psa_algorithm_t alg )
5709{
5710 psa_status_t status;
5711
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005712 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005713 return( PSA_ERROR_BAD_STATE );
5714
Gilles Peskine6843c292019-01-18 16:44:49 +01005715 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5716 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005717#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005718 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005719 {
5720 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005721 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005722 }
5723 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5724 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005725 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005726 }
John Durkop07cc04a2020-11-16 22:08:34 -08005727#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005728 else
5729 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005730
5731 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005732 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005733 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005734}
5735
John Durkopd0321952020-10-29 21:37:36 -07005736#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005737static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005738 psa_algorithm_t hash_alg,
5739 psa_key_derivation_step_t step,
5740 const uint8_t *data,
5741 size_t data_length )
5742{
5743 psa_status_t status;
5744 switch( step )
5745 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005746 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005747 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005748 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005749 status = psa_hmac_setup_internal( &hkdf->hmac,
5750 data, data_length,
5751 hash_alg );
5752 if( status != PSA_SUCCESS )
5753 return( status );
5754 hkdf->state = HKDF_STATE_STARTED;
5755 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005756 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005757 /* If no salt was provided, use an empty salt. */
5758 if( hkdf->state == HKDF_STATE_INIT )
5759 {
5760 status = psa_hmac_setup_internal( &hkdf->hmac,
5761 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005762 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005763 if( status != PSA_SUCCESS )
5764 return( status );
5765 hkdf->state = HKDF_STATE_STARTED;
5766 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005767 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005768 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005769 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5770 data, data_length );
5771 if( status != PSA_SUCCESS )
5772 return( status );
5773 status = psa_hmac_finish_internal( &hkdf->hmac,
5774 hkdf->prk,
5775 sizeof( hkdf->prk ) );
5776 if( status != PSA_SUCCESS )
5777 return( status );
5778 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5779 hkdf->block_number = 0;
5780 hkdf->state = HKDF_STATE_KEYED;
5781 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005782 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005783 if( hkdf->state == HKDF_STATE_OUTPUT )
5784 return( PSA_ERROR_BAD_STATE );
5785 if( hkdf->info_set )
5786 return( PSA_ERROR_BAD_STATE );
5787 hkdf->info_length = data_length;
5788 if( data_length != 0 )
5789 {
5790 hkdf->info = mbedtls_calloc( 1, data_length );
5791 if( hkdf->info == NULL )
5792 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5793 memcpy( hkdf->info, data, data_length );
5794 }
5795 hkdf->info_set = 1;
5796 return( PSA_SUCCESS );
5797 default:
5798 return( PSA_ERROR_INVALID_ARGUMENT );
5799 }
5800}
John Durkop07cc04a2020-11-16 22:08:34 -08005801#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005802
John Durkop07cc04a2020-11-16 22:08:34 -08005803#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5804 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005805static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5806 const uint8_t *data,
5807 size_t data_length )
5808{
5809 if( prf->state != TLS12_PRF_STATE_INIT )
5810 return( PSA_ERROR_BAD_STATE );
5811
Janos Follathd6dce9f2019-07-04 09:11:38 +01005812 if( data_length != 0 )
5813 {
5814 prf->seed = mbedtls_calloc( 1, data_length );
5815 if( prf->seed == NULL )
5816 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005817
Janos Follathd6dce9f2019-07-04 09:11:38 +01005818 memcpy( prf->seed, data, data_length );
5819 prf->seed_length = data_length;
5820 }
Janos Follathf08e2652019-06-13 09:05:41 +01005821
5822 prf->state = TLS12_PRF_STATE_SEED_SET;
5823
5824 return( PSA_SUCCESS );
5825}
5826
Janos Follath81550542019-06-13 14:26:34 +01005827static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5828 psa_algorithm_t hash_alg,
5829 const uint8_t *data,
5830 size_t data_length )
5831{
5832 psa_status_t status;
5833 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5834 return( PSA_ERROR_BAD_STATE );
5835
5836 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5837 if( status != PSA_SUCCESS )
5838 return( status );
5839
5840 prf->state = TLS12_PRF_STATE_KEY_SET;
5841
5842 return( PSA_SUCCESS );
5843}
5844
Janos Follath63028dd2019-06-13 09:15:47 +01005845static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5846 const uint8_t *data,
5847 size_t data_length )
5848{
5849 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5850 return( PSA_ERROR_BAD_STATE );
5851
Janos Follathd6dce9f2019-07-04 09:11:38 +01005852 if( data_length != 0 )
5853 {
5854 prf->label = mbedtls_calloc( 1, data_length );
5855 if( prf->label == NULL )
5856 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005857
Janos Follathd6dce9f2019-07-04 09:11:38 +01005858 memcpy( prf->label, data, data_length );
5859 prf->label_length = data_length;
5860 }
Janos Follath63028dd2019-06-13 09:15:47 +01005861
5862 prf->state = TLS12_PRF_STATE_LABEL_SET;
5863
5864 return( PSA_SUCCESS );
5865}
5866
Janos Follathb03233e2019-06-11 15:30:30 +01005867static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5868 psa_algorithm_t hash_alg,
5869 psa_key_derivation_step_t step,
5870 const uint8_t *data,
5871 size_t data_length )
5872{
Janos Follathb03233e2019-06-11 15:30:30 +01005873 switch( step )
5874 {
Janos Follathf08e2652019-06-13 09:05:41 +01005875 case PSA_KEY_DERIVATION_INPUT_SEED:
5876 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005877 case PSA_KEY_DERIVATION_INPUT_SECRET:
5878 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005879 case PSA_KEY_DERIVATION_INPUT_LABEL:
5880 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005881 default:
5882 return( PSA_ERROR_INVALID_ARGUMENT );
5883 }
5884}
John Durkop07cc04a2020-11-16 22:08:34 -08005885#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5886 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5887
5888#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5889static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5890 psa_tls12_prf_key_derivation_t *prf,
5891 psa_algorithm_t hash_alg,
5892 const uint8_t *data,
5893 size_t data_length )
5894{
5895 psa_status_t status;
5896 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5897 uint8_t *cur = pms;
5898
5899 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5900 return( PSA_ERROR_INVALID_ARGUMENT );
5901
5902 /* Quoting RFC 4279, Section 2:
5903 *
5904 * The premaster secret is formed as follows: if the PSK is N octets
5905 * long, concatenate a uint16 with the value N, N zero octets, a second
5906 * uint16 with the value N, and the PSK itself.
5907 */
5908
5909 *cur++ = ( data_length >> 8 ) & 0xff;
5910 *cur++ = ( data_length >> 0 ) & 0xff;
5911 memset( cur, 0, data_length );
5912 cur += data_length;
5913 *cur++ = pms[0];
5914 *cur++ = pms[1];
5915 memcpy( cur, data, data_length );
5916 cur += data_length;
5917
5918 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5919
5920 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5921 return( status );
5922}
Janos Follath6660f0e2019-06-17 08:44:03 +01005923
5924static psa_status_t psa_tls12_prf_psk_to_ms_input(
5925 psa_tls12_prf_key_derivation_t *prf,
5926 psa_algorithm_t hash_alg,
5927 psa_key_derivation_step_t step,
5928 const uint8_t *data,
5929 size_t data_length )
5930{
5931 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005932 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005933 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5934 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005935 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005936
5937 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5938}
John Durkop07cc04a2020-11-16 22:08:34 -08005939#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005940
Gilles Peskineb8965192019-09-24 16:21:10 +02005941/** Check whether the given key type is acceptable for the given
5942 * input step of a key derivation.
5943 *
5944 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5945 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5946 * Both secret and non-secret inputs can alternatively have the type
5947 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5948 * that the input was passed as a buffer rather than via a key object.
5949 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005950static int psa_key_derivation_check_input_type(
5951 psa_key_derivation_step_t step,
5952 psa_key_type_t key_type )
5953{
5954 switch( step )
5955 {
5956 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005957 if( key_type == PSA_KEY_TYPE_DERIVE )
5958 return( PSA_SUCCESS );
5959 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005960 return( PSA_SUCCESS );
5961 break;
5962 case PSA_KEY_DERIVATION_INPUT_LABEL:
5963 case PSA_KEY_DERIVATION_INPUT_SALT:
5964 case PSA_KEY_DERIVATION_INPUT_INFO:
5965 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005966 if( key_type == PSA_KEY_TYPE_RAW_DATA )
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 }
5972 return( PSA_ERROR_INVALID_ARGUMENT );
5973}
5974
Janos Follathb80a94e2019-06-12 15:54:46 +01005975static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005976 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005977 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005978 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005979 const uint8_t *data,
5980 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005981{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005982 psa_status_t status;
5983 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5984
5985 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005986 if( status != PSA_SUCCESS )
5987 goto exit;
5988
John Durkopd0321952020-10-29 21:37:36 -07005989#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005990 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005991 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005992 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005993 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005994 step, data, data_length );
5995 }
John Durkop07cc04a2020-11-16 22:08:34 -08005996 else
5997#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5998#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5999 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006000 {
Janos Follathb03233e2019-06-11 15:30:30 +01006001 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
6002 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
6003 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01006004 }
John Durkop07cc04a2020-11-16 22:08:34 -08006005 else
6006#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6007#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6008 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01006009 {
6010 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
6011 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
6012 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006013 }
6014 else
John Durkop07cc04a2020-11-16 22:08:34 -08006015#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006016 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006017 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006018 return( PSA_ERROR_BAD_STATE );
6019 }
6020
Gilles Peskine224b0d62019-09-23 18:13:17 +02006021exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006022 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006023 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006024 return( status );
6025}
6026
Janos Follath51f4a0f2019-06-14 11:35:55 +01006027psa_status_t psa_key_derivation_input_bytes(
6028 psa_key_derivation_operation_t *operation,
6029 psa_key_derivation_step_t step,
6030 const uint8_t *data,
6031 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006032{
Gilles Peskineb8965192019-09-24 16:21:10 +02006033 return( psa_key_derivation_input_internal( operation, step,
6034 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01006035 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006036}
6037
Janos Follath51f4a0f2019-06-14 11:35:55 +01006038psa_status_t psa_key_derivation_input_key(
6039 psa_key_derivation_operation_t *operation,
6040 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006041 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006042{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006043 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006044 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006045 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006046
Ronald Cron5c522922020-11-14 16:35:34 +01006047 status = psa_get_and_lock_transparent_key_slot_with_policy(
6048 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006049 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02006050 {
6051 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006052 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02006053 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006054
6055 /* Passing a key object as a SECRET input unlocks the permission
6056 * to output to a key object. */
6057 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6058 operation->can_output_key = 1;
6059
Ronald Cronf95a2b12020-10-22 15:24:49 +02006060 status = psa_key_derivation_input_internal( operation,
6061 step, slot->attr.type,
6062 slot->data.key.data,
6063 slot->data.key.bytes );
6064
Ronald Cron5c522922020-11-14 16:35:34 +01006065 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006066
Ronald Cron5c522922020-11-14 16:35:34 +01006067 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006068}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006069
6070
6071
6072/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006073/* Key agreement */
6074/****************************************************************/
6075
John Durkop6ba40d12020-11-10 08:50:04 -08006076#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006077static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
6078 size_t peer_key_length,
6079 const mbedtls_ecp_keypair *our_key,
6080 uint8_t *shared_secret,
6081 size_t shared_secret_size,
6082 size_t *shared_secret_length )
6083{
Steven Cooremand4867872020-08-05 16:31:39 +02006084 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006085 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00006086 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006087 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01006088 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006089 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006090
Steven Cooreman4fed4552020-08-03 14:46:03 +02006091 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
6092 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02006093 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02006094 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00006095 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006096 goto exit;
6097
Jaeden Amero97271b32019-01-10 19:38:51 +00006098 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02006099 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00006100 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006101 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00006102 status = mbedtls_to_psa_error(
6103 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
6104 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(
6108 mbedtls_ecdh_calc_secret( &ecdh,
6109 shared_secret_length,
6110 shared_secret, shared_secret_size,
6111 mbedtls_ctr_drbg_random,
6112 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006113 if( status != PSA_SUCCESS )
6114 goto exit;
6115 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
6116 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006117
6118exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01006119 if( status != PSA_SUCCESS )
6120 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006121 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02006122 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02006123 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02006124
Jaeden Amero97271b32019-01-10 19:38:51 +00006125 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006126}
John Durkop6ba40d12020-11-10 08:50:04 -08006127#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006128
Gilles Peskine01d718c2018-09-18 12:01:02 +02006129#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6130
Gilles Peskine0216fe12019-04-11 21:23:21 +02006131static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6132 psa_key_slot_t *private_key,
6133 const uint8_t *peer_key,
6134 size_t peer_key_length,
6135 uint8_t *shared_secret,
6136 size_t shared_secret_size,
6137 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006138{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006139 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006140 {
John Durkop6ba40d12020-11-10 08:50:04 -08006141#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006142 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006143 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006144 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006145 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02006146 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02006147 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02006148 private_key->data.key.data,
6149 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02006150 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006151 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006152 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006153 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006154 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006155 shared_secret, shared_secret_size,
6156 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006157 mbedtls_ecp_keypair_free( ecp );
6158 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006159 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08006160#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006161 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006162 (void) private_key;
6163 (void) peer_key;
6164 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006165 (void) shared_secret;
6166 (void) shared_secret_size;
6167 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006168 return( PSA_ERROR_NOT_SUPPORTED );
6169 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006170}
6171
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006172/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006173 * to potentially free embedded data structures and wipe confidential data.
6174 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006175static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006176 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006177 psa_key_slot_t *private_key,
6178 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006179 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006180{
6181 psa_status_t status;
6182 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6183 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006184 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006185
6186 /* Step 1: run the secret agreement algorithm to generate the shared
6187 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006188 status = psa_key_agreement_raw_internal( ka_alg,
6189 private_key,
6190 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006191 shared_secret,
6192 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006193 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006194 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006195 goto exit;
6196
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006197 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006198 * the shared secret. A shared secret is permitted wherever a key
6199 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006200 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006201 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006202 shared_secret,
6203 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006204exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006205 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006206 return( status );
6207}
6208
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006209psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006210 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006211 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006212 const uint8_t *peer_key,
6213 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006214{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006216 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006217 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006218
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006219 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006220 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01006221 status = psa_get_and_lock_transparent_key_slot_with_policy(
6222 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006223 if( status != PSA_SUCCESS )
6224 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006225 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006226 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006227 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006228 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006229 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006230 else
6231 {
6232 /* If a private key has been added as SECRET, we allow the derived
6233 * key material to be used as a key in PSA Crypto. */
6234 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6235 operation->can_output_key = 1;
6236 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006237
Ronald Cron5c522922020-11-14 16:35:34 +01006238 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006239
Ronald Cron5c522922020-11-14 16:35:34 +01006240 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006241}
6242
Gilles Peskinebe697d82019-05-16 18:00:41 +02006243psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006244 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006245 const uint8_t *peer_key,
6246 size_t peer_key_length,
6247 uint8_t *output,
6248 size_t output_size,
6249 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006250{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006251 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006252 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006253 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006254
6255 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6256 {
6257 status = PSA_ERROR_INVALID_ARGUMENT;
6258 goto exit;
6259 }
Ronald Cron5c522922020-11-14 16:35:34 +01006260 status = psa_get_and_lock_transparent_key_slot_with_policy(
6261 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006262 if( status != PSA_SUCCESS )
6263 goto exit;
6264
6265 status = psa_key_agreement_raw_internal( alg, slot,
6266 peer_key, peer_key_length,
6267 output, output_size,
6268 output_length );
6269
6270exit:
6271 if( status != PSA_SUCCESS )
6272 {
6273 /* If an error happens and is not handled properly, the output
6274 * may be used as a key to protect sensitive data. Arrange for such
6275 * a key to be random, which is likely to result in decryption or
6276 * verification errors. This is better than filling the buffer with
6277 * some constant data such as zeros, which would result in the data
6278 * being protected with a reproducible, easily knowable key.
6279 */
6280 psa_generate_random( output, output_size );
6281 *output_length = output_size;
6282 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006283
Ronald Cron5c522922020-11-14 16:35:34 +01006284 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006285
Ronald Cron5c522922020-11-14 16:35:34 +01006286 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006287}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006288
6289
6290/****************************************************************/
6291/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006292/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006293
Gilles Peskine4c317f42018-07-12 01:24:09 +02006294psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006295 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006296{
Janos Follath24eed8d2019-11-22 13:21:35 +00006297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006298 GUARD_MODULE_INITIALIZED;
6299
Gilles Peskinef181eca2019-08-07 13:49:00 +02006300 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6301 {
6302 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6303 output,
6304 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6305 if( ret != 0 )
6306 return( mbedtls_to_psa_error( ret ) );
6307 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6308 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6309 }
6310
Gilles Peskinee59236f2018-01-27 23:32:46 +01006311 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6312 return( mbedtls_to_psa_error( ret ) );
6313}
6314
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006315#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6316#include "mbedtls/entropy_poll.h"
6317
Gilles Peskine7228da22019-07-15 11:06:15 +02006318psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006319 size_t seed_size )
6320{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006321 if( global_data.initialized )
6322 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006323
6324 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6325 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6326 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6327 return( PSA_ERROR_INVALID_ARGUMENT );
6328
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006329 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006330}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006331#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006332
John Durkop07cc04a2020-11-16 22:08:34 -08006333#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006334static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6335 size_t domain_parameters_size,
6336 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006337{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006338 size_t i;
6339 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006340
Gilles Peskinee56e8782019-04-26 17:34:02 +02006341 if( domain_parameters_size == 0 )
6342 {
6343 *exponent = 65537;
6344 return( PSA_SUCCESS );
6345 }
6346
6347 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6348 * support values that fit in a 32-bit integer, which is larger than
6349 * int on just about every platform anyway. */
6350 if( domain_parameters_size > sizeof( acc ) )
6351 return( PSA_ERROR_NOT_SUPPORTED );
6352 for( i = 0; i < domain_parameters_size; i++ )
6353 acc = ( acc << 8 ) | domain_parameters[i];
6354 if( acc > INT_MAX )
6355 return( PSA_ERROR_NOT_SUPPORTED );
6356 *exponent = acc;
6357 return( PSA_SUCCESS );
6358}
John Durkop07cc04a2020-11-16 22:08:34 -08006359#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006360
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006361static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006362 psa_key_slot_t *slot, size_t bits,
6363 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006364{
Gilles Peskine8e338702019-07-30 20:06:31 +02006365 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006366
Gilles Peskinee56e8782019-04-26 17:34:02 +02006367 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006368 return( PSA_ERROR_INVALID_ARGUMENT );
6369
Gilles Peskinee59236f2018-01-27 23:32:46 +01006370 if( key_type_is_raw_bytes( type ) )
6371 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006372 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006373
6374 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006375 if( status != PSA_SUCCESS )
6376 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006377
6378 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006379 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6380 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006381 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006382
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006383 status = psa_generate_random( slot->data.key.data,
6384 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006385 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006386 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006387
6388 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006389#if defined(MBEDTLS_DES_C)
6390 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006391 psa_des_set_key_parity( slot->data.key.data,
6392 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006393#endif /* MBEDTLS_DES_C */
6394 }
6395 else
6396
John Durkop07cc04a2020-11-16 22:08:34 -08006397#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006398 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006399 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006400 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006401 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006402 int exponent;
6403 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006404 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6405 return( PSA_ERROR_NOT_SUPPORTED );
6406 /* Accept only byte-aligned keys, for the same reasons as
6407 * in psa_import_rsa_key(). */
6408 if( bits % 8 != 0 )
6409 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006410 status = psa_read_rsa_exponent( domain_parameters,
6411 domain_parameters_size,
6412 &exponent );
6413 if( status != PSA_SUCCESS )
6414 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006415 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6416 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006417 mbedtls_ctr_drbg_random,
6418 &global_data.ctr_drbg,
6419 (unsigned int) bits,
6420 exponent );
6421 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006422 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006423
6424 /* Make sure to always have an export representation available */
6425 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6426
Steven Cooreman75b74362020-07-28 14:30:13 +02006427 status = psa_allocate_buffer_to_slot( slot, bytes );
6428 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006429 {
6430 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006431 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006432 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006433
6434 status = psa_export_rsa_key( type,
6435 &rsa,
6436 slot->data.key.data,
6437 bytes,
6438 &slot->data.key.bytes );
6439 mbedtls_rsa_free( &rsa );
6440 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006441 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006442 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006443 }
6444 else
John Durkop07cc04a2020-11-16 22:08:34 -08006445#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006446
John Durkop9814fa22020-11-04 12:28:15 -08006447#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006448 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006449 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006450 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006451 mbedtls_ecp_group_id grp_id =
6452 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006453 const mbedtls_ecp_curve_info *curve_info =
6454 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006455 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006456 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006457 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006458 return( PSA_ERROR_NOT_SUPPORTED );
6459 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6460 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006461 mbedtls_ecp_keypair_init( &ecp );
6462 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006463 mbedtls_ctr_drbg_random,
6464 &global_data.ctr_drbg );
6465 if( ret != 0 )
6466 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006467 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006468 return( mbedtls_to_psa_error( ret ) );
6469 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006470
6471
6472 /* Make sure to always have an export representation available */
6473 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006474 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6475 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006476 {
6477 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006478 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006479 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006480
6481 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006482 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6483
6484 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006485 if( status != PSA_SUCCESS ) {
6486 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006487 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006488 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006489 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006490 }
6491 else
John Durkop9814fa22020-11-04 12:28:15 -08006492#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006493 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006494 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006495 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006496
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006497 return( PSA_SUCCESS );
6498}
Darryl Green0c6575a2018-11-07 16:05:30 +00006499
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006500psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006501 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006502{
6503 psa_status_t status;
6504 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006505 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006506
Ronald Cron81709fc2020-11-14 12:10:32 +01006507 *key = MBEDTLS_SVC_KEY_ID_INIT;
6508
Gilles Peskine0f84d622019-09-12 19:03:13 +02006509 /* Reject any attempt to create a zero-length key so that we don't
6510 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6511 if( psa_get_key_bits( attributes ) == 0 )
6512 return( PSA_ERROR_INVALID_ARGUMENT );
6513
Ronald Cron81709fc2020-11-14 12:10:32 +01006514 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6515 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006516 if( status != PSA_SUCCESS )
6517 goto exit;
6518
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006519 status = psa_driver_wrapper_generate_key( attributes,
6520 slot );
6521 if( status != PSA_ERROR_NOT_SUPPORTED ||
6522 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6523 goto exit;
6524
6525 status = psa_generate_key_internal(
6526 slot, attributes->core.bits,
6527 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006528
6529exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006530 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006531 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006532 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006533 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006534
Darryl Green0c6575a2018-11-07 16:05:30 +00006535 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006536}
6537
6538
Gilles Peskinee59236f2018-01-27 23:32:46 +01006539
6540/****************************************************************/
6541/* Module setup */
6542/****************************************************************/
6543
Gilles Peskine5e769522018-11-20 21:59:56 +01006544psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6545 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6546 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6547{
6548 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6549 return( PSA_ERROR_BAD_STATE );
6550 global_data.entropy_init = entropy_init;
6551 global_data.entropy_free = entropy_free;
6552 return( PSA_SUCCESS );
6553}
6554
Gilles Peskinee59236f2018-01-27 23:32:46 +01006555void mbedtls_psa_crypto_free( void )
6556{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006557 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006558 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6559 {
6560 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006561 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006562 }
6563 /* Wipe all remaining data, including configuration.
6564 * In particular, this sets all state indicator to the value
6565 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006566 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006567#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006568 /* Unregister all secure element drivers, so that we restart from
6569 * a pristine state. */
6570 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006571#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006572}
6573
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006574#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6575/** Recover a transaction that was interrupted by a power failure.
6576 *
6577 * This function is called during initialization, before psa_crypto_init()
6578 * returns. If this function returns a failure status, the initialization
6579 * fails.
6580 */
6581static psa_status_t psa_crypto_recover_transaction(
6582 const psa_crypto_transaction_t *transaction )
6583{
6584 switch( transaction->unknown.type )
6585 {
6586 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6587 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006588 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006589 * is implemented.
6590 * https://github.com/ARMmbed/mbed-crypto/issues/218
6591 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006592 default:
6593 /* We found an unsupported transaction in the storage.
6594 * We don't know what state the storage is in. Give up. */
6595 return( PSA_ERROR_STORAGE_FAILURE );
6596 }
6597}
6598#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6599
Gilles Peskinee59236f2018-01-27 23:32:46 +01006600psa_status_t psa_crypto_init( void )
6601{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006602 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006603 const unsigned char drbg_seed[] = "PSA";
6604
Gilles Peskinec6b69072018-11-20 21:42:52 +01006605 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006606 if( global_data.initialized != 0 )
6607 return( PSA_SUCCESS );
6608
Gilles Peskine5e769522018-11-20 21:59:56 +01006609 /* Set default configuration if
6610 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6611 if( global_data.entropy_init == NULL )
6612 global_data.entropy_init = mbedtls_entropy_init;
6613 if( global_data.entropy_free == NULL )
6614 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006615
Gilles Peskinec6b69072018-11-20 21:42:52 +01006616 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006617 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006618#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6619 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6620 /* The PSA entropy injection feature depends on using NV seed as an entropy
6621 * source. Add NV seed as an entropy source for PSA entropy injection. */
6622 mbedtls_entropy_add_source( &global_data.entropy,
6623 mbedtls_nv_seed_poll, NULL,
6624 MBEDTLS_ENTROPY_BLOCK_SIZE,
6625 MBEDTLS_ENTROPY_SOURCE_STRONG );
6626#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006627 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006628 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006629 status = mbedtls_to_psa_error(
6630 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6631 mbedtls_entropy_func,
6632 &global_data.entropy,
6633 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6634 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006635 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006636 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006637
Gilles Peskine66fb1262018-12-10 16:29:04 +01006638 status = psa_initialize_key_slots( );
6639 if( status != PSA_SUCCESS )
6640 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006641
Gilles Peskined9348f22019-10-01 15:22:29 +02006642#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6643 status = psa_init_all_se_drivers( );
6644 if( status != PSA_SUCCESS )
6645 goto exit;
6646#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6647
Gilles Peskine4b734222019-07-24 15:56:31 +02006648#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006649 status = psa_crypto_load_transaction( );
6650 if( status == PSA_SUCCESS )
6651 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006652 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6653 if( status != PSA_SUCCESS )
6654 goto exit;
6655 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006656 }
6657 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6658 {
6659 /* There's no transaction to complete. It's all good. */
6660 status = PSA_SUCCESS;
6661 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006662#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006663
Gilles Peskinec6b69072018-11-20 21:42:52 +01006664 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006665 global_data.initialized = 1;
6666
6667exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006668 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006669 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006670 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006671}
6672
6673#endif /* MBEDTLS_PSA_CRYPTO_C */