blob: 466845d8a50c5a0c51ed2d5a75e860c51d435ef9 [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
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010038#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010039#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010040#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020041#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020042#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020043#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010044#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010045/* Include internal declarations that are useful for implementing persistently
46 * stored keys. */
47#include "psa_crypto_storage.h"
48
Gilles Peskineb2b64d32020-12-14 16:43:58 +010049#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010050
Gilles Peskineb46bef22019-07-30 21:32:04 +020051#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#include <stdlib.h>
53#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020055#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010056#define mbedtls_calloc calloc
57#define mbedtls_free free
58#endif
59
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010060#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020062#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000063#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020064#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010065#include "mbedtls/blowfish.h"
66#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020067#include "mbedtls/chacha20.h"
68#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/cipher.h"
70#include "mbedtls/ccm.h"
71#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010072#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020073#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010074#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010075#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010076#include "mbedtls/error.h"
77#include "mbedtls/gcm.h"
78#include "mbedtls/md2.h"
79#include "mbedtls/md4.h"
80#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010081#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000082#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010083#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000084#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010085#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000086#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010088#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010089#include "mbedtls/sha1.h"
90#include "mbedtls/sha256.h"
91#include "mbedtls/sha512.h"
92#include "mbedtls/xtea.h"
93
Gilles Peskine996deb12018-08-01 15:45:45 +020094#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
95
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010096/****************************************************************/
97/* Global data, support functions and library management */
98/****************************************************************/
99
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200100static int key_type_is_raw_bytes( psa_key_type_t type )
101{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200102 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200103}
104
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100105/* Values for psa_global_data_t::rng_state */
106#define RNG_NOT_INITIALIZED 0
107#define RNG_INITIALIZED 1
108#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100109
Gilles Peskine2d277862018-06-18 15:41:12 +0200110typedef struct
111{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100112 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100113 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100114 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100115} psa_global_data_t;
116
117static psa_global_data_t global_data;
118
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100119#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
120mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
121 &global_data.rng.drbg;
122#endif
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100130 /* Mbed TLS error codes can combine a high-level error code and a
131 * low-level error code. The low-level error usually reflects the
132 * root cause better, so dispatch on that preferably. */
133 int low_level_ret = - ( -ret & 0x007f );
134 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135 {
136 case 0:
137 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100138
139 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
140 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100141 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200142 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
143 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
144 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
145 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
146 case MBEDTLS_ERR_ASN1_INVALID_DATA:
147 return( PSA_ERROR_INVALID_ARGUMENT );
148 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
149 return( PSA_ERROR_INSUFFICIENT_MEMORY );
150 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
151 return( PSA_ERROR_BUFFER_TOO_SMALL );
152
Jaeden Amero93e21112019-02-20 13:57:28 +0000153#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000154 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000155#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100156 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
157 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100158
Jaeden Amero93e21112019-02-20 13:57:28 +0000159#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000160 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100162 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
163 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100164
165 case MBEDTLS_ERR_CCM_BAD_INPUT:
166 return( PSA_ERROR_INVALID_ARGUMENT );
167 case MBEDTLS_ERR_CCM_AUTH_FAILED:
168 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100169
Gilles Peskine26869f22019-05-06 15:25:00 +0200170 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
171 return( PSA_ERROR_INVALID_ARGUMENT );
172
173 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
174 return( PSA_ERROR_BAD_STATE );
175 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
176 return( PSA_ERROR_INVALID_SIGNATURE );
177
Gilles Peskinea5905292018-02-07 20:59:33 +0100178 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
179 return( PSA_ERROR_NOT_SUPPORTED );
180 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
181 return( PSA_ERROR_INVALID_ARGUMENT );
182 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
183 return( PSA_ERROR_INSUFFICIENT_MEMORY );
184 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
185 return( PSA_ERROR_INVALID_PADDING );
186 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200187 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100188 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
189 return( PSA_ERROR_INVALID_SIGNATURE );
190 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200191 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100192
Gilles Peskine82e57d12020-11-13 21:31:17 +0100193#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
194 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100195 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
196 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
199 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
200 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
201 return( PSA_ERROR_NOT_SUPPORTED );
202 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
203 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100204#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100205
206 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
207 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208
Gilles Peskinee59236f2018-01-27 23:32:46 +0100209 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
210 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
211 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100213
214 case MBEDTLS_ERR_GCM_AUTH_FAILED:
215 return( PSA_ERROR_INVALID_SIGNATURE );
216 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200217 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100218
Gilles Peskine82e57d12020-11-13 21:31:17 +0100219#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
220 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100221 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
222 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100223 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
224 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
225 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
226 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
227 return( PSA_ERROR_NOT_SUPPORTED );
228 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
230#endif
231
Gilles Peskinea5905292018-02-07 20:59:33 +0100232 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
233 return( PSA_ERROR_NOT_SUPPORTED );
234 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
235 return( PSA_ERROR_INVALID_ARGUMENT );
236 case MBEDTLS_ERR_MD_ALLOC_FAILED:
237 return( PSA_ERROR_INSUFFICIENT_MEMORY );
238 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
239 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100240
Gilles Peskinef76aa772018-10-29 19:24:33 +0100241 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
242 return( PSA_ERROR_STORAGE_FAILURE );
243 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
244 return( PSA_ERROR_INVALID_ARGUMENT );
245 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
248 return( PSA_ERROR_BUFFER_TOO_SMALL );
249 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
252 return( PSA_ERROR_INVALID_ARGUMENT );
253 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
254 return( PSA_ERROR_INVALID_ARGUMENT );
255 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
256 return( PSA_ERROR_INSUFFICIENT_MEMORY );
257
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100258 case MBEDTLS_ERR_PK_ALLOC_FAILED:
259 return( PSA_ERROR_INSUFFICIENT_MEMORY );
260 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
261 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100264 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100265 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
266 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
269 return( PSA_ERROR_NOT_SUPPORTED );
270 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
271 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
272 return( PSA_ERROR_NOT_PERMITTED );
273 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
274 return( PSA_ERROR_INVALID_ARGUMENT );
275 case MBEDTLS_ERR_PK_INVALID_ALG:
276 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
277 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
278 return( PSA_ERROR_NOT_SUPPORTED );
279 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
280 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100281
Gilles Peskineff2d2002019-05-06 15:26:23 +0200282 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
283 return( PSA_ERROR_HARDWARE_FAILURE );
284 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
285 return( PSA_ERROR_NOT_SUPPORTED );
286
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_RSA_INVALID_PADDING:
290 return( PSA_ERROR_INVALID_PADDING );
291 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
292 return( PSA_ERROR_HARDWARE_FAILURE );
293 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
294 return( PSA_ERROR_INVALID_ARGUMENT );
295 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
296 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200297 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100298 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
299 return( PSA_ERROR_INVALID_SIGNATURE );
300 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
301 return( PSA_ERROR_BUFFER_TOO_SMALL );
302 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100303 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200304
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
306 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100307
itayzafrir5c753392018-05-08 11:18:38 +0300308 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300309 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300310 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300311 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
312 return( PSA_ERROR_BUFFER_TOO_SMALL );
313 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
314 return( PSA_ERROR_NOT_SUPPORTED );
315 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
316 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
319 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100320 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100322
Janos Follatha13b9052019-11-22 12:48:59 +0000323 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
324 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300325
Gilles Peskinee59236f2018-01-27 23:32:46 +0100326 default:
David Saadab4ecc272019-02-14 13:48:10 +0200327 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100328 }
329}
330
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200331
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200332
333
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100334/****************************************************************/
335/* Key management */
336/****************************************************************/
337
Gilles Peskine73167e12019-07-12 23:44:37 +0200338#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
339static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
340{
Gilles Peskine8e338702019-07-30 20:06:31 +0200341 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200342}
343#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
344
John Durkop07cc04a2020-11-16 22:08:34 -0800345/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
346 * current test driver in key_management.c is using this function
347 * when accelerators are used for ECC key pair and public key.
348 * Once that dependency is resolved these guards can be removed.
349 */
John Durkop9814fa22020-11-04 12:28:15 -0800350#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800351 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
352 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
353 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100354mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100355 size_t bits,
356 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200357{
358 switch( curve )
359 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100360 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100361 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100362 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100363#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100364 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100365 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
367#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100368 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100369 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100370#endif
371#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100372 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100373 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100374#endif
375#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#endif
379#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100380 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 528:
383 if( bits_is_sloppy )
384 return( MBEDTLS_ECP_DP_SECP521R1 );
385 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100386#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100387 }
388 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100389
Paul Elliott8ff510a2020-06-02 17:19:28 +0100390 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100391 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100393#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100396#endif
397#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100399 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
401#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100402 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100404#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100405 }
406 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100407
Paul Elliott8ff510a2020-06-02 17:19:28 +0100408 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100409 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100411#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 256:
415 if( bits_is_sloppy )
416 return( MBEDTLS_ECP_DP_CURVE25519 );
417 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
419#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100420 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100422#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 }
424 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100425
Paul Elliott8ff510a2020-06-02 17:19:28 +0100426 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100427 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100429#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100430 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100431 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100432#endif
433#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100434 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100435 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#endif
437#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100438 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100439 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100440#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100441 }
442 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200443 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100445 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100446 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200447}
John Durkop9814fa22020-11-04 12:28:15 -0800448#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800449 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
450 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
451 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200452
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200453static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
454 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455{
456 /* Check that the bit size is acceptable for the key type */
457 switch( type )
458 {
459 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200460 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200461 case PSA_KEY_TYPE_DERIVE:
462 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_AES:
465 if( bits != 128 && bits != 192 && bits != 256 )
466 return( PSA_ERROR_INVALID_ARGUMENT );
467 break;
468#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100469#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200470 case PSA_KEY_TYPE_CAMELLIA:
471 if( bits != 128 && bits != 192 && bits != 256 )
472 return( PSA_ERROR_INVALID_ARGUMENT );
473 break;
474#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100475#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200476 case PSA_KEY_TYPE_DES:
477 if( bits != 64 && bits != 128 && bits != 192 )
478 return( PSA_ERROR_INVALID_ARGUMENT );
479 break;
480#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100481#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200482 case PSA_KEY_TYPE_ARC4:
483 if( bits < 8 || bits > 2048 )
484 return( PSA_ERROR_INVALID_ARGUMENT );
485 break;
486#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100487#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200488 case PSA_KEY_TYPE_CHACHA20:
489 if( bits != 256 )
490 return( PSA_ERROR_INVALID_ARGUMENT );
491 break;
492#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200493 default:
494 return( PSA_ERROR_NOT_SUPPORTED );
495 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200496 if( bits % 8 != 0 )
497 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200498
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200499 return( PSA_SUCCESS );
500}
501
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 *
Steven Cooremancd640932021-03-08 12:00:27 +0100504 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
505 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506 *
507 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100508 * \param[in] key_type The key type of the key to be used with the
509 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100510 *
511 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100512 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100513 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100514 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100515 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100516MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100517 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100518 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100519{
Steven Cooremancd640932021-03-08 12:00:27 +0100520 if( PSA_ALG_IS_HMAC( algorithm ) )
521 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100522 if( key_type == PSA_KEY_TYPE_HMAC )
523 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100524 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100525
526 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100527 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100528 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
529 * key. */
530 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
531 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
532 {
533 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
534 * the block length (larger than 1) for block ciphers. */
535 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
536 return( PSA_SUCCESS );
537 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100538 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100539
540 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100541}
542
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200543psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
544 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200545{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200547 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200548
Ronald Cronea0f8a62020-11-25 17:52:23 +0100549 slot->key.data = mbedtls_calloc( 1, buffer_length );
550 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200551 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200552
Ronald Cronea0f8a62020-11-25 17:52:23 +0100553 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200554 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200555}
556
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200557psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
558 const uint8_t* data,
559 size_t data_length )
560{
561 psa_status_t status = psa_allocate_buffer_to_slot( slot,
562 data_length );
563 if( status != PSA_SUCCESS )
564 return( status );
565
Ronald Cronea0f8a62020-11-25 17:52:23 +0100566 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200567 return( PSA_SUCCESS );
568}
569
Ronald Crona0fe59f2020-11-29 11:14:53 +0100570psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100571 const psa_key_attributes_t *attributes,
572 const uint8_t *data, size_t data_length,
573 uint8_t *key_buffer, size_t key_buffer_size,
574 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100575{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100576 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
577 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100578
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200579 /* zero-length keys are never supported. */
580 if( data_length == 0 )
581 return( PSA_ERROR_NOT_SUPPORTED );
582
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100583 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100584 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Steven Cooreman75b74362020-07-28 14:30:13 +0200587 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
588 if( data_length > SIZE_MAX / 8 )
589 return( PSA_ERROR_NOT_SUPPORTED );
590
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200591 /* Enforce a size limit, and in particular ensure that the bit
592 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200594 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200595
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100596 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200597 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200598 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200599
Ronald Crondd04d422020-11-28 15:14:42 +0100600 /* Copy the key material. */
601 memcpy( key_buffer, data, data_length );
602 *key_buffer_length = data_length;
603 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200604
Steven Cooreman40120f62020-10-29 11:42:22 +0100605 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100606 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200608 {
John Durkop9814fa22020-11-04 12:28:15 -0800609#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
610 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100611 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200612 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100613 return( mbedtls_psa_ecp_import_key( attributes,
614 data, data_length,
615 key_buffer, key_buffer_size,
616 key_buffer_length,
617 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100618 }
John Durkop9814fa22020-11-04 12:28:15 -0800619#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
620 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700621#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
622 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100623 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200624 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100625 return( mbedtls_psa_rsa_import_key( attributes,
626 data, data_length,
627 key_buffer, key_buffer_size,
628 key_buffer_length,
629 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200630 }
John Durkop9814fa22020-11-04 12:28:15 -0800631#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
632 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100633 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100634
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100635 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100636}
637
Gilles Peskinef603c712019-01-19 13:40:11 +0100638/** Calculate the intersection of two algorithm usage policies.
639 *
640 * Return 0 (which allows no operation) on incompatibility.
641 */
642static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100643 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100644 psa_algorithm_t alg1,
645 psa_algorithm_t alg2 )
646{
Gilles Peskine549ea862019-05-22 11:45:59 +0200647 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100648 if( alg1 == alg2 )
649 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100650 /* If the policies are from the same hash-and-sign family, check
651 * if one is a wildcard. If so the other has the specific algorithm. */
652 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
653 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
654 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100655 {
Steven Cooreman03488022021-02-18 12:07:20 +0100656 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
657 return( alg2 );
658 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
659 return( alg1 );
660 }
661 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100662 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100663 * restrictive tag length. */
664 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
665 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
666 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
667 {
668 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
669 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100670 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100671
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100672 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100673 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
674 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100675 {
Steven Cooremancd640932021-03-08 12:00:27 +0100676 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
677 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100678 }
679 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100680 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100681 ( alg1_len <= alg2_len ) )
682 {
683 return( alg2 );
684 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100685 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100686 ( alg2_len <= alg1_len ) )
687 {
688 return( alg1 );
689 }
690 }
691 /* If the policies are from the same MAC family, check whether one
692 * of them is a minimum-MAC-length policy. Calculate the most
693 * restrictive tag length. */
694 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
695 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
696 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
697 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100698 /* Validate the combination of key type and algorithm. Since the base
699 * algorithm of alg1 and alg2 are the same, we only need this once. */
700 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100701 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100702
Steven Cooreman31a876d2021-03-03 20:47:40 +0100703 /* Get the (exact or at-least) output lengths for both sides of the
704 * requested intersection. None of the currently supported algorithms
705 * have an output length dependent on the actual key size, so setting it
706 * to a bogus value of 0 is currently OK.
707 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100708 * Note that for at-least-this-length wildcard algorithms, the output
709 * length is set to the shortest allowed length, which allows us to
710 * calculate the most restrictive tag length for the intersection. */
711 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
712 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100713 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100714
Steven Cooremana1d83222021-02-25 10:20:29 +0100715 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100716 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
717 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100718 {
Steven Cooremancd640932021-03-08 12:00:27 +0100719 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100720 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100721
722 /* If only one is an at-least-this-length policy, the intersection would
723 * be the other (fixed-length) policy as long as said fixed length is
724 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100725 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100726 {
Steven Cooremancd640932021-03-08 12:00:27 +0100727 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100729 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100730 {
Steven Cooremancd640932021-03-08 12:00:27 +0100731 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100732 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100733
Steven Cooremancd640932021-03-08 12:00:27 +0100734 /* If none of them are wildcards, check whether they define the same tag
735 * length. This is still possible here when one is default-length and
736 * the other specific-length. Ensure to always return the
737 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100738 if( alg1_len == alg2_len )
739 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100740 }
741 /* If the policies are incompatible, allow nothing. */
742 return( 0 );
743}
744
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100745static int psa_key_algorithm_permits( psa_key_type_t key_type,
746 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200747 psa_algorithm_t requested_alg )
748{
Gilles Peskine549ea862019-05-22 11:45:59 +0200749 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200750 if( requested_alg == policy_alg )
751 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100752 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
753 * and requested_alg is the same hash-and-sign family with any hash,
754 * then requested_alg is compliant with policy_alg. */
755 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
756 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200757 {
Steven Cooreman03488022021-02-18 12:07:20 +0100758 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
759 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
760 }
761 /* If policy_alg is a wildcard AEAD algorithm of the same base as
762 * the requested algorithm, check the requested tag length to be
763 * equal-length or longer than the wildcard-specified length. */
764 if( PSA_ALG_IS_AEAD( policy_alg ) &&
765 PSA_ALG_IS_AEAD( requested_alg ) &&
766 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
767 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100768 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100769 {
770 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
771 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
772 }
Steven Cooremancd640932021-03-08 12:00:27 +0100773 /* If policy_alg is a MAC algorithm of the same base as the requested
774 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100775 if( PSA_ALG_IS_MAC( policy_alg ) &&
776 PSA_ALG_IS_MAC( requested_alg ) &&
777 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100778 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100779 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100780 /* Validate the combination of key type and algorithm. Since the policy
781 * and requested algorithms are the same, we only need this once. */
782 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100783 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784
Steven Cooreman31a876d2021-03-03 20:47:40 +0100785 /* Get both the requested output length for the algorithm which is to be
786 * verified, and the default output length for the base algorithm.
787 * Note that none of the currently supported algorithms have an output
788 * length dependent on actual key size, so setting it to a bogus value
789 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100790 size_t requested_output_length = PSA_MAC_LENGTH(
791 key_type, 0, requested_alg );
792 size_t default_output_length = PSA_MAC_LENGTH(
793 key_type, 0,
794 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100795
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100796 /* If the policy is default-length, only allow an algorithm with
797 * a declared exact-length matching the default. */
798 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100799 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100800
801 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100802 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100803 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
804 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
805 {
806 return( 1 );
807 }
808
Steven Cooremancd640932021-03-08 12:00:27 +0100809 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
810 * check for the requested MAC length to be equal to or longer than the
811 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100812 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
813 {
814 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100815 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100816 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200817 }
Steven Cooremance48e852020-10-05 16:02:45 +0200818 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200819 * a key derivation with that key agreement should also be allowed. This
820 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200821 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
822 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
823 {
824 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
825 policy_alg );
826 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100827 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200828 return( 0 );
829}
830
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831/** Test whether a policy permits an algorithm.
832 *
833 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100834 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100835 * \note This function requires providing the key type for which the policy is
836 * being validated, since some algorithm policy definitions (e.g. MAC)
837 * have different properties depending on what kind of cipher it is
838 * combined with.
839 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100840 * \retval PSA_SUCCESS When \p alg is a specific algorithm
841 * allowed by the \p policy.
842 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
843 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
844 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100845 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100846static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100847 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100848 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100849{
Steven Cooremand788fab2021-02-25 11:29:17 +0100850 /* '0' is not a valid algorithm */
851 if( alg == 0 )
852 return( PSA_ERROR_INVALID_ARGUMENT );
853
Steven Cooreman7e39f052021-02-23 14:18:32 +0100854 /* A requested algorithm cannot be a wildcard. */
855 if( PSA_ALG_IS_WILDCARD( alg ) )
856 return( PSA_ERROR_INVALID_ARGUMENT );
857
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100858 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
859 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100860 return( PSA_SUCCESS );
861 else
862 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100863}
864
Gilles Peskinef603c712019-01-19 13:40:11 +0100865/** Restrict a key policy based on a constraint.
866 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100867 * \note This function requires providing the key type for which the policy is
868 * being restricted, since some algorithm policy definitions (e.g. MAC)
869 * have different properties depending on what kind of cipher it is
870 * combined with.
871 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100872 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100873 * \param[in,out] policy The policy to restrict.
874 * \param[in] constraint The policy constraint to apply.
875 *
876 * \retval #PSA_SUCCESS
877 * \c *policy contains the intersection of the original value of
878 * \c *policy and \c *constraint.
879 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100880 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100881 * \c *policy is unchanged.
882 */
883static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100884 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100885 psa_key_policy_t *policy,
886 const psa_key_policy_t *constraint )
887{
888 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100889 psa_key_policy_algorithm_intersection( key_type, policy->alg,
890 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200891 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100892 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
893 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100894 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
895 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200896 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
897 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100898 policy->usage &= constraint->usage;
899 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200900 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100901 return( PSA_SUCCESS );
902}
903
Ronald Cron5c522922020-11-14 16:35:34 +0100904/** Get the description of a key given its identifier and policy constraints
905 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200906 *
Ronald Cron5c522922020-11-14 16:35:34 +0100907 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100908 * nonzero, the key must allow operations with this algorithm. If \p alg is
909 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100910 *
Ronald Cron5c522922020-11-14 16:35:34 +0100911 * In case of a persistent key, the function loads the description of the key
912 * into a key slot if not already done.
913 *
914 * On success, the returned key slot is locked. It is the responsibility of
915 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200916 */
Ronald Cron5c522922020-11-14 16:35:34 +0100917static psa_status_t psa_get_and_lock_key_slot_with_policy(
918 mbedtls_svc_key_id_t key,
919 psa_key_slot_t **p_slot,
920 psa_key_usage_t usage,
921 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100922{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200923 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
924 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Ronald Cron5c522922020-11-14 16:35:34 +0100926 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100927 if( status != PSA_SUCCESS )
928 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200929 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100930
931 /* Enforce that usage policy for the key slot contains all the flags
932 * required by the usage parameter. There is one exception: public
933 * keys can always be exported, so we treat public key objects as
934 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200935 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100936 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937
Gilles Peskine8e338702019-07-30 20:06:31 +0200938 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100939 {
940 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200941 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100942 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100943
944 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100945 if( alg != 0 )
946 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100947 status = psa_key_policy_permits( &slot->attr.policy,
948 slot->attr.type,
949 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100950 if( status != PSA_SUCCESS )
951 goto error;
952 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100953
Darryl Green06fd18d2018-07-16 11:21:11 +0100954 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200955
956error:
957 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100958 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959
960 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100961}
Darryl Green940d72c2018-07-13 13:18:51 +0100962
Ronald Cron5c522922020-11-14 16:35:34 +0100963/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964 *
965 * A transparent key is a key for which the key material is directly
966 * available, as opposed to a key in a secure element.
967 *
Ronald Cron5c522922020-11-14 16:35:34 +0100968 * This is a temporary function to use instead of
969 * psa_get_and_lock_key_slot_with_policy() until secure element support is
970 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200971 *
Ronald Cron5c522922020-11-14 16:35:34 +0100972 * On success, the returned key slot is locked. It is the responsibility of the
973 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200974 */
975#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100976static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
977 mbedtls_svc_key_id_t key,
978 psa_key_slot_t **p_slot,
979 psa_key_usage_t usage,
980 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981{
Ronald Cron5c522922020-11-14 16:35:34 +0100982 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
983 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200984 if( status != PSA_SUCCESS )
985 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200986
Gilles Peskineadad8132019-07-25 11:31:23 +0200987 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200988 {
Ronald Cron5c522922020-11-14 16:35:34 +0100989 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200990 *p_slot = NULL;
991 return( PSA_ERROR_NOT_SUPPORTED );
992 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200993
Gilles Peskine28f8f302019-07-24 13:30:31 +0200994 return( PSA_SUCCESS );
995}
996#else /* MBEDTLS_PSA_CRYPTO_SE_C */
997/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100998#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
999 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001000#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1001
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001002psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001003{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001004 /* Data pointer will always be either a valid pointer or NULL in an
1005 * initialized slot, so we can just free it. */
1006 if( slot->key.data != NULL )
1007 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1008
1009 mbedtls_free( slot->key.data );
1010 slot->key.data = NULL;
1011 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001012
1013 return( PSA_SUCCESS );
1014}
1015
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001016/** Completely wipe a slot in memory, including its policy.
1017 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001018psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001019{
1020 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001021
Ronald Cron5c522922020-11-14 16:35:34 +01001022 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001023 {
Ronald Cronddd3d052020-10-30 14:07:07 +01001024 status = PSA_ERROR_CORRUPTION_DETECTED;
1025 }
1026
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001027 /* Multipart operations may still be using the key. This is safe
1028 * because all multipart operation objects are independent from
1029 * the key slot: if they need to access the key after the setup
1030 * phase, they have a copy of the key. Note that this means that
1031 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001032 /* At this point, key material and other type-specific content has
1033 * been wiped. Clear remaining metadata. We can call memset and not
1034 * zeroize because the metadata is not particularly sensitive. */
1035 memset( slot, 0, sizeof( *slot ) );
1036 return( status );
1037}
1038
Ronald Croncf56a0a2020-08-04 09:51:30 +02001039psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001041 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001042 psa_status_t status; /* status of the last operation */
1043 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001044#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1045 psa_se_drv_table_entry_t *driver;
1046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001047
Ronald Croncf56a0a2020-08-04 09:51:30 +02001048 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001049 return( PSA_SUCCESS );
1050
Ronald Cronf2911112020-10-29 17:51:10 +01001051 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001052 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001053 * key, this will load the key description from persistent memory if not
1054 * done yet. We cannot avoid this loading as without it we don't know if
1055 * the key is operated by an SE or not and this information is needed by
1056 * the current implementation.
1057 */
Ronald Cron5c522922020-11-14 16:35:34 +01001058 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001059 if( status != PSA_SUCCESS )
1060 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001061
Ronald Cronf2911112020-10-29 17:51:10 +01001062 /*
1063 * If the key slot containing the key description is under access by the
1064 * library (apart from the present access), the key cannot be destroyed
1065 * yet. For the time being, just return in error. Eventually (to be
1066 * implemented), the key should be destroyed when all accesses have
1067 * stopped.
1068 */
Ronald Cron5c522922020-11-14 16:35:34 +01001069 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001070 {
Ronald Cron5c522922020-11-14 16:35:34 +01001071 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001072 return( PSA_ERROR_GENERIC_ERROR );
1073 }
1074
Gilles Peskine354f7672019-07-12 23:46:38 +02001075#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001076 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001077 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001078 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001079 /* For a key in a secure element, we need to do three things:
1080 * remove the key file in internal storage, destroy the
1081 * key inside the secure element, and update the driver's
1082 * persistent data. Start a transaction that will encompass these
1083 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001084 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001085 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001086 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001087 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 status = psa_crypto_save_transaction( );
1089 if( status != PSA_SUCCESS )
1090 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001091 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001092 /* We should still try to destroy the key in the secure
1093 * element and the key metadata in storage. This is especially
1094 * important if the error is that the storage is full.
1095 * But how to do it exactly without risking an inconsistent
1096 * state after a reset?
1097 * https://github.com/ARMmbed/mbed-crypto/issues/215
1098 */
1099 overall_status = status;
1100 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001101 }
1102
Ronald Cronea0f8a62020-11-25 17:52:23 +01001103 status = psa_destroy_se_key( driver,
1104 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001105 if( overall_status == PSA_SUCCESS )
1106 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001107 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001108#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1109
Darryl Greend49a4992018-06-18 17:27:26 +01001110#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001111 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001112 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001113 status = psa_destroy_persistent_key( slot->attr.id );
1114 if( overall_status == PSA_SUCCESS )
1115 overall_status = status;
1116
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001117 /* TODO: other slots may have a copy of the same key. We should
1118 * invalidate them.
1119 * https://github.com/ARMmbed/mbed-crypto/issues/214
1120 */
Darryl Greend49a4992018-06-18 17:27:26 +01001121 }
1122#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001123
Gilles Peskinefc762652019-07-22 19:30:34 +02001124#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1125 if( driver != NULL )
1126 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001127 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001128 if( overall_status == PSA_SUCCESS )
1129 overall_status = status;
1130 status = psa_crypto_stop_transaction( );
1131 if( overall_status == PSA_SUCCESS )
1132 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001133 }
1134#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1135
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001136#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1137exit:
1138#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001139 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1141 if( overall_status == PSA_SUCCESS )
1142 overall_status = status;
1143 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001144}
1145
John Durkop07cc04a2020-11-16 22:08:34 -08001146#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001147 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001148static psa_status_t psa_get_rsa_public_exponent(
1149 const mbedtls_rsa_context *rsa,
1150 psa_key_attributes_t *attributes )
1151{
1152 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001153 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001154 uint8_t *buffer = NULL;
1155 size_t buflen;
1156 mbedtls_mpi_init( &mpi );
1157
1158 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1159 if( ret != 0 )
1160 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001161 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1162 {
1163 /* It's the default value, which is reported as an empty string,
1164 * so there's nothing to do. */
1165 goto exit;
1166 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001167
1168 buflen = mbedtls_mpi_size( &mpi );
1169 buffer = mbedtls_calloc( 1, buflen );
1170 if( buffer == NULL )
1171 {
1172 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1173 goto exit;
1174 }
1175 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1176 if( ret != 0 )
1177 goto exit;
1178 attributes->domain_parameters = buffer;
1179 attributes->domain_parameters_size = buflen;
1180
1181exit:
1182 mbedtls_mpi_free( &mpi );
1183 if( ret != 0 )
1184 mbedtls_free( buffer );
1185 return( mbedtls_to_psa_error( ret ) );
1186}
John Durkop07cc04a2020-11-16 22:08:34 -08001187#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001188 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001189
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001190/** Retrieve all the publicly-accessible attributes of a key.
1191 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001192psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001193 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001194{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001195 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001196 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001197 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001198
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001199 psa_reset_key_attributes( attributes );
1200
Ronald Cron5c522922020-11-14 16:35:34 +01001201 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001202 if( status != PSA_SUCCESS )
1203 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001204
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001205 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1207 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1208
1209#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1210 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001211 psa_set_key_slot_number( attributes,
1212 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001213#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001214
Gilles Peskine8e338702019-07-30 20:06:31 +02001215 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001216 {
John Durkop07cc04a2020-11-16 22:08:34 -08001217#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001218 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001219 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001220 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001221#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001222 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001223 * is not yet implemented.
1224 * https://github.com/ARMmbed/mbed-crypto/issues/216
1225 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001226 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001227 break;
1228#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001229 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001230 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001231
Ronald Cron90857082020-11-25 14:58:33 +01001232 status = mbedtls_psa_rsa_load_representation(
1233 slot->attr.type,
1234 slot->key.data,
1235 slot->key.bytes,
1236 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001237 if( status != PSA_SUCCESS )
1238 break;
1239
Steven Cooremana2371e52020-07-28 14:30:39 +02001240 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001241 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001242 mbedtls_rsa_free( rsa );
1243 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001244 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001245 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001246#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001247 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001248 default:
1249 /* Nothing else to do. */
1250 break;
1251 }
1252
1253 if( status != PSA_SUCCESS )
1254 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001255
Ronald Cron5c522922020-11-14 16:35:34 +01001256 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001257
Ronald Cron5c522922020-11-14 16:35:34 +01001258 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001259}
1260
Gilles Peskinec8000c02019-08-02 20:15:51 +02001261#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1262psa_status_t psa_get_key_slot_number(
1263 const psa_key_attributes_t *attributes,
1264 psa_key_slot_number_t *slot_number )
1265{
1266 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1267 {
1268 *slot_number = attributes->slot_number;
1269 return( PSA_SUCCESS );
1270 }
1271 else
1272 return( PSA_ERROR_INVALID_ARGUMENT );
1273}
1274#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1275
Ronald Crond18b5f82020-11-25 16:46:05 +01001276static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1277 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001278 uint8_t *data,
1279 size_t data_size,
1280 size_t *data_length )
1281{
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001283 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001284 memcpy( data, key_buffer, key_buffer_size );
1285 memset( data + key_buffer_size, 0,
1286 data_size - key_buffer_size );
1287 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001288 return( PSA_SUCCESS );
1289}
1290
Ronald Cron7285cda2020-11-26 14:46:37 +01001291psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 const psa_key_attributes_t *attributes,
1293 const uint8_t *key_buffer, size_t key_buffer_size,
1294 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001295{
Ronald Crond18b5f82020-11-25 16:46:05 +01001296 psa_key_type_t type = attributes->core.type;
1297
Ronald Crond18b5f82020-11-25 16:46:05 +01001298 if( key_type_is_raw_bytes( type ) ||
1299 PSA_KEY_TYPE_IS_RSA( type ) ||
1300 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001301 {
1302 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001303 key_buffer, key_buffer_size,
1304 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001305 }
1306 else
1307 {
1308 /* This shouldn't happen in the reference implementation, but
1309 it is valid for a special-purpose implementation to omit
1310 support for exporting certain key types. */
1311 return( PSA_ERROR_NOT_SUPPORTED );
1312 }
1313}
1314
1315psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1316 uint8_t *data,
1317 size_t data_size,
1318 size_t *data_length )
1319{
1320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1321 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1322 psa_key_slot_t *slot;
1323
Ronald Crone907e552021-01-18 13:22:38 +01001324 /* Reject a zero-length output buffer now, since this can never be a
1325 * valid key representation. This way we know that data must be a valid
1326 * pointer and we can do things like memset(data, ..., data_size). */
1327 if( data_size == 0 )
1328 return( PSA_ERROR_BUFFER_TOO_SMALL );
1329
Ronald Cron9486f9d2020-11-26 13:36:23 +01001330 /* Set the key to empty now, so that even when there are errors, we always
1331 * set data_length to a value between 0 and data_size. On error, setting
1332 * the key to empty is a good choice because an empty key representation is
1333 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001334 *data_length = 0;
1335
Ronald Cron9486f9d2020-11-26 13:36:23 +01001336 /* Export requires the EXPORT flag. There is an exception for public keys,
1337 * which don't require any flag, but
1338 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1339 */
1340 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1341 PSA_KEY_USAGE_EXPORT, 0 );
1342 if( status != PSA_SUCCESS )
1343 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001344
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 psa_key_attributes_t attributes = {
1346 .core = slot->attr
1347 };
Ronald Cron67227982020-11-26 15:16:05 +01001348 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 slot->key.data, slot->key.bytes,
1350 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351
Ronald Cron9486f9d2020-11-26 13:36:23 +01001352 unlock_status = psa_unlock_key_slot( slot );
1353
1354 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1355}
1356
Ronald Cron7285cda2020-11-26 14:46:37 +01001357psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 const psa_key_attributes_t *attributes,
1359 const uint8_t *key_buffer,
1360 size_t key_buffer_size,
1361 uint8_t *data,
1362 size_t data_size,
1363 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001364{
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001366
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001368 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001369 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001370 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001371 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001372 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001373 key_buffer, key_buffer_size,
1374 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001375 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001376
Ronald Crond18b5f82020-11-25 16:46:05 +01001377 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001378 {
John Durkop0e005192020-10-31 22:06:54 -07001379#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1380 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001381 return( mbedtls_psa_rsa_export_public_key( attributes,
1382 key_buffer,
1383 key_buffer_size,
1384 data,
1385 data_size,
1386 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001387#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001388 /* We don't know how to convert a private RSA key to public. */
1389 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1391 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001392 }
1393 else
Moran Pekera998bc62018-04-16 18:16:20 +03001394 {
John Durkop6ba40d12020-11-10 08:50:04 -08001395#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1396 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001397 return( mbedtls_psa_ecp_export_public_key( attributes,
1398 key_buffer,
1399 key_buffer_size,
1400 data,
1401 data_size,
1402 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001403#else
1404 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001405 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001406#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1407 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001408 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001409 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001410 else
1411 {
1412 /* This shouldn't happen in the reference implementation, but
1413 it is valid for a special-purpose implementation to omit
1414 support for exporting certain key types. */
1415 return( PSA_ERROR_NOT_SUPPORTED );
1416 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001417}
Ronald Crond18b5f82020-11-25 16:46:05 +01001418
Ronald Croncf56a0a2020-08-04 09:51:30 +02001419psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001420 uint8_t *data,
1421 size_t data_size,
1422 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001423{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001425 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001426 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001427
Ronald Crone907e552021-01-18 13:22:38 +01001428 /* Reject a zero-length output buffer now, since this can never be a
1429 * valid key representation. This way we know that data must be a valid
1430 * pointer and we can do things like memset(data, ..., data_size). */
1431 if( data_size == 0 )
1432 return( PSA_ERROR_BUFFER_TOO_SMALL );
1433
Darryl Greendd8fb772018-11-07 16:00:44 +00001434 /* Set the key to empty now, so that even when there are errors, we always
1435 * set data_length to a value between 0 and data_size. On error, setting
1436 * the key to empty is a good choice because an empty key representation is
1437 * unlikely to be accepted anywhere. */
1438 *data_length = 0;
1439
1440 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001441 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001442 if( status != PSA_SUCCESS )
1443 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001444
Ronald Cron9486f9d2020-11-26 13:36:23 +01001445 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1446 {
1447 status = PSA_ERROR_INVALID_ARGUMENT;
1448 goto exit;
1449 }
1450
Ronald Crond18b5f82020-11-25 16:46:05 +01001451 psa_key_attributes_t attributes = {
1452 .core = slot->attr
1453 };
Ronald Cron67227982020-11-26 15:16:05 +01001454 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001455 &attributes, slot->key.data, slot->key.bytes,
1456 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001457
1458exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001459 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001460
Ronald Cron5c522922020-11-14 16:35:34 +01001461 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001462}
1463
Gilles Peskine91e8c332019-08-02 19:19:39 +02001464#if defined(static_assert)
1465static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1466 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001467static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001468 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001469static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001470 "One or more key attribute flag is listed as both internal-only and external-only" );
1471#endif
1472
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001473/** Validate that a key policy is internally well-formed.
1474 *
1475 * This function only rejects invalid policies. It does not validate the
1476 * consistency of the policy with respect to other attributes of the key
1477 * such as the key type.
1478 */
1479static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001480{
1481 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001482 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001483 PSA_KEY_USAGE_ENCRYPT |
1484 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001485 PSA_KEY_USAGE_SIGN_MESSAGE |
1486 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001487 PSA_KEY_USAGE_SIGN_HASH |
1488 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001489 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001490 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1491 return( PSA_ERROR_INVALID_ARGUMENT );
1492
Gilles Peskine4747d192019-04-17 15:05:45 +02001493 return( PSA_SUCCESS );
1494}
1495
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001496/** Validate the internal consistency of key attributes.
1497 *
1498 * This function only rejects invalid attribute values. If does not
1499 * validate the consistency of the attributes with any key data that may
1500 * be involved in the creation of the key.
1501 *
1502 * Call this function early in the key creation process.
1503 *
1504 * \param[in] attributes Key attributes for the new key.
1505 * \param[out] p_drv On any return, the driver for the key, if any.
1506 * NULL for a transparent key.
1507 *
1508 */
1509static psa_status_t psa_validate_key_attributes(
1510 const psa_key_attributes_t *attributes,
1511 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001512{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001513 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001514 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001515 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001516
Ronald Cron54b90082020-10-29 15:26:43 +01001517 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001518 if( status != PSA_SUCCESS )
1519 return( status );
1520
Ronald Crond2ed4812020-07-17 16:11:30 +02001521 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001522 if( status != PSA_SUCCESS )
1523 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001524
Ronald Cron65f38a32020-10-23 17:11:13 +02001525 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1526 {
1527 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1528 return( PSA_ERROR_INVALID_ARGUMENT );
1529 }
1530 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001531 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001532 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1533 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001534 }
1535
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001536 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001537 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001538 return( status );
1539
1540 /* Refuse to create overly large keys.
1541 * Note that this doesn't trigger on import if the attributes don't
1542 * explicitly specify a size (so psa_get_key_bits returns 0), so
1543 * psa_import_key() needs its own checks. */
1544 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1545 return( PSA_ERROR_NOT_SUPPORTED );
1546
Gilles Peskine91e8c332019-08-02 19:19:39 +02001547 /* Reject invalid flags. These should not be reachable through the API. */
1548 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1549 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1550 return( PSA_ERROR_INVALID_ARGUMENT );
1551
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001552 return( PSA_SUCCESS );
1553}
1554
Gilles Peskine4747d192019-04-17 15:05:45 +02001555/** Prepare a key slot to receive key material.
1556 *
1557 * This function allocates a key slot and sets its metadata.
1558 *
1559 * If this function fails, call psa_fail_key_creation().
1560 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001561 * This function is intended to be used as follows:
1562 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001563 * it with the specified attributes, and in case of a volatile key assign it
1564 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001565 * -# Populate the slot with the key material.
1566 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1567 * In case of failure at any step, stop the sequence and call
1568 * psa_fail_key_creation().
1569 *
Ronald Cron5c522922020-11-14 16:35:34 +01001570 * On success, the key slot is locked. It is the responsibility of the caller
1571 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001572 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001573 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001574 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001575 * \param[out] p_slot On success, a pointer to the prepared slot.
1576 * \param[out] p_drv On any return, the driver for the key, if any.
1577 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001578 *
1579 * \retval #PSA_SUCCESS
1580 * The key slot is ready to receive key material.
1581 * \return If this function fails, the key slot is an invalid state.
1582 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 */
1584static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001585 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001587 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001588 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001589{
1590 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001591 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001592 psa_key_slot_t *slot;
1593
Gilles Peskinedf179142019-07-15 22:02:14 +02001594 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001595 *p_drv = NULL;
1596
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001597 status = psa_validate_key_attributes( attributes, p_drv );
1598 if( status != PSA_SUCCESS )
1599 return( status );
1600
Ronald Cronc4d1b512020-07-31 11:26:37 +02001601 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001602 if( status != PSA_SUCCESS )
1603 return( status );
1604 slot = *p_slot;
1605
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001606 /* We're storing the declared bit-size of the key. It's up to each
1607 * creation mechanism to verify that this information is correct.
1608 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001609 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001610 * is optional (import, copy). In case of a volatile key, assign it the
1611 * volatile key identifier associated to the slot returned to contain its
1612 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001613
1614 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001615 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1616 {
1617#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1618 slot->attr.id = volatile_key_id;
1619#else
1620 slot->attr.id.key_id = volatile_key_id;
1621#endif
1622 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001623
Gilles Peskine91e8c332019-08-02 19:19:39 +02001624 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001625 * external-only flags, query `attributes`. Thanks to the check
1626 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001627 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001628 * may have set. */
1629 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001630
Gilles Peskinecbaff462019-07-12 23:46:04 +02001631#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001632 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001633 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001634 * create the key file in internal storage, create the
1635 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001636 * persistent data. This is done by starting a transaction that will
1637 * encompass these three actions.
1638 * For registering a volatile key, we just need to find an appropriate
1639 * slot number inside the SE. Since the key is designated volatile, creating
1640 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001641 /* The first thing to do is to find a slot number for the new key.
1642 * We save the slot number in persistent storage as part of the
1643 * transaction data. It will be needed to recover if the power
1644 * fails during the key creation process, to clean up on the secure
1645 * element side after restarting. Obtaining a slot number from the
1646 * secure element driver updates its persistent state, but we do not yet
1647 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001648 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001649 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001650 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001651 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001652 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001653 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001654 if( status != PSA_SUCCESS )
1655 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001656
1657 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001658 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001659 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1660 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001662 psa_crypto_transaction.key.id = slot->attr.id;
1663 status = psa_crypto_save_transaction( );
1664 if( status != PSA_SUCCESS )
1665 {
1666 (void) psa_crypto_stop_transaction( );
1667 return( status );
1668 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001669 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001670
1671 status = psa_copy_key_material_into_slot(
1672 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001673 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001674
1675 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1676 {
1677 /* Key registration only makes sense with a secure element. */
1678 return( PSA_ERROR_INVALID_ARGUMENT );
1679 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001680#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1681
Ronald Cronc4d1b512020-07-31 11:26:37 +02001682 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001683}
Gilles Peskine4747d192019-04-17 15:05:45 +02001684
1685/** Finalize the creation of a key once its key material has been set.
1686 *
1687 * This entails writing the key to persistent storage.
1688 *
1689 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001690 * See the documentation of psa_start_key_creation() for the intended use
1691 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001692 *
Ronald Cron5c522922020-11-14 16:35:34 +01001693 * If the finalization succeeds, the function unlocks the key slot (it was
1694 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1695 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001696 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001697 * \param[in,out] slot Pointer to the slot with key material.
1698 * \param[in] driver The secure element driver for the key,
1699 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001700 * \param[out] key On success, identifier of the key. Note that the
1701 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001702 *
1703 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001704 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001705 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1706 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1707 * \retval #PSA_ERROR_ALREADY_EXISTS
1708 * \retval #PSA_ERROR_DATA_INVALID
1709 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001710 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001711 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001712 * \return If this function fails, the key slot is an invalid state.
1713 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001714 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001715static psa_status_t psa_finish_key_creation(
1716 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001717 psa_se_drv_table_entry_t *driver,
1718 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001719{
1720 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001721 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001722 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001723
1724#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001725 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001727#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1728 if( driver != NULL )
1729 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001730 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001731 psa_key_slot_number_t slot_number =
1732 psa_key_slot_get_slot_number( slot ) ;
1733
Gilles Peskineb46bef22019-07-30 21:32:04 +02001734#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001735 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001736 sizeof( data.slot_number ),
1737 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001738#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001739 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001740 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001741 (uint8_t*) &data,
1742 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001743 }
1744 else
1745#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1746 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001747 /* Key material is saved in export representation in the slot, so
1748 * just pass the slot buffer for storage. */
1749 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001750 slot->key.data,
1751 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001752 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001753 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001754#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1755
Gilles Peskinecbaff462019-07-12 23:46:04 +02001756#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001757 /* Finish the transaction for a key creation. This does not
1758 * happen when registering an existing key. Detect this case
1759 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001760 * creation of a persistent key in a secure element requires a transaction,
1761 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001762 if( driver != NULL &&
1763 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001764 {
1765 status = psa_save_se_persistent_data( driver );
1766 if( status != PSA_SUCCESS )
1767 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001768 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001769 return( status );
1770 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001771 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001772 }
1773#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1774
Ronald Cron50972942020-11-14 11:28:25 +01001775 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001776 {
1777 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001778 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001779 if( status != PSA_SUCCESS )
1780 *key = MBEDTLS_SVC_KEY_ID_INIT;
1781 }
Ronald Cron50972942020-11-14 11:28:25 +01001782
Gilles Peskine4747d192019-04-17 15:05:45 +02001783 return( status );
1784}
1785
1786/** Abort the creation of a key.
1787 *
1788 * You may call this function after calling psa_start_key_creation(),
1789 * or after psa_finish_key_creation() fails. In other circumstances, this
1790 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001791 * See the documentation of psa_start_key_creation() for the intended use
1792 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001793 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001794 * \param[in,out] slot Pointer to the slot with key material.
1795 * \param[in] driver The secure element driver for the key,
1796 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001797 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001798static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001799 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001800{
Gilles Peskine011e4282019-06-26 18:34:38 +02001801 (void) driver;
1802
Gilles Peskine4747d192019-04-17 15:05:45 +02001803 if( slot == NULL )
1804 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001805
1806#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001807 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001808 * element, and the failure happened later (when saving metadata
1809 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001810 * element.
1811 * https://github.com/ARMmbed/mbed-crypto/issues/217
1812 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001813
Gilles Peskined7729582019-08-05 15:55:54 +02001814 /* Abort the ongoing transaction if any (there may not be one if
1815 * the creation process failed before starting one, or if the
1816 * key creation is a registration of a key in a secure element).
1817 * Earlier functions must already have done what it takes to undo any
1818 * partial creation. All that's left is to update the transaction data
1819 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001820 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001821#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1822
Gilles Peskine4747d192019-04-17 15:05:45 +02001823 psa_wipe_key_slot( slot );
1824}
1825
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001826/** Validate optional attributes during key creation.
1827 *
1828 * Some key attributes are optional during key creation. If they are
1829 * specified in the attributes structure, check that they are consistent
1830 * with the data in the slot.
1831 *
1832 * This function should be called near the end of key creation, after
1833 * the slot in memory is fully populated but before saving persistent data.
1834 */
1835static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001836 const psa_key_slot_t *slot,
1837 const psa_key_attributes_t *attributes )
1838{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001839 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001841 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842 return( PSA_ERROR_INVALID_ARGUMENT );
1843 }
1844
1845 if( attributes->domain_parameters_size != 0 )
1846 {
John Durkop0e005192020-10-31 22:06:54 -07001847#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1848 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001849 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001851 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001852 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001853 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001854
Ronald Cron90857082020-11-25 14:58:33 +01001855 psa_status_t status = mbedtls_psa_rsa_load_representation(
1856 slot->attr.type,
1857 slot->key.data,
1858 slot->key.bytes,
1859 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001860 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001861 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001862
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001863 mbedtls_mpi_init( &actual );
1864 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001865 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001866 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001867 mbedtls_rsa_free( rsa );
1868 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 if( ret != 0 )
1870 goto rsa_exit;
1871 ret = mbedtls_mpi_read_binary( &required,
1872 attributes->domain_parameters,
1873 attributes->domain_parameters_size );
1874 if( ret != 0 )
1875 goto rsa_exit;
1876 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1877 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1878 rsa_exit:
1879 mbedtls_mpi_free( &actual );
1880 mbedtls_mpi_free( &required );
1881 if( ret != 0)
1882 return( mbedtls_to_psa_error( ret ) );
1883 }
1884 else
John Durkop9814fa22020-11-04 12:28:15 -08001885#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1886 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001887 {
1888 return( PSA_ERROR_INVALID_ARGUMENT );
1889 }
1890 }
1891
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001892 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001893 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001894 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 return( PSA_ERROR_INVALID_ARGUMENT );
1896 }
1897
1898 return( PSA_SUCCESS );
1899}
1900
Gilles Peskine4747d192019-04-17 15:05:45 +02001901psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001902 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001903 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001904 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001905{
1906 psa_status_t status;
1907 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001908 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001909 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910
Ronald Cron81709fc2020-11-14 12:10:32 +01001911 *key = MBEDTLS_SVC_KEY_ID_INIT;
1912
Gilles Peskine0f84d622019-09-12 19:03:13 +02001913 /* Reject zero-length symmetric keys (including raw data key objects).
1914 * This also rejects any key which might be encoded as an empty string,
1915 * which is never valid. */
1916 if( data_length == 0 )
1917 return( PSA_ERROR_INVALID_ARGUMENT );
1918
Gilles Peskinedf179142019-07-15 22:02:14 +02001919 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001920 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921 if( status != PSA_SUCCESS )
1922 goto exit;
1923
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001924 /* In the case of a transparent key or an opaque key stored in local
1925 * storage (thus not in the case of generating a key in a secure element
1926 * or cryptoprocessor with storage), we have to allocate a buffer to
1927 * hold the generated key material. */
1928 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001929 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001930 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001931 if( status != PSA_SUCCESS )
1932 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001933 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001934
1935 bits = slot->attr.bits;
1936 status = psa_driver_wrapper_import_key( attributes,
1937 data, data_length,
1938 slot->key.data,
1939 slot->key.bytes,
1940 &slot->key.bytes, &bits );
1941 if( status != PSA_SUCCESS )
1942 goto exit;
1943
1944 if( slot->attr.bits == 0 )
1945 slot->attr.bits = (psa_key_bits_t) bits;
1946 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001947 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001948 status = PSA_ERROR_INVALID_ARGUMENT;
1949 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001950 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001951
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001952 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001953 if( status != PSA_SUCCESS )
1954 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955
Ronald Cron81709fc2020-11-14 12:10:32 +01001956 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001957exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001959 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001960
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 return( status );
1962}
1963
Gilles Peskined7729582019-08-05 15:55:54 +02001964#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1965psa_status_t mbedtls_psa_register_se_key(
1966 const psa_key_attributes_t *attributes )
1967{
1968 psa_status_t status;
1969 psa_key_slot_t *slot = NULL;
1970 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001971 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001972
1973 /* Leaving attributes unspecified is not currently supported.
1974 * It could make sense to query the key type and size from the
1975 * secure element, but not all secure elements support this
1976 * and the driver HAL doesn't currently support it. */
1977 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1978 return( PSA_ERROR_NOT_SUPPORTED );
1979 if( psa_get_key_bits( attributes ) == 0 )
1980 return( PSA_ERROR_NOT_SUPPORTED );
1981
1982 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001983 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001984 if( status != PSA_SUCCESS )
1985 goto exit;
1986
Ronald Cron81709fc2020-11-14 12:10:32 +01001987 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001988
1989exit:
1990 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001991 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001992
Gilles Peskined7729582019-08-05 15:55:54 +02001993 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001994 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001995 return( status );
1996}
1997#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1998
Gilles Peskinef603c712019-01-19 13:40:11 +01001999static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002000 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002001{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002002 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002003 source->key.data,
2004 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002005 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002006 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002007
Steven Cooreman398aee52020-10-13 14:35:45 +02002008 target->attr.type = source->attr.type;
2009 target->attr.bits = source->attr.bits;
2010
2011 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002012}
2013
Ronald Croncf56a0a2020-08-04 09:51:30 +02002014psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002015 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002016 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002017{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002018 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002019 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002020 psa_key_slot_t *source_slot = NULL;
2021 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002022 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002023 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002024
Ronald Cron81709fc2020-11-14 12:10:32 +01002025 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2026
Ronald Cron5c522922020-11-14 16:35:34 +01002027 status = psa_get_and_lock_transparent_key_slot_with_policy(
2028 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002029 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002030 goto exit;
2031
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002032 status = psa_validate_optional_attributes( source_slot,
2033 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002034 if( status != PSA_SUCCESS )
2035 goto exit;
2036
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002037 status = psa_restrict_key_policy( source_slot->attr.type,
2038 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002039 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002040 if( status != PSA_SUCCESS )
2041 goto exit;
2042
Ronald Cron81709fc2020-11-14 12:10:32 +01002043 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2044 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002045 if( status != PSA_SUCCESS )
2046 goto exit;
2047
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002048#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2049 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002050 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002051 /* Copying to a secure element is not implemented yet. */
2052 status = PSA_ERROR_NOT_SUPPORTED;
2053 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002054 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002055#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002056
Ronald Cron6cc66312021-04-02 12:27:47 +02002057 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2058 {
2059 /*
2060 * Copying through an opaque driver is not implemented yet, consider
2061 * a lifetime with an external location as an invalid parameter for
2062 * now.
2063 */
2064 status = PSA_ERROR_INVALID_ARGUMENT;
2065 goto exit;
2066 }
2067
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002068 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002069 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002070 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002071
Ronald Cron81709fc2020-11-14 12:10:32 +01002072 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002073exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002074 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002075 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002076
Ronald Cron5c522922020-11-14 16:35:34 +01002077 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002078
Ronald Cron5c522922020-11-14 16:35:34 +01002079 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002080}
2081
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002082
2083
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002084/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002085/* Message digests */
2086/****************************************************************/
2087
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002088psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2089{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002090 /* Aborting a non-active operation is allowed */
2091 if( operation->id == 0 )
2092 return( PSA_SUCCESS );
2093
2094 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2095 operation->id = 0;
2096
2097 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002098}
2099
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002100psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002101 psa_algorithm_t alg )
2102{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002103 /* A context must be freshly initialized before it can be set up. */
2104 if( operation->id != 0 )
2105 return( PSA_ERROR_BAD_STATE );
2106
2107 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002108 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002109
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002110 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2111 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002112 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2113
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002114 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115}
2116
2117psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2118 const uint8_t *input,
2119 size_t input_length )
2120{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002121 if( operation->id == 0 )
2122 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002123
Steven Cooremanc8288352021-03-04 14:02:19 +01002124 /* Don't require hash implementations to behave correctly on a
2125 * zero-length input, which may have an invalid pointer. */
2126 if( input_length == 0 )
2127 return( PSA_SUCCESS );
2128
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002129 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2130 input, input_length );
2131 if( status != PSA_SUCCESS )
2132 psa_hash_abort( operation );
2133
2134 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002135}
2136
2137psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2138 uint8_t *hash,
2139 size_t hash_size,
2140 size_t *hash_length )
2141{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002142 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002143 if( operation->id == 0 )
2144 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002145
Steven Cooreman1e582352021-02-18 17:24:37 +01002146 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002147 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002148 psa_hash_abort( operation );
2149 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002150}
2151
Gilles Peskine2d277862018-06-18 15:41:12 +02002152psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2153 const uint8_t *hash,
2154 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155{
2156 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2157 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002158 psa_status_t status = psa_hash_finish(
2159 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002160 actual_hash, sizeof( actual_hash ),
2161 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002162 if( status != PSA_SUCCESS )
2163 return( status );
2164 if( actual_hash_length != hash_length )
2165 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002166 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167 return( PSA_ERROR_INVALID_SIGNATURE );
2168 return( PSA_SUCCESS );
2169}
2170
Gilles Peskine0a749c82019-11-28 19:33:58 +01002171psa_status_t psa_hash_compute( psa_algorithm_t alg,
2172 const uint8_t *input, size_t input_length,
2173 uint8_t *hash, size_t hash_size,
2174 size_t *hash_length )
2175{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002176 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002177 if( !PSA_ALG_IS_HASH( alg ) )
2178 return( PSA_ERROR_INVALID_ARGUMENT );
2179
Steven Cooreman1e582352021-02-18 17:24:37 +01002180 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2181 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002182}
2183
2184psa_status_t psa_hash_compare( psa_algorithm_t alg,
2185 const uint8_t *input, size_t input_length,
2186 const uint8_t *hash, size_t hash_length )
2187{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002188 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2189 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002190
2191 if( !PSA_ALG_IS_HASH( alg ) )
2192 return( PSA_ERROR_INVALID_ARGUMENT );
2193
Steven Cooreman1e582352021-02-18 17:24:37 +01002194 psa_status_t status = psa_driver_wrapper_hash_compute(
2195 alg, input, input_length,
2196 actual_hash, sizeof(actual_hash),
2197 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002198 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002199 return( status );
2200 if( actual_hash_length != hash_length )
2201 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002202 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002203 return( PSA_ERROR_INVALID_SIGNATURE );
2204 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002205}
2206
Gilles Peskineeb35d782019-01-22 17:56:16 +01002207psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2208 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002209{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002210 if( source_operation->id == 0 ||
2211 target_operation->id != 0 )
2212 {
2213 return( PSA_ERROR_BAD_STATE );
2214 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002215
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002216 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2217 target_operation );
2218 if( status != PSA_SUCCESS )
2219 psa_hash_abort( target_operation );
2220
2221 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002222}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002223
2224
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002225/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002226/* MAC */
2227/****************************************************************/
2228
Steven Cooremane6804192021-03-19 18:28:56 +01002229psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002230{
Steven Cooremane6804192021-03-19 18:28:56 +01002231 /* Aborting a non-active operation is allowed */
2232 if( operation->id == 0 )
2233 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002234
Steven Cooremane6804192021-03-19 18:28:56 +01002235 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002236 operation->mac_size = 0;
2237 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002238 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002239
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002240 return( status );
2241}
2242
Ronald Cron2dff3b22021-06-17 16:33:22 +02002243static psa_status_t psa_mac_finalize_alg_and_key_validation(
2244 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002245 const psa_key_attributes_t *attributes,
2246 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002247{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002248 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002249 psa_key_type_t key_type = psa_get_key_type( attributes );
2250 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002251
Ronald Cron28ea0502021-06-17 16:10:24 +02002252 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002253 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002254
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002255 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002256 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002257 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002258 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002259
Steven Cooremand1a68f12021-05-10 11:13:41 +02002260 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002261 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002262
Ronald Cron79bdd822021-06-17 16:46:44 +02002263 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002264 {
2265 /* A very short MAC is too short for security since it can be
2266 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2267 * so we make this our minimum, even though 32 bits is still
2268 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002269 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002270 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002271
Ronald Cron79bdd822021-06-17 16:46:44 +02002272 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2273 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002274 {
2275 /* It's impossible to "truncate" to a larger length than the full length
2276 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002277 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002278 }
2279
Ronald Cron79bdd822021-06-17 16:46:44 +02002280 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002281}
2282
2283static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2284 mbedtls_svc_key_id_t key,
2285 psa_algorithm_t alg,
2286 int is_sign )
2287{
2288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2289 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2290 psa_key_slot_t *slot;
2291
2292 /* A context must be freshly initialized before it can be set up. */
2293 if( operation->id != 0 )
2294 return( PSA_ERROR_BAD_STATE );
2295
2296 status = psa_get_and_lock_key_slot_with_policy(
2297 key,
2298 &slot,
2299 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2300 alg );
2301 if( status != PSA_SUCCESS )
2302 return( status );
2303
2304 psa_key_attributes_t attributes = {
2305 .core = slot->attr
2306 };
2307
Ronald Cron79bdd822021-06-17 16:46:44 +02002308 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2309 &operation->mac_size );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002310 if( status != PSA_SUCCESS )
2311 goto exit;
2312
2313 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002314 /* Dispatch the MAC setup call with validated input */
2315 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002316 {
Steven Cooremane6804192021-03-19 18:28:56 +01002317 status = psa_driver_wrapper_mac_sign_setup( operation,
Ronald Cron2dff3b22021-06-17 16:33:22 +02002318 &attributes,
Steven Cooremane6804192021-03-19 18:28:56 +01002319 slot->key.data,
2320 slot->key.bytes,
2321 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002322 }
2323 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002324 {
Steven Cooremane6804192021-03-19 18:28:56 +01002325 status = psa_driver_wrapper_mac_verify_setup( operation,
Ronald Cron2dff3b22021-06-17 16:33:22 +02002326 &attributes,
Steven Cooremane6804192021-03-19 18:28:56 +01002327 slot->key.data,
2328 slot->key.bytes,
2329 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002330 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002331
Gilles Peskinefbfac682018-07-08 20:51:54 +02002332exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002333 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002334 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002335
Ronald Cron5c522922020-11-14 16:35:34 +01002336 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002337
Ronald Cron5c522922020-11-14 16:35:34 +01002338 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002339}
2340
Gilles Peskine89167cb2018-07-08 20:12:23 +02002341psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002342 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002343 psa_algorithm_t alg )
2344{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002345 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002346}
2347
2348psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002349 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002350 psa_algorithm_t alg )
2351{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002352 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002353}
2354
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002355psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002356 const uint8_t *input,
2357 size_t input_length )
2358{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002359 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002360 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002362 /* Don't require hash implementations to behave correctly on a
2363 * zero-length input, which may have an invalid pointer. */
2364 if( input_length == 0 )
2365 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002366
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002367 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2368 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002369 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002370 psa_mac_abort( operation );
2371
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002372 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002373}
2374
Steven Cooremana5b860a2021-03-19 19:04:39 +01002375psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002376 uint8_t *mac,
2377 size_t mac_size,
2378 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002379{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002380 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2381 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002382
Steven Cooreman72f736a2021-05-07 14:14:37 +02002383 /* Set the output length and content to a safe default, such that in
2384 * case the caller misses an error check, the output would be an
2385 * unachievable MAC. */
2386 *mac_length = mac_size;
2387
Steven Cooremana5b860a2021-03-19 19:04:39 +01002388 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002389 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002390
Steven Cooreman72f736a2021-05-07 14:14:37 +02002391 if( ! operation->is_sign )
2392 return( PSA_ERROR_BAD_STATE );
2393
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002394 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2395 * once all the error checks are done. */
2396 if( operation->mac_size == 0 )
2397 return( PSA_ERROR_BAD_STATE );
2398
2399 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002400 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002401
Steven Cooremana5b860a2021-03-19 19:04:39 +01002402 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002403 mac, operation->mac_size,
2404 mac_length );
2405
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002406 /* In case of success, set the potential excess room in the output buffer
2407 * to an invalid value, to avoid potentially leaking a longer MAC.
2408 * In case of error, set the output length and content to a safe default,
2409 * such that in case the caller misses an error check, the output would be
2410 * an unachievable MAC.
2411 */
2412 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002413 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002414 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002415 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002416 }
mohammad16036df908f2018-04-02 08:34:15 -07002417
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002418 if( mac_size > operation->mac_size )
2419 memset( &mac[operation->mac_size], '!',
2420 mac_size - operation->mac_size );
2421
Steven Cooremana5b860a2021-03-19 19:04:39 +01002422 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002423
Steven Cooremana5b860a2021-03-19 19:04:39 +01002424 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002425}
2426
Steven Cooremana5b860a2021-03-19 19:04:39 +01002427psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002428 const uint8_t *mac,
2429 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002430{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002431 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2432 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002433
Steven Cooremana5b860a2021-03-19 19:04:39 +01002434 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002435 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002436
Steven Cooreman72f736a2021-05-07 14:14:37 +02002437 if( operation->is_sign )
2438 return( PSA_ERROR_BAD_STATE );
2439
2440 if( operation->mac_size != mac_length )
2441 {
2442 status = PSA_ERROR_INVALID_SIGNATURE;
2443 goto cleanup;
2444 }
2445
Steven Cooremana5b860a2021-03-19 19:04:39 +01002446 status = psa_driver_wrapper_mac_verify_finish( operation,
2447 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002448
2449cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002450 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002451
Steven Cooremana5b860a2021-03-19 19:04:39 +01002452 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002453}
2454
Ronald Croncd989b52021-06-18 14:23:33 +02002455static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2456 psa_algorithm_t alg,
2457 const uint8_t *input,
2458 size_t input_length,
2459 uint8_t *mac,
2460 size_t mac_size,
2461 size_t *mac_length,
2462 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002463{
2464 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002465 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2466 psa_key_slot_t *slot;
2467 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002468
Ronald Cron51131b52021-06-17 17:17:20 +02002469 status = psa_get_and_lock_key_slot_with_policy(
Ronald Croncd989b52021-06-18 14:23:33 +02002470 key, &slot,
2471 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2472 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002473 if( status != PSA_SUCCESS )
2474 goto exit;
2475
Ronald Cron51131b52021-06-17 17:17:20 +02002476 psa_key_attributes_t attributes = {
2477 .core = slot->attr
2478 };
2479
2480 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2481 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002482 if( status != PSA_SUCCESS )
2483 goto exit;
2484
Ronald Cron51131b52021-06-17 17:17:20 +02002485 if( mac_size < operation_mac_size )
2486 {
2487 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002488 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002489 }
2490
2491 status = psa_driver_wrapper_mac_compute(
2492 &attributes,
2493 slot->key.data, slot->key.bytes,
2494 alg,
2495 input, input_length,
2496 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002497
2498exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002499 /* In case of success, set the potential excess room in the output buffer
2500 * to an invalid value, to avoid potentially leaking a longer MAC.
2501 * In case of error, set the output length and content to a safe default,
2502 * such that in case the caller misses an error check, the output would be
2503 * an unachievable MAC.
2504 */
2505 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002506 {
Ronald Cron51131b52021-06-17 17:17:20 +02002507 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002508 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002509 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002510 if( mac_size > operation_mac_size )
2511 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002512
Ronald Cron51131b52021-06-17 17:17:20 +02002513 unlock_status = psa_unlock_key_slot( slot );
2514
2515 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002516}
2517
Ronald Croncd989b52021-06-18 14:23:33 +02002518psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2519 psa_algorithm_t alg,
2520 const uint8_t *input,
2521 size_t input_length,
2522 uint8_t *mac,
2523 size_t mac_size,
2524 size_t *mac_length)
2525{
2526 return( psa_mac_compute_internal( key, alg,
2527 input, input_length,
2528 mac, mac_size, mac_length, 1 ) );
2529}
2530
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002531psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2532 psa_algorithm_t alg,
2533 const uint8_t *input,
2534 size_t input_length,
2535 const uint8_t *mac,
2536 size_t mac_length)
2537{
2538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002539 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2540 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002541
Ronald Crona587cbc2021-06-18 14:51:29 +02002542 status = psa_mac_compute_internal( key, alg,
2543 input, input_length,
2544 actual_mac, sizeof( actual_mac ),
2545 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002546 if( status != PSA_SUCCESS )
2547 goto exit;
2548
Ronald Crona587cbc2021-06-18 14:51:29 +02002549 if( mac_length != actual_mac_length )
2550 {
2551 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002552 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002553 }
2554 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2555 {
2556 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002557 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002558 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002559
2560exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002561 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002562
2563 return ( status );
2564}
Gilles Peskine20035e32018-02-03 22:44:14 +01002565
Gilles Peskine20035e32018-02-03 22:44:14 +01002566/****************************************************************/
2567/* Asymmetric cryptography */
2568/****************************************************************/
2569
gabor-mezei-armf0486182021-05-12 11:03:09 +02002570static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002571 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002572{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002573 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002574 {
2575 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2576 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002577
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002578 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2579 {
2580 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2581 return( PSA_ERROR_INVALID_ARGUMENT );
2582 }
2583 }
2584 else
2585 {
2586 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2587 return( PSA_ERROR_INVALID_ARGUMENT );
2588 }
2589
2590 return( PSA_SUCCESS );
2591}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002592
2593static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002594 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002595 psa_algorithm_t alg,
2596 const uint8_t * input,
2597 size_t input_length,
2598 uint8_t * signature,
2599 size_t signature_size,
2600 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002601{
2602 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2603 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2604 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002605
2606 *signature_length = 0;
2607
gabor-mezei-armf0486182021-05-12 11:03:09 +02002608 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002609 if( status != PSA_SUCCESS )
2610 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002611
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002612 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002613 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002614 * buffer can in principle be empty since it doesn't actually have
2615 * to be a hash.) */
2616 if( signature_size == 0 )
2617 return( PSA_ERROR_BUFFER_TOO_SMALL );
2618
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002619 status = psa_get_and_lock_key_slot_with_policy(
2620 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002621 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2622 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002623 alg );
2624
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002625 if( status != PSA_SUCCESS )
2626 goto exit;
2627
2628 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2629 {
2630 status = PSA_ERROR_INVALID_ARGUMENT;
2631 goto exit;
2632 }
2633
2634 psa_key_attributes_t attributes = {
2635 .core = slot->attr
2636 };
2637
gabor-mezei-armf0486182021-05-12 11:03:09 +02002638 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002639 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002640 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002641 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002642 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002643 signature, signature_size, signature_length );
2644 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002645 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002646 {
2647
2648 status = psa_driver_wrapper_sign_hash(
2649 &attributes, slot->key.data, slot->key.bytes,
2650 alg, input, input_length,
2651 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002652 }
2653
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002654
2655exit:
2656 /* Fill the unused part of the output buffer (the whole buffer on error,
2657 * the trailing part on success) with something that isn't a valid signature
2658 * (barring an attack on the signature and deliberately-crafted input),
2659 * in case the caller doesn't check the return status properly. */
2660 if( status == PSA_SUCCESS )
2661 memset( signature + *signature_length, '!',
2662 signature_size - *signature_length );
2663 else
2664 memset( signature, '!', signature_size );
2665 /* If signature_size is 0 then we have nothing to do. We must not call
2666 * memset because signature may be NULL in this case. */
2667
2668 unlock_status = psa_unlock_key_slot( slot );
2669
2670 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2671}
2672
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002673static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002674 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002675 psa_algorithm_t alg,
2676 const uint8_t * input,
2677 size_t input_length,
2678 const uint8_t * signature,
2679 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002680{
2681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2682 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2683 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002684
gabor-mezei-armf0486182021-05-12 11:03:09 +02002685 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002686 if( status != PSA_SUCCESS )
2687 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002688
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002689 status = psa_get_and_lock_key_slot_with_policy(
2690 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002691 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2692 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002693 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002694
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002695 if( status != PSA_SUCCESS )
2696 return( status );
2697
2698 psa_key_attributes_t attributes = {
2699 .core = slot->attr
2700 };
2701
gabor-mezei-armf0486182021-05-12 11:03:09 +02002702 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002703 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002704 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002705 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002706 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002707 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002708 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002709 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002710 {
2711 status = psa_driver_wrapper_verify_hash(
2712 &attributes, slot->key.data, slot->key.bytes,
2713 alg, input, input_length,
2714 signature, signature_length );
2715 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002716
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002717 unlock_status = psa_unlock_key_slot( slot );
2718
2719 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002720
2721}
2722
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002723psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002724 const psa_key_attributes_t *attributes,
2725 const uint8_t *key_buffer,
2726 size_t key_buffer_size,
2727 psa_algorithm_t alg,
2728 const uint8_t *input,
2729 size_t input_length,
2730 uint8_t *signature,
2731 size_t signature_size,
2732 size_t *signature_length )
2733{
2734 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002735
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002736 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2737 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002738 size_t hash_length;
2739 uint8_t hash[PSA_HASH_MAX_SIZE];
2740
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002741 status = psa_driver_wrapper_hash_compute(
2742 PSA_ALG_SIGN_GET_HASH( alg ),
2743 input, input_length,
2744 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002745
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002746 if( status != PSA_SUCCESS )
2747 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002748
2749 return psa_driver_wrapper_sign_hash(
2750 attributes, key_buffer, key_buffer_size,
2751 alg, hash, hash_length,
2752 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002753 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002754
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002755 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002756}
2757
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002758psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2759 psa_algorithm_t alg,
2760 const uint8_t * input,
2761 size_t input_length,
2762 uint8_t * signature,
2763 size_t signature_size,
2764 size_t * signature_length )
2765{
2766 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002767 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002768 signature, signature_size, signature_length );
2769}
2770
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002771psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002772 const psa_key_attributes_t *attributes,
2773 const uint8_t *key_buffer,
2774 size_t key_buffer_size,
2775 psa_algorithm_t alg,
2776 const uint8_t *input,
2777 size_t input_length,
2778 const uint8_t *signature,
2779 size_t signature_length )
2780{
2781 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002782
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002783 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2784 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002785 size_t hash_length;
2786 uint8_t hash[PSA_HASH_MAX_SIZE];
2787
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002788 status = psa_driver_wrapper_hash_compute(
2789 PSA_ALG_SIGN_GET_HASH( alg ),
2790 input, input_length,
2791 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002792
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002793 if( status != PSA_SUCCESS )
2794 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002795
2796 return psa_driver_wrapper_verify_hash(
2797 attributes, key_buffer, key_buffer_size,
2798 alg, hash, hash_length,
2799 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002800 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002801
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002802 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002803}
2804
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002805psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2806 psa_algorithm_t alg,
2807 const uint8_t * input,
2808 size_t input_length,
2809 const uint8_t * signature,
2810 size_t signature_length )
2811{
2812 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002813 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002814 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002815}
2816
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002817psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002818 const psa_key_attributes_t *attributes,
2819 const uint8_t *key_buffer, size_t key_buffer_size,
2820 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2821 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002822{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002823 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002824 {
Ronald Cron4501c982021-03-19 20:09:32 +01002825 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2826 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002827 {
Ronald Cron4501c982021-03-19 20:09:32 +01002828#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2829 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2830 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002831 attributes,
2832 key_buffer, key_buffer_size,
2833 alg, hash, hash_length,
2834 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002835#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2836 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002837 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002838 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002839 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002840 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002841 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002842 }
2843 else
Ronald Cron4501c982021-03-19 20:09:32 +01002844 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2845 {
2846 if( PSA_ALG_IS_ECDSA( alg ) )
2847 {
2848#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2849 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2850 return( mbedtls_psa_ecdsa_sign_hash(
2851 attributes,
2852 key_buffer, key_buffer_size,
2853 alg, hash, hash_length,
2854 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002855#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2856 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002857 }
2858 else
2859 {
2860 return( PSA_ERROR_INVALID_ARGUMENT );
2861 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002862 }
Ronald Cron4501c982021-03-19 20:09:32 +01002863
2864 (void)key_buffer;
2865 (void)key_buffer_size;
2866 (void)hash;
2867 (void)hash_length;
2868 (void)signature;
2869 (void)signature_size;
2870 (void)signature_length;
2871
2872 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002873}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002874
2875psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2876 psa_algorithm_t alg,
2877 const uint8_t *hash,
2878 size_t hash_length,
2879 uint8_t *signature,
2880 size_t signature_size,
2881 size_t *signature_length )
2882{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002883 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002884 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002885 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002886}
2887
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002888psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002889 const psa_key_attributes_t *attributes,
2890 const uint8_t *key_buffer, size_t key_buffer_size,
2891 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2892 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002893{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002894 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002895 {
Ronald Cron4501c982021-03-19 20:09:32 +01002896 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2897 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002898 {
Ronald Cron4501c982021-03-19 20:09:32 +01002899#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2900 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2901 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002902 attributes,
2903 key_buffer, key_buffer_size,
2904 alg, hash, hash_length,
2905 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002906#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2907 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002908 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002909 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002910 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002911 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002912 }
itayzafrir5c753392018-05-08 11:18:38 +03002913 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002914 else
Ronald Cron4501c982021-03-19 20:09:32 +01002915 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002916 {
Ronald Cron4501c982021-03-19 20:09:32 +01002917 if( PSA_ALG_IS_ECDSA( alg ) )
2918 {
2919#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2920 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2921 return( mbedtls_psa_ecdsa_verify_hash(
2922 attributes,
2923 key_buffer, key_buffer_size,
2924 alg, hash, hash_length,
2925 signature, signature_length ) );
2926#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2927 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2928 }
2929 else
2930 {
2931 return( PSA_ERROR_INVALID_ARGUMENT );
2932 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002933 }
Ronald Cron4501c982021-03-19 20:09:32 +01002934
2935 (void)key_buffer;
2936 (void)key_buffer_size;
2937 (void)hash;
2938 (void)hash_length;
2939 (void)signature;
2940 (void)signature_length;
2941
2942 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002943}
2944
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002945psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2946 psa_algorithm_t alg,
2947 const uint8_t *hash,
2948 size_t hash_length,
2949 const uint8_t *signature,
2950 size_t signature_length )
2951{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002952 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002953 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002954 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002955}
2956
John Durkop0e005192020-10-31 22:06:54 -07002957#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002958static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2959 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002960{
2961 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2962 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2963 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02002964
2965 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02002966}
John Durkop0e005192020-10-31 22:06:54 -07002967#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002968
Ronald Croncf56a0a2020-08-04 09:51:30 +02002969psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002970 psa_algorithm_t alg,
2971 const uint8_t *input,
2972 size_t input_length,
2973 const uint8_t *salt,
2974 size_t salt_length,
2975 uint8_t *output,
2976 size_t output_size,
2977 size_t *output_length )
2978{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002979 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002980 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002981 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002982
Darryl Green5cc689a2018-07-24 15:34:10 +01002983 (void) input;
2984 (void) input_length;
2985 (void) salt;
2986 (void) output;
2987 (void) output_size;
2988
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002989 *output_length = 0;
2990
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002991 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2992 return( PSA_ERROR_INVALID_ARGUMENT );
2993
Ronald Cron5c522922020-11-14 16:35:34 +01002994 status = psa_get_and_lock_transparent_key_slot_with_policy(
2995 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002996 if( status != PSA_SUCCESS )
2997 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002998 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2999 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003000 {
3001 status = PSA_ERROR_INVALID_ARGUMENT;
3002 goto exit;
3003 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003004
John Durkop6ba40d12020-11-10 08:50:04 -08003005#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3006 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003007 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003008 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003009 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003010 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3011 slot->key.data,
3012 slot->key.bytes,
3013 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003014 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003015 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003016
3017 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003018 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003019 status = PSA_ERROR_BUFFER_TOO_SMALL;
3020 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003021 }
John Durkop0e005192020-10-31 22:06:54 -07003022#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003023 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3024 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003025 status = mbedtls_to_psa_error(
3026 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003027 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003028 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003029 input_length,
3030 input,
3031 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003032 }
3033 else
John Durkop0e005192020-10-31 22:06:54 -07003034#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3035#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003036 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3037 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003038 status = mbedtls_to_psa_error(
3039 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3040 if( status != PSA_SUCCESS )
3041 goto rsa_exit;
3042
Steven Cooreman4fed4552020-08-03 14:46:03 +02003043 status = mbedtls_to_psa_error(
3044 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003045 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003046 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003047 salt, salt_length,
3048 input_length,
3049 input,
3050 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003051 }
3052 else
John Durkop0e005192020-10-31 22:06:54 -07003053#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003054 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003055 status = PSA_ERROR_INVALID_ARGUMENT;
3056 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003057 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003058rsa_exit:
3059 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003060 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003061
Steven Cooremana2371e52020-07-28 14:30:39 +02003062 mbedtls_rsa_free( rsa );
3063 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003064 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003065 else
John Durkop9814fa22020-11-04 12:28:15 -08003066#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003067 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003068 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003069 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003070 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003071
3072exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003073 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003074
Ronald Cron5c522922020-11-14 16:35:34 +01003075 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003076}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003077
Ronald Croncf56a0a2020-08-04 09:51:30 +02003078psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003079 psa_algorithm_t alg,
3080 const uint8_t *input,
3081 size_t input_length,
3082 const uint8_t *salt,
3083 size_t salt_length,
3084 uint8_t *output,
3085 size_t output_size,
3086 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003087{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003088 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003089 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003090 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003091
Darryl Green5cc689a2018-07-24 15:34:10 +01003092 (void) input;
3093 (void) input_length;
3094 (void) salt;
3095 (void) output;
3096 (void) output_size;
3097
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003098 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003099
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003100 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3101 return( PSA_ERROR_INVALID_ARGUMENT );
3102
Ronald Cron5c522922020-11-14 16:35:34 +01003103 status = psa_get_and_lock_transparent_key_slot_with_policy(
3104 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003105 if( status != PSA_SUCCESS )
3106 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003107 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003108 {
3109 status = PSA_ERROR_INVALID_ARGUMENT;
3110 goto exit;
3111 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003112
John Durkop6ba40d12020-11-10 08:50:04 -08003113#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3114 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003115 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003116 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003117 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003118 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3119 slot->key.data,
3120 slot->key.bytes,
3121 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003122 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003123 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003124
Steven Cooremana2371e52020-07-28 14:30:39 +02003125 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003126 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003127 status = PSA_ERROR_INVALID_ARGUMENT;
3128 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003129 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003130
John Durkop0e005192020-10-31 22:06:54 -07003131#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003132 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003134 status = mbedtls_to_psa_error(
3135 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003136 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003137 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003138 output_length,
3139 input,
3140 output,
3141 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003142 }
3143 else
John Durkop0e005192020-10-31 22:06:54 -07003144#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3145#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003146 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003147 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003148 status = mbedtls_to_psa_error(
3149 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3150 if( status != PSA_SUCCESS )
3151 goto rsa_exit;
3152
Steven Cooreman4fed4552020-08-03 14:46:03 +02003153 status = mbedtls_to_psa_error(
3154 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003155 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003156 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003157 salt, salt_length,
3158 output_length,
3159 input,
3160 output,
3161 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162 }
3163 else
John Durkop0e005192020-10-31 22:06:54 -07003164#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003165 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003166 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003167 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003168
Steven Cooreman4fed4552020-08-03 14:46:03 +02003169rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003170 mbedtls_rsa_free( rsa );
3171 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003172 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003173 else
John Durkop6ba40d12020-11-10 08:50:04 -08003174#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3175 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003176 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003177 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003178 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003179
3180exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003181 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003182
Ronald Cron5c522922020-11-14 16:35:34 +01003183 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003184}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003185
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003186
3187
mohammad1603503973b2018-03-12 15:59:30 +02003188/****************************************************************/
3189/* Symmetric cryptography */
3190/****************************************************************/
3191
Ronald Cronab99ac22020-10-01 16:38:28 +02003192static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3193 mbedtls_svc_key_id_t key,
3194 psa_algorithm_t alg,
3195 mbedtls_operation_t cipher_operation )
3196{
3197 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3198 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3199 psa_key_slot_t *slot;
3200 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3201 PSA_KEY_USAGE_ENCRYPT :
3202 PSA_KEY_USAGE_DECRYPT );
3203
3204 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003205 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003206 return( PSA_ERROR_BAD_STATE );
3207
3208 /* The requested algorithm must be one that can be processed by cipher. */
3209 if( ! PSA_ALG_IS_CIPHER( alg ) )
3210 return( PSA_ERROR_INVALID_ARGUMENT );
3211
3212 /* Fetch key material from key storage. */
3213 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3214 if( status != PSA_SUCCESS )
3215 goto exit;
3216
Ronald Cron49fafa92021-03-10 08:34:23 +01003217 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003218 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003219 * so we only set it (in the driver wrapper) after resources have been
3220 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003221 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003222 if( alg == PSA_ALG_ECB_NO_PADDING )
3223 operation->iv_required = 0;
3224 else
3225 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003226 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003227
Ronald Crona4af55f2020-12-14 14:36:06 +01003228 psa_key_attributes_t attributes = {
3229 .core = slot->attr
3230 };
3231
Ronald Cronab99ac22020-10-01 16:38:28 +02003232 /* Try doing the operation through a driver before using software fallback. */
3233 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003234 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3235 &attributes,
3236 slot->key.data,
3237 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003238 alg );
3239 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003240 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3241 &attributes,
3242 slot->key.data,
3243 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003244 alg );
3245
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003246exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003247 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003248 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003249
Ronald Cron5c522922020-11-14 16:35:34 +01003250 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003251
Ronald Cron5c522922020-11-14 16:35:34 +01003252 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003253}
3254
Gilles Peskinefe119512018-07-08 21:39:34 +02003255psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003256 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003257 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003258{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003259 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003260}
3261
Gilles Peskinefe119512018-07-08 21:39:34 +02003262psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003263 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003264 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003265{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003266 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003267}
3268
Gilles Peskinefe119512018-07-08 21:39:34 +02003269psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003270 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003271 size_t iv_size,
3272 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003273{
Ronald Cron6d051732020-10-01 14:10:20 +02003274 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003275
Ronald Cron5618a392021-03-26 09:52:26 +01003276 *iv_length = 0;
3277
Ronald Cron49fafa92021-03-10 08:34:23 +01003278 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003279 {
3280 return( PSA_ERROR_BAD_STATE );
3281 }
3282
Steven Cooreman7df02922020-09-09 15:28:49 +02003283 if( operation->iv_set || ! operation->iv_required )
3284 {
3285 return( PSA_ERROR_BAD_STATE );
3286 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003287
Ronald Cron5618a392021-03-26 09:52:26 +01003288 if( iv_size < operation->default_iv_length )
3289 {
3290 status = PSA_ERROR_BUFFER_TOO_SMALL;
3291 goto exit;
3292 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003293
Ronald Cron5618a392021-03-26 09:52:26 +01003294 status = psa_generate_random( iv, operation->default_iv_length );
3295 if( status != PSA_SUCCESS )
3296 goto exit;
3297
3298 status = psa_driver_wrapper_cipher_set_iv( operation,
3299 iv,
3300 operation->default_iv_length );
3301
3302exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003303 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003304 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003305 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003306 *iv_length = operation->default_iv_length;
3307 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003308 else
Moran Peker395db872018-05-31 14:07:14 +03003309 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003310
itayzafrir534bd7c2018-08-02 13:56:32 +03003311 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003312}
3313
Gilles Peskinefe119512018-07-08 21:39:34 +02003314psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003315 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003316 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003317{
Ronald Cron6d051732020-10-01 14:10:20 +02003318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003319
Ronald Cron49fafa92021-03-10 08:34:23 +01003320 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003321 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003322
Steven Cooreman7df02922020-09-09 15:28:49 +02003323 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003324 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003325
3326 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3327 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003328
Ronald Crondd24c9b2020-12-15 14:10:01 +01003329 status = psa_driver_wrapper_cipher_set_iv( operation,
3330 iv,
3331 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003332
itayzafrir534bd7c2018-08-02 13:56:32 +03003333 if( status == PSA_SUCCESS )
3334 operation->iv_set = 1;
3335 else
mohammad1603503973b2018-03-12 15:59:30 +02003336 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003337 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003338}
3339
Gilles Peskinee553c652018-06-04 16:22:46 +02003340psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3341 const uint8_t *input,
3342 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003343 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003344 size_t output_size,
3345 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003346{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003348
Ronald Cron49fafa92021-03-10 08:34:23 +01003349 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003350 {
3351 return( PSA_ERROR_BAD_STATE );
3352 }
3353 if( operation->iv_required && ! operation->iv_set )
3354 {
3355 return( PSA_ERROR_BAD_STATE );
3356 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003357
Ronald Crondd24c9b2020-12-15 14:10:01 +01003358 status = psa_driver_wrapper_cipher_update( operation,
3359 input,
3360 input_length,
3361 output,
3362 output_size,
3363 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003364 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003365 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003366
itayzafrir534bd7c2018-08-02 13:56:32 +03003367 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003368}
3369
Gilles Peskinee553c652018-06-04 16:22:46 +02003370psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3371 uint8_t *output,
3372 size_t output_size,
3373 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003374{
David Saadab4ecc272019-02-14 13:48:10 +02003375 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003376
Ronald Cron49fafa92021-03-10 08:34:23 +01003377 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003378 {
3379 return( PSA_ERROR_BAD_STATE );
3380 }
3381 if( operation->iv_required && ! operation->iv_set )
3382 {
3383 return( PSA_ERROR_BAD_STATE );
3384 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003385
Ronald Crondd24c9b2020-12-15 14:10:01 +01003386 status = psa_driver_wrapper_cipher_finish( operation,
3387 output,
3388 output_size,
3389 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003390 if( status == PSA_SUCCESS )
3391 return( psa_cipher_abort( operation ) );
3392 else
3393 {
3394 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003395 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003396
Steven Cooremanef8575e2020-09-11 11:44:50 +02003397 return( status );
3398 }
mohammad1603503973b2018-03-12 15:59:30 +02003399}
3400
Gilles Peskinee553c652018-06-04 16:22:46 +02003401psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3402{
Ronald Cron49fafa92021-03-10 08:34:23 +01003403 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003404 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003405 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003406 * in use. It's ok to call abort on such an object, and there's
3407 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003408 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003409 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003410
Ronald Crondd24c9b2020-12-15 14:10:01 +01003411 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003412
Ronald Cron49fafa92021-03-10 08:34:23 +01003413 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003414 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003415 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003416
Moran Peker395db872018-05-31 14:07:14 +03003417 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003418}
3419
mohammad16035955c982018-04-26 00:53:03 +03003420/****************************************************************/
3421/* AEAD */
3422/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003423
Ronald Croncf56a0a2020-08-04 09:51:30 +02003424psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003425 psa_algorithm_t alg,
3426 const uint8_t *nonce,
3427 size_t nonce_length,
3428 const uint8_t *additional_data,
3429 size_t additional_data_length,
3430 const uint8_t *plaintext,
3431 size_t plaintext_length,
3432 uint8_t *ciphertext,
3433 size_t ciphertext_size,
3434 size_t *ciphertext_length )
3435{
Ronald Cron215633c2021-03-16 17:15:37 +01003436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3437 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003438
mohammad1603f08a5502018-06-03 15:05:47 +03003439 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003440
Steven Cooremanea7ab132021-03-17 16:28:00 +01003441 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3442 return( PSA_ERROR_NOT_SUPPORTED );
3443
Ronald Cron9a986162021-03-26 12:40:07 +01003444 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003445 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003446 if( status != PSA_SUCCESS )
3447 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003448
Ronald Cron215633c2021-03-16 17:15:37 +01003449 psa_key_attributes_t attributes = {
3450 .core = slot->attr
3451 };
mohammad16035955c982018-04-26 00:53:03 +03003452
Ronald Cronde822812021-03-17 16:08:20 +01003453 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003454 &attributes, slot->key.data, slot->key.bytes,
3455 alg,
3456 nonce, nonce_length,
3457 additional_data, additional_data_length,
3458 plaintext, plaintext_length,
3459 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003460
Gilles Peskineedf9a652018-08-17 18:11:56 +02003461 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3462 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003463
Ronald Cron9f310172021-03-16 16:36:37 +01003464 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003465
mohammad16035955c982018-04-26 00:53:03 +03003466 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003467}
3468
Ronald Croncf56a0a2020-08-04 09:51:30 +02003469psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003470 psa_algorithm_t alg,
3471 const uint8_t *nonce,
3472 size_t nonce_length,
3473 const uint8_t *additional_data,
3474 size_t additional_data_length,
3475 const uint8_t *ciphertext,
3476 size_t ciphertext_length,
3477 uint8_t *plaintext,
3478 size_t plaintext_size,
3479 size_t *plaintext_length )
3480{
Ronald Cron215633c2021-03-16 17:15:37 +01003481 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3482 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003483
Gilles Peskineee652a32018-06-01 19:23:52 +02003484 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003485
Steven Cooremanea7ab132021-03-17 16:28:00 +01003486 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3487 return( PSA_ERROR_NOT_SUPPORTED );
3488
Ronald Cron9a986162021-03-26 12:40:07 +01003489 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003490 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003491 if( status != PSA_SUCCESS )
3492 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003493
Ronald Cron215633c2021-03-16 17:15:37 +01003494 psa_key_attributes_t attributes = {
3495 .core = slot->attr
3496 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003497
Ronald Cronde822812021-03-17 16:08:20 +01003498 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003499 &attributes, slot->key.data, slot->key.bytes,
3500 alg,
3501 nonce, nonce_length,
3502 additional_data, additional_data_length,
3503 ciphertext, ciphertext_length,
3504 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003505
Gilles Peskineedf9a652018-08-17 18:11:56 +02003506 if( status != PSA_SUCCESS && plaintext_size != 0 )
3507 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003508
Ronald Cron215633c2021-03-16 17:15:37 +01003509 psa_unlock_key_slot( slot );
3510
Gilles Peskineedf9a652018-08-17 18:11:56 +02003511 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003512}
3513
Gilles Peskinee59236f2018-01-27 23:32:46 +01003514/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003515/* Generators */
3516/****************************************************************/
3517
John Durkop07cc04a2020-11-16 22:08:34 -08003518#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3519 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3520 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3521#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003522#endif /* At least one builtin KDF */
3523
3524#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3525 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3526 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3527static psa_status_t psa_key_derivation_start_hmac(
3528 psa_mac_operation_t *operation,
3529 psa_algorithm_t hash_alg,
3530 const uint8_t *hmac_key,
3531 size_t hmac_key_length )
3532{
3533 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3534 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3535 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3536 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3537 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3538
Steven Cooreman72f736a2021-05-07 14:14:37 +02003539 operation->is_sign = 1;
3540 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3541
Steven Cooreman094a77e2021-05-06 17:58:36 +02003542 status = psa_driver_wrapper_mac_sign_setup( operation,
3543 &attributes,
3544 hmac_key, hmac_key_length,
3545 PSA_ALG_HMAC( hash_alg ) );
3546
3547 psa_reset_key_attributes( &attributes );
3548 return( status );
3549}
3550#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003551
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003552#define HKDF_STATE_INIT 0 /* no input yet */
3553#define HKDF_STATE_STARTED 1 /* got salt */
3554#define HKDF_STATE_KEYED 2 /* got key */
3555#define HKDF_STATE_OUTPUT 3 /* output started */
3556
Gilles Peskinecbe66502019-05-16 16:59:18 +02003557static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003558 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003559{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003560 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3561 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003562 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003563 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003564}
3565
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003566psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003567{
3568 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003569 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003570 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003571 {
3572 /* The object has (apparently) been initialized but it is not
3573 * in use. It's ok to call abort on such an object, and there's
3574 * nothing to do. */
3575 }
3576 else
John Durkopd0321952020-10-29 21:37:36 -07003577#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003578 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003579 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003580 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003581 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003582 }
John Durkop07cc04a2020-11-16 22:08:34 -08003583 else
3584#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3585#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3586 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3587 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003588 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003589 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003590 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003591 if( operation->ctx.tls12_prf.secret != NULL )
3592 {
3593 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3594 operation->ctx.tls12_prf.secret_length );
3595 mbedtls_free( operation->ctx.tls12_prf.secret );
3596 }
3597
Janos Follath6a1d2622019-06-11 10:37:28 +01003598 if( operation->ctx.tls12_prf.seed != NULL )
3599 {
3600 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3601 operation->ctx.tls12_prf.seed_length );
3602 mbedtls_free( operation->ctx.tls12_prf.seed );
3603 }
3604
3605 if( operation->ctx.tls12_prf.label != NULL )
3606 {
3607 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3608 operation->ctx.tls12_prf.label_length );
3609 mbedtls_free( operation->ctx.tls12_prf.label );
3610 }
3611
Steven Cooremana6df6042021-04-29 19:32:25 +02003612 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003613
3614 /* We leave the fields Ai and output_block to be erased safely by the
3615 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003616 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003617 else
John Durkop07cc04a2020-11-16 22:08:34 -08003618#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3619 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003620 {
3621 status = PSA_ERROR_BAD_STATE;
3622 }
Janos Follath083036a2019-06-11 10:22:26 +01003623 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003624 return( status );
3625}
3626
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003627psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003628 size_t *capacity)
3629{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003630 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003631 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003632 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003633 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003634 }
3635
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003636 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003637 return( PSA_SUCCESS );
3638}
3639
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003640psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003641 size_t capacity )
3642{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003643 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003644 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003645 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003646 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003647 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003648 return( PSA_SUCCESS );
3649}
3650
John Durkopd0321952020-10-29 21:37:36 -07003651#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003652/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003653 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003654static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003655 psa_algorithm_t hash_alg,
3656 uint8_t *output,
3657 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003658{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003659 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003660 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003661 psa_status_t status;
3662
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003663 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3664 return( PSA_ERROR_BAD_STATE );
3665 hkdf->state = HKDF_STATE_OUTPUT;
3666
Gilles Peskinebef7f142018-07-12 17:22:21 +02003667 while( output_length != 0 )
3668 {
3669 /* Copy what remains of the current block */
3670 uint8_t n = hash_length - hkdf->offset_in_block;
3671 if( n > output_length )
3672 n = (uint8_t) output_length;
3673 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3674 output += n;
3675 output_length -= n;
3676 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003677 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003678 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003679 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003680 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003681 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003682 * object was corrupted or if this function is called directly
3683 * inside the library. */
3684 if( hkdf->block_number == 0xff )
3685 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003686
3687 /* We need a new block */
3688 ++hkdf->block_number;
3689 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003690
Steven Cooreman094a77e2021-05-06 17:58:36 +02003691 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3692 hash_alg,
3693 hkdf->prk,
3694 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003695 if( status != PSA_SUCCESS )
3696 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003697
Gilles Peskinebef7f142018-07-12 17:22:21 +02003698 if( hkdf->block_number != 1 )
3699 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003700 status = psa_mac_update( &hkdf->hmac,
3701 hkdf->output_block,
3702 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003703 if( status != PSA_SUCCESS )
3704 return( status );
3705 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003706 status = psa_mac_update( &hkdf->hmac,
3707 hkdf->info,
3708 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003709 if( status != PSA_SUCCESS )
3710 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003711 status = psa_mac_update( &hkdf->hmac,
3712 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003713 if( status != PSA_SUCCESS )
3714 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003715 status = psa_mac_sign_finish( &hkdf->hmac,
3716 hkdf->output_block,
3717 sizeof( hkdf->output_block ),
3718 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003719 if( status != PSA_SUCCESS )
3720 return( status );
3721 }
3722
3723 return( PSA_SUCCESS );
3724}
John Durkop07cc04a2020-11-16 22:08:34 -08003725#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003726
John Durkop07cc04a2020-11-16 22:08:34 -08003727#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3728 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003729static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3730 psa_tls12_prf_key_derivation_t *tls12_prf,
3731 psa_algorithm_t alg )
3732{
3733 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003734 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003735 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3736 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003737 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003738
Janos Follath7742fee2019-06-17 12:58:10 +01003739 /* We can't be wanting more output after block 0xff, otherwise
3740 * the capacity check in psa_key_derivation_output_bytes() would have
3741 * prevented this call. It could happen only if the operation
3742 * object was corrupted or if this function is called directly
3743 * inside the library. */
3744 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003745 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003746
3747 /* We need a new block */
3748 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003749 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003750
3751 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3752 *
3753 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3754 *
3755 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3756 * HMAC_hash(secret, A(2) + seed) +
3757 * HMAC_hash(secret, A(3) + seed) + ...
3758 *
3759 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003760 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003761 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003762 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003763 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003764 * is currently extracted as `output_block` and where i is
3765 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003766 */
3767
Steven Cooreman094a77e2021-05-06 17:58:36 +02003768 status = psa_key_derivation_start_hmac( &hmac,
3769 hash_alg,
3770 tls12_prf->secret,
3771 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003772 if( status != PSA_SUCCESS )
3773 goto cleanup;
3774
3775 /* Calculate A(i) where i = tls12_prf->block_number. */
3776 if( tls12_prf->block_number == 1 )
3777 {
3778 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3779 * the variable seed and in this instance means it in the context of the
3780 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003781 status = psa_mac_update( &hmac,
3782 tls12_prf->label,
3783 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003784 if( status != PSA_SUCCESS )
3785 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003786 status = psa_mac_update( &hmac,
3787 tls12_prf->seed,
3788 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003789 if( status != PSA_SUCCESS )
3790 goto cleanup;
3791 }
3792 else
3793 {
3794 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003795 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003796 if( status != PSA_SUCCESS )
3797 goto cleanup;
3798 }
3799
Steven Cooremana6df6042021-04-29 19:32:25 +02003800 status = psa_mac_sign_finish( &hmac,
3801 tls12_prf->Ai, hash_length,
3802 &hmac_output_length );
3803 if( hmac_output_length != hash_length )
3804 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003805 if( status != PSA_SUCCESS )
3806 goto cleanup;
3807
3808 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003809 status = psa_key_derivation_start_hmac( &hmac,
3810 hash_alg,
3811 tls12_prf->secret,
3812 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003813 if( status != PSA_SUCCESS )
3814 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003815 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003816 if( status != PSA_SUCCESS )
3817 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003818 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003819 if( status != PSA_SUCCESS )
3820 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003821 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003822 if( status != PSA_SUCCESS )
3823 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003824 status = psa_mac_sign_finish( &hmac,
3825 tls12_prf->output_block, hash_length,
3826 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003827 if( status != PSA_SUCCESS )
3828 goto cleanup;
3829
Janos Follath7742fee2019-06-17 12:58:10 +01003830
3831cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003832 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003833 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3834 status = cleanup_status;
3835
3836 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003837}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003838
Janos Follath844eb0e2019-06-19 12:10:49 +01003839static psa_status_t psa_key_derivation_tls12_prf_read(
3840 psa_tls12_prf_key_derivation_t *tls12_prf,
3841 psa_algorithm_t alg,
3842 uint8_t *output,
3843 size_t output_length )
3844{
3845 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003846 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003847 psa_status_t status;
3848 uint8_t offset, length;
3849
3850 while( output_length != 0 )
3851 {
3852 /* Check if we have fully processed the current block. */
3853 if( tls12_prf->left_in_block == 0 )
3854 {
3855 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3856 alg );
3857 if( status != PSA_SUCCESS )
3858 return( status );
3859
3860 continue;
3861 }
3862
3863 if( tls12_prf->left_in_block > output_length )
3864 length = (uint8_t) output_length;
3865 else
3866 length = tls12_prf->left_in_block;
3867
3868 offset = hash_length - tls12_prf->left_in_block;
3869 memcpy( output, tls12_prf->output_block + offset, length );
3870 output += length;
3871 output_length -= length;
3872 tls12_prf->left_in_block -= length;
3873 }
3874
3875 return( PSA_SUCCESS );
3876}
John Durkop07cc04a2020-11-16 22:08:34 -08003877#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3878 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003879
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003880psa_status_t psa_key_derivation_output_bytes(
3881 psa_key_derivation_operation_t *operation,
3882 uint8_t *output,
3883 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003884{
3885 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003886 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003887
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003888 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003889 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003890 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003891 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003892 }
3893
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003894 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003895 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003896 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003897 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003898 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003899 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003900 goto exit;
3901 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003902 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003903 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003904 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003905 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003906 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3907 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003908 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003909 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003910 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003911 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003912 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003913
John Durkopd0321952020-10-29 21:37:36 -07003914#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003915 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003916 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003917 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003918 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003919 output, output_length );
3920 }
Janos Follathadbec812019-06-14 11:05:39 +01003921 else
John Durkop07cc04a2020-11-16 22:08:34 -08003922#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3923#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3924 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003925 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003926 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003927 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003928 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02003929 kdf_alg, output,
3930 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003931 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003932 else
John Durkop07cc04a2020-11-16 22:08:34 -08003933#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3934 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003935 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003936 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003937 return( PSA_ERROR_BAD_STATE );
3938 }
3939
3940exit:
3941 if( status != PSA_SUCCESS )
3942 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003943 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003944 * This allows us to differentiate between exhausted operations and
3945 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3946 * operations. */
3947 psa_algorithm_t alg = operation->alg;
3948 psa_key_derivation_abort( operation );
3949 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003950 memset( output, '!', output_length );
3951 }
3952 return( status );
3953}
3954
David Brown7807bf72021-02-09 16:28:23 -07003955#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003956static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3957{
3958 if( data_size >= 8 )
3959 mbedtls_des_key_set_parity( data );
3960 if( data_size >= 16 )
3961 mbedtls_des_key_set_parity( data + 8 );
3962 if( data_size >= 24 )
3963 mbedtls_des_key_set_parity( data + 16 );
3964}
David Brown7807bf72021-02-09 16:28:23 -07003965#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003966
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003967static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003968 psa_key_slot_t *slot,
3969 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003970 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003971{
3972 uint8_t *data = NULL;
3973 size_t bytes = PSA_BITS_TO_BYTES( bits );
3974 psa_status_t status;
3975
Gilles Peskine8e338702019-07-30 20:06:31 +02003976 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003977 return( PSA_ERROR_INVALID_ARGUMENT );
3978 if( bits % 8 != 0 )
3979 return( PSA_ERROR_INVALID_ARGUMENT );
3980 data = mbedtls_calloc( 1, bytes );
3981 if( data == NULL )
3982 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3983
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003984 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003985 if( status != PSA_SUCCESS )
3986 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003987#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003988 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003989 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003990#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003991
3992 status = psa_allocate_buffer_to_slot( slot, bytes );
3993 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00003994 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01003995
Ronald Cronbf33c932020-11-28 18:06:53 +01003996 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01003997 psa_key_attributes_t attributes = {
3998 .core = slot->attr
3999 };
4000
Ronald Cronbf33c932020-11-28 18:06:53 +01004001 status = psa_driver_wrapper_import_key( &attributes,
4002 data, bytes,
4003 slot->key.data,
4004 slot->key.bytes,
4005 &slot->key.bytes, &bits );
4006 if( bits != slot->attr.bits )
4007 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004008
4009exit:
4010 mbedtls_free( data );
4011 return( status );
4012}
4013
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004014psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004015 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004016 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004017{
4018 psa_status_t status;
4019 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004020 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004021
Ronald Cron81709fc2020-11-14 12:10:32 +01004022 *key = MBEDTLS_SVC_KEY_ID_INIT;
4023
Gilles Peskine0f84d622019-09-12 19:03:13 +02004024 /* Reject any attempt to create a zero-length key so that we don't
4025 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4026 if( psa_get_key_bits( attributes ) == 0 )
4027 return( PSA_ERROR_INVALID_ARGUMENT );
4028
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004029 if( ! operation->can_output_key )
4030 return( PSA_ERROR_NOT_PERMITTED );
4031
Ronald Cron81709fc2020-11-14 12:10:32 +01004032 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4033 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004034#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4035 if( driver != NULL )
4036 {
4037 /* Deriving a key in a secure element is not implemented yet. */
4038 status = PSA_ERROR_NOT_SUPPORTED;
4039 }
4040#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004041 if( status == PSA_SUCCESS )
4042 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004043 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004044 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004045 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004046 }
4047 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004048 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004049 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004050 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004051
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004052 return( status );
4053}
4054
Gilles Peskineeab56e42018-07-12 17:12:33 +02004055
4056
4057/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004058/* Key derivation */
4059/****************************************************************/
4060
Steven Cooreman932ffb72021-02-15 12:14:32 +01004061#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004062static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004063 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004064 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004065{
John Durkop07cc04a2020-11-16 22:08:34 -08004066 int is_kdf_alg_supported;
4067
Janos Follath5fe19732019-06-20 15:09:30 +01004068 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4069 * initialisers for this union leave some bytes unspecified.) */
4070 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4071
Gilles Peskine969c5d62019-01-16 15:53:06 +01004072 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004073#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004074 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4075 is_kdf_alg_supported = 1;
4076 else
4077#endif
4078#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4079 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4080 is_kdf_alg_supported = 1;
4081 else
4082#endif
4083#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4084 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4085 is_kdf_alg_supported = 1;
4086 else
4087#endif
4088 is_kdf_alg_supported = 0;
4089
4090 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004091 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004092 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004093 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004094 if( hash_size == 0 )
4095 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004096 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4097 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004098 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004099 {
4100 return( PSA_ERROR_NOT_SUPPORTED );
4101 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004102 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004103 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004104 }
John Durkop07cc04a2020-11-16 22:08:34 -08004105
4106 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004107}
John Durkop07cc04a2020-11-16 22:08:34 -08004108#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004109
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004110psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004111 psa_algorithm_t alg )
4112{
4113 psa_status_t status;
4114
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004115 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004116 return( PSA_ERROR_BAD_STATE );
4117
Gilles Peskine6843c292019-01-18 16:44:49 +01004118 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4119 return( PSA_ERROR_INVALID_ARGUMENT );
4120 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004121 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004122#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004123 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004124 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004125#else
4126 return( PSA_ERROR_NOT_SUPPORTED );
4127#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004128 }
4129 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4130 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004131#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004132 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004133#else
4134 return( PSA_ERROR_NOT_SUPPORTED );
4135#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004136 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004137 else
4138 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004139
4140 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004141 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004142 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004143}
4144
John Durkopd0321952020-10-29 21:37:36 -07004145#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004146static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004147 psa_algorithm_t hash_alg,
4148 psa_key_derivation_step_t step,
4149 const uint8_t *data,
4150 size_t data_length )
4151{
4152 psa_status_t status;
4153 switch( step )
4154 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004155 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004156 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004157 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004158 else
4159 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004160 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4161 hash_alg,
4162 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004163 if( status != PSA_SUCCESS )
4164 return( status );
4165 hkdf->state = HKDF_STATE_STARTED;
4166 return( PSA_SUCCESS );
4167 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004168 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004169 /* If no salt was provided, use an empty salt. */
4170 if( hkdf->state == HKDF_STATE_INIT )
4171 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004172 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4173 hash_alg,
4174 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004175 if( status != PSA_SUCCESS )
4176 return( status );
4177 hkdf->state = HKDF_STATE_STARTED;
4178 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004179 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004180 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004181 status = psa_mac_update( &hkdf->hmac,
4182 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004183 if( status != PSA_SUCCESS )
4184 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004185 status = psa_mac_sign_finish( &hkdf->hmac,
4186 hkdf->prk,
4187 sizeof( hkdf->prk ),
4188 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004189 if( status != PSA_SUCCESS )
4190 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004191 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004192 hkdf->block_number = 0;
4193 hkdf->state = HKDF_STATE_KEYED;
4194 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004195 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004196 if( hkdf->state == HKDF_STATE_OUTPUT )
4197 return( PSA_ERROR_BAD_STATE );
4198 if( hkdf->info_set )
4199 return( PSA_ERROR_BAD_STATE );
4200 hkdf->info_length = data_length;
4201 if( data_length != 0 )
4202 {
4203 hkdf->info = mbedtls_calloc( 1, data_length );
4204 if( hkdf->info == NULL )
4205 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4206 memcpy( hkdf->info, data, data_length );
4207 }
4208 hkdf->info_set = 1;
4209 return( PSA_SUCCESS );
4210 default:
4211 return( PSA_ERROR_INVALID_ARGUMENT );
4212 }
4213}
John Durkop07cc04a2020-11-16 22:08:34 -08004214#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004215
John Durkop07cc04a2020-11-16 22:08:34 -08004216#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4217 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004218static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4219 const uint8_t *data,
4220 size_t data_length )
4221{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004222 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004223 return( PSA_ERROR_BAD_STATE );
4224
Janos Follathd6dce9f2019-07-04 09:11:38 +01004225 if( data_length != 0 )
4226 {
4227 prf->seed = mbedtls_calloc( 1, data_length );
4228 if( prf->seed == NULL )
4229 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004230
Janos Follathd6dce9f2019-07-04 09:11:38 +01004231 memcpy( prf->seed, data, data_length );
4232 prf->seed_length = data_length;
4233 }
Janos Follathf08e2652019-06-13 09:05:41 +01004234
Gilles Peskine43f958b2020-12-13 14:55:14 +01004235 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004236
4237 return( PSA_SUCCESS );
4238}
4239
Janos Follath81550542019-06-13 14:26:34 +01004240static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004241 const uint8_t *data,
4242 size_t data_length )
4243{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004244 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004245 return( PSA_ERROR_BAD_STATE );
4246
Steven Cooremana6df6042021-04-29 19:32:25 +02004247 if( data_length != 0 )
4248 {
4249 prf->secret = mbedtls_calloc( 1, data_length );
4250 if( prf->secret == NULL )
4251 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4252
4253 memcpy( prf->secret, data, data_length );
4254 prf->secret_length = data_length;
4255 }
Janos Follath81550542019-06-13 14:26:34 +01004256
Gilles Peskine43f958b2020-12-13 14:55:14 +01004257 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004258
4259 return( PSA_SUCCESS );
4260}
4261
Janos Follath63028dd2019-06-13 09:15:47 +01004262static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4263 const uint8_t *data,
4264 size_t data_length )
4265{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004266 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004267 return( PSA_ERROR_BAD_STATE );
4268
Janos Follathd6dce9f2019-07-04 09:11:38 +01004269 if( data_length != 0 )
4270 {
4271 prf->label = mbedtls_calloc( 1, data_length );
4272 if( prf->label == NULL )
4273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004274
Janos Follathd6dce9f2019-07-04 09:11:38 +01004275 memcpy( prf->label, data, data_length );
4276 prf->label_length = data_length;
4277 }
Janos Follath63028dd2019-06-13 09:15:47 +01004278
Gilles Peskine43f958b2020-12-13 14:55:14 +01004279 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004280
4281 return( PSA_SUCCESS );
4282}
4283
Janos Follathb03233e2019-06-11 15:30:30 +01004284static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004285 psa_key_derivation_step_t step,
4286 const uint8_t *data,
4287 size_t data_length )
4288{
Janos Follathb03233e2019-06-11 15:30:30 +01004289 switch( step )
4290 {
Janos Follathf08e2652019-06-13 09:05:41 +01004291 case PSA_KEY_DERIVATION_INPUT_SEED:
4292 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004293 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004294 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004295 case PSA_KEY_DERIVATION_INPUT_LABEL:
4296 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004297 default:
4298 return( PSA_ERROR_INVALID_ARGUMENT );
4299 }
4300}
John Durkop07cc04a2020-11-16 22:08:34 -08004301#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4302 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4303
4304#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4305static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4306 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004307 const uint8_t *data,
4308 size_t data_length )
4309{
4310 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004311 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004312 uint8_t *cur = pms;
4313
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004314 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004315 return( PSA_ERROR_INVALID_ARGUMENT );
4316
4317 /* Quoting RFC 4279, Section 2:
4318 *
4319 * The premaster secret is formed as follows: if the PSK is N octets
4320 * long, concatenate a uint16 with the value N, N zero octets, a second
4321 * uint16 with the value N, and the PSK itself.
4322 */
4323
4324 *cur++ = ( data_length >> 8 ) & 0xff;
4325 *cur++ = ( data_length >> 0 ) & 0xff;
4326 memset( cur, 0, data_length );
4327 cur += data_length;
4328 *cur++ = pms[0];
4329 *cur++ = pms[1];
4330 memcpy( cur, data, data_length );
4331 cur += data_length;
4332
Steven Cooremana6df6042021-04-29 19:32:25 +02004333 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004334
4335 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4336 return( status );
4337}
Janos Follath6660f0e2019-06-17 08:44:03 +01004338
4339static psa_status_t psa_tls12_prf_psk_to_ms_input(
4340 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004341 psa_key_derivation_step_t step,
4342 const uint8_t *data,
4343 size_t data_length )
4344{
4345 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004346 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004347 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004348 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004349 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004350
Steven Cooremana6df6042021-04-29 19:32:25 +02004351 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004352}
John Durkop07cc04a2020-11-16 22:08:34 -08004353#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004354
Gilles Peskineb8965192019-09-24 16:21:10 +02004355/** Check whether the given key type is acceptable for the given
4356 * input step of a key derivation.
4357 *
4358 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4359 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4360 * Both secret and non-secret inputs can alternatively have the type
4361 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4362 * that the input was passed as a buffer rather than via a key object.
4363 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004364static int psa_key_derivation_check_input_type(
4365 psa_key_derivation_step_t step,
4366 psa_key_type_t key_type )
4367{
4368 switch( step )
4369 {
4370 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004371 if( key_type == PSA_KEY_TYPE_DERIVE )
4372 return( PSA_SUCCESS );
4373 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004374 return( PSA_SUCCESS );
4375 break;
4376 case PSA_KEY_DERIVATION_INPUT_LABEL:
4377 case PSA_KEY_DERIVATION_INPUT_SALT:
4378 case PSA_KEY_DERIVATION_INPUT_INFO:
4379 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004380 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4381 return( PSA_SUCCESS );
4382 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004383 return( PSA_SUCCESS );
4384 break;
4385 }
4386 return( PSA_ERROR_INVALID_ARGUMENT );
4387}
4388
Janos Follathb80a94e2019-06-12 15:54:46 +01004389static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004390 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004391 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004392 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004393 const uint8_t *data,
4394 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004395{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004396 psa_status_t status;
4397 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4398
4399 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004400 if( status != PSA_SUCCESS )
4401 goto exit;
4402
John Durkopd0321952020-10-29 21:37:36 -07004403#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004404 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004405 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004406 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004407 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004408 step, data, data_length );
4409 }
John Durkop07cc04a2020-11-16 22:08:34 -08004410 else
4411#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4412#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4413 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004414 {
Janos Follathb03233e2019-06-11 15:30:30 +01004415 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004416 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004417 }
John Durkop07cc04a2020-11-16 22:08:34 -08004418 else
4419#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4420#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4421 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004422 {
4423 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004424 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004425 }
4426 else
John Durkop07cc04a2020-11-16 22:08:34 -08004427#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004428 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004429 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004430 (void) data;
4431 (void) data_length;
4432 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004433 return( PSA_ERROR_BAD_STATE );
4434 }
4435
Gilles Peskine224b0d62019-09-23 18:13:17 +02004436exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004437 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004438 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004439 return( status );
4440}
4441
Janos Follath51f4a0f2019-06-14 11:35:55 +01004442psa_status_t psa_key_derivation_input_bytes(
4443 psa_key_derivation_operation_t *operation,
4444 psa_key_derivation_step_t step,
4445 const uint8_t *data,
4446 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004447{
Gilles Peskineb8965192019-09-24 16:21:10 +02004448 return( psa_key_derivation_input_internal( operation, step,
4449 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004450 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004451}
4452
Janos Follath51f4a0f2019-06-14 11:35:55 +01004453psa_status_t psa_key_derivation_input_key(
4454 psa_key_derivation_operation_t *operation,
4455 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004456 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004457{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004458 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004459 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004460 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004461
Ronald Cron5c522922020-11-14 16:35:34 +01004462 status = psa_get_and_lock_transparent_key_slot_with_policy(
4463 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004464 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004465 {
4466 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004467 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004468 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004469
4470 /* Passing a key object as a SECRET input unlocks the permission
4471 * to output to a key object. */
4472 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4473 operation->can_output_key = 1;
4474
Ronald Cronf95a2b12020-10-22 15:24:49 +02004475 status = psa_key_derivation_input_internal( operation,
4476 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004477 slot->key.data,
4478 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004479
Ronald Cron5c522922020-11-14 16:35:34 +01004480 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004481
Ronald Cron5c522922020-11-14 16:35:34 +01004482 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004483}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004484
4485
4486
4487/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004488/* Key agreement */
4489/****************************************************************/
4490
John Durkop6ba40d12020-11-10 08:50:04 -08004491#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004492static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4493 size_t peer_key_length,
4494 const mbedtls_ecp_keypair *our_key,
4495 uint8_t *shared_secret,
4496 size_t shared_secret_size,
4497 size_t *shared_secret_length )
4498{
Steven Cooremand4867872020-08-05 16:31:39 +02004499 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004500 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004501 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004502 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004503 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004504 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004505
Ronald Cron90857082020-11-25 14:58:33 +01004506 status = mbedtls_psa_ecp_load_representation(
4507 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004508 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004509 peer_key,
4510 peer_key_length,
4511 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004512 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004513 goto exit;
4514
Jaeden Amero97271b32019-01-10 19:38:51 +00004515 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004516 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004517 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004518 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004519 status = mbedtls_to_psa_error(
4520 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4521 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004522 goto exit;
4523
Jaeden Amero97271b32019-01-10 19:38:51 +00004524 status = mbedtls_to_psa_error(
4525 mbedtls_ecdh_calc_secret( &ecdh,
4526 shared_secret_length,
4527 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004528 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004529 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004530 if( status != PSA_SUCCESS )
4531 goto exit;
4532 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4533 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004534
4535exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004536 if( status != PSA_SUCCESS )
4537 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004538 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004539 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004540 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004541
Jaeden Amero97271b32019-01-10 19:38:51 +00004542 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004543}
John Durkop6ba40d12020-11-10 08:50:04 -08004544#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004545
Gilles Peskine01d718c2018-09-18 12:01:02 +02004546#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4547
Gilles Peskine0216fe12019-04-11 21:23:21 +02004548static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4549 psa_key_slot_t *private_key,
4550 const uint8_t *peer_key,
4551 size_t peer_key_length,
4552 uint8_t *shared_secret,
4553 size_t shared_secret_size,
4554 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004555{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004556 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004557 {
John Durkop6ba40d12020-11-10 08:50:04 -08004558#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004559 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004560 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004561 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004562 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004563 psa_status_t status = mbedtls_psa_ecp_load_representation(
4564 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004565 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004566 private_key->key.data,
4567 private_key->key.bytes,
4568 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004569 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004570 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004571 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004572 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004573 shared_secret, shared_secret_size,
4574 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004575 mbedtls_ecp_keypair_free( ecp );
4576 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004577 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004578#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004579 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004580 (void) private_key;
4581 (void) peer_key;
4582 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004583 (void) shared_secret;
4584 (void) shared_secret_size;
4585 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004586 return( PSA_ERROR_NOT_SUPPORTED );
4587 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004588}
4589
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004590/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004591 * to potentially free embedded data structures and wipe confidential data.
4592 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004593static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004594 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004595 psa_key_slot_t *private_key,
4596 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004597 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004598{
4599 psa_status_t status;
4600 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4601 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004602 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004603
4604 /* Step 1: run the secret agreement algorithm to generate the shared
4605 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004606 status = psa_key_agreement_raw_internal( ka_alg,
4607 private_key,
4608 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004609 shared_secret,
4610 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004611 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004612 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004613 goto exit;
4614
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004615 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004616 * the shared secret. A shared secret is permitted wherever a key
4617 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004618 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004619 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004620 shared_secret,
4621 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004622exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004623 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004624 return( status );
4625}
4626
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004627psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004628 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004629 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004630 const uint8_t *peer_key,
4631 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004632{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004634 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004635 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004636
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004637 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004638 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004639 status = psa_get_and_lock_transparent_key_slot_with_policy(
4640 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004641 if( status != PSA_SUCCESS )
4642 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004643 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004644 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004645 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004646 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004647 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004648 else
4649 {
4650 /* If a private key has been added as SECRET, we allow the derived
4651 * key material to be used as a key in PSA Crypto. */
4652 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4653 operation->can_output_key = 1;
4654 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004655
Ronald Cron5c522922020-11-14 16:35:34 +01004656 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004657
Ronald Cron5c522922020-11-14 16:35:34 +01004658 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004659}
4660
Gilles Peskinebe697d82019-05-16 18:00:41 +02004661psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004662 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004663 const uint8_t *peer_key,
4664 size_t peer_key_length,
4665 uint8_t *output,
4666 size_t output_size,
4667 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004668{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004670 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004671 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004672
4673 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4674 {
4675 status = PSA_ERROR_INVALID_ARGUMENT;
4676 goto exit;
4677 }
Ronald Cron5c522922020-11-14 16:35:34 +01004678 status = psa_get_and_lock_transparent_key_slot_with_policy(
4679 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004680 if( status != PSA_SUCCESS )
4681 goto exit;
4682
4683 status = psa_key_agreement_raw_internal( alg, slot,
4684 peer_key, peer_key_length,
4685 output, output_size,
4686 output_length );
4687
4688exit:
4689 if( status != PSA_SUCCESS )
4690 {
4691 /* If an error happens and is not handled properly, the output
4692 * may be used as a key to protect sensitive data. Arrange for such
4693 * a key to be random, which is likely to result in decryption or
4694 * verification errors. This is better than filling the buffer with
4695 * some constant data such as zeros, which would result in the data
4696 * being protected with a reproducible, easily knowable key.
4697 */
4698 psa_generate_random( output, output_size );
4699 *output_length = output_size;
4700 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004701
Ronald Cron5c522922020-11-14 16:35:34 +01004702 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004703
Ronald Cron5c522922020-11-14 16:35:34 +01004704 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004705}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004706
4707
Gilles Peskine30524eb2020-11-13 17:02:26 +01004708
Gilles Peskine86a440b2018-11-12 18:39:40 +01004709/****************************************************************/
4710/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004711/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004712
Gilles Peskine30524eb2020-11-13 17:02:26 +01004713/** Initialize the PSA random generator.
4714 */
4715static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4716{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004717#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4718 memset( rng, 0, sizeof( *rng ) );
4719#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4720
Gilles Peskine30524eb2020-11-13 17:02:26 +01004721 /* Set default configuration if
4722 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4723 if( rng->entropy_init == NULL )
4724 rng->entropy_init = mbedtls_entropy_init;
4725 if( rng->entropy_free == NULL )
4726 rng->entropy_free = mbedtls_entropy_free;
4727
4728 rng->entropy_init( &rng->entropy );
4729#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4730 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4731 /* The PSA entropy injection feature depends on using NV seed as an entropy
4732 * source. Add NV seed as an entropy source for PSA entropy injection. */
4733 mbedtls_entropy_add_source( &rng->entropy,
4734 mbedtls_nv_seed_poll, NULL,
4735 MBEDTLS_ENTROPY_BLOCK_SIZE,
4736 MBEDTLS_ENTROPY_SOURCE_STRONG );
4737#endif
4738
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004739 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004740#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004741}
4742
4743/** Deinitialize the PSA random generator.
4744 */
4745static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4746{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004747#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4748 memset( rng, 0, sizeof( *rng ) );
4749#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004750 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004751 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004752#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004753}
4754
4755/** Seed the PSA random generator.
4756 */
4757static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4758{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004759#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4760 /* Do nothing: the external RNG seeds itself. */
4761 (void) rng;
4762 return( PSA_SUCCESS );
4763#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004764 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004765 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4766 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004767 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004768#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004769}
4770
Gilles Peskinee59236f2018-01-27 23:32:46 +01004771psa_status_t psa_generate_random( uint8_t *output,
4772 size_t output_size )
4773{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004774 GUARD_MODULE_INITIALIZED;
4775
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004776#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4777
4778 size_t output_length = 0;
4779 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4780 output, output_size,
4781 &output_length );
4782 if( status != PSA_SUCCESS )
4783 return( status );
4784 /* Breaking up a request into smaller chunks is currently not supported
4785 * for the extrernal RNG interface. */
4786 if( output_length != output_size )
4787 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4788 return( PSA_SUCCESS );
4789
4790#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4791
Gilles Peskine71ddab92021-01-04 21:01:07 +01004792 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004793 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004794 size_t request_size =
4795 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4796 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4797 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004798 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4799 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004800 if( ret != 0 )
4801 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004802 output_size -= request_size;
4803 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004804 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004805 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004806#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004807}
4808
Gilles Peskine8814fc42020-12-14 15:33:44 +01004809/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004810 *
4811 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4812 * `psa_generate_random(...)`. The state parameter is ignored since the
4813 * PSA API doesn't support passing an explicit state.
4814 *
4815 * In the non-external case, psa_generate_random() calls an
4816 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4817 * and semantics as mbedtls_psa_get_random(). As an optimization,
4818 * instead of doing this back-and-forth between the PSA API and the
4819 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4820 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004821 */
4822#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4823int mbedtls_psa_get_random( void *p_rng,
4824 unsigned char *output,
4825 size_t output_size )
4826{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004827 /* This function takes a pointer to the RNG state because that's what
4828 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4829 * its own state internally and doesn't let the caller access that state.
4830 * So we just ignore the state parameter, and in practice we'll pass
4831 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004832 (void) p_rng;
4833 psa_status_t status = psa_generate_random( output, output_size );
4834 if( status == PSA_SUCCESS )
4835 return( 0 );
4836 else
4837 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4838}
4839#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4840
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004841#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004842#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004843
Gilles Peskine7228da22019-07-15 11:06:15 +02004844psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004845 size_t seed_size )
4846{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004847 if( global_data.initialized )
4848 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004849
4850 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4851 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4852 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4853 return( PSA_ERROR_INVALID_ARGUMENT );
4854
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004855 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004856}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004857#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004858
Ronald Cron3772afe2021-02-08 16:10:05 +01004859/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004860 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004861 * \param type The key type
4862 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004863 *
4864 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004865 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004866 * \retval #PSA_ERROR_INVALID_ARGUMENT
4867 * The size in bits of the key is not valid.
4868 * \retval #PSA_ERROR_NOT_SUPPORTED
4869 * The type and/or the size in bits of the key or the combination of
4870 * the two is not supported.
4871 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004872static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4873 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004874{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004875 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004876
Gilles Peskinee59236f2018-01-27 23:32:46 +01004877 if( key_type_is_raw_bytes( type ) )
4878 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004879 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004880 if( status != PSA_SUCCESS )
4881 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004882 }
4883 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004884#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004885 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4886 {
4887 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4888 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004889
Ronald Cron01b2aba2020-10-05 09:42:02 +02004890 /* Accept only byte-aligned keys, for the same reasons as
4891 * in psa_import_rsa_key(). */
4892 if( bits % 8 != 0 )
4893 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004894 }
4895 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004896#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004897
Ronald Cron5c4d3862020-12-07 11:07:24 +01004898#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004899 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4900 {
Ronald Crond81ab562021-02-16 09:01:16 +01004901 /* To avoid empty block, return successfully here. */
4902 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004903 }
4904 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004905#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004906 {
4907 return( PSA_ERROR_NOT_SUPPORTED );
4908 }
4909
4910 return( PSA_SUCCESS );
4911}
4912
Ronald Cron55ed0592020-10-05 10:30:40 +02004913psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004914 const psa_key_attributes_t *attributes,
4915 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004916{
4917 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004918 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004919
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004920 if( ( attributes->domain_parameters == NULL ) &&
4921 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004922 return( PSA_ERROR_INVALID_ARGUMENT );
4923
Ronald Cron01b2aba2020-10-05 09:42:02 +02004924 if( key_type_is_raw_bytes( type ) )
4925 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004926 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004927 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004928 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004929
David Brown12ca5032021-02-11 11:02:00 -07004930#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004931 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004932 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004933#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004934 }
4935 else
4936
Jaeden Amero424fa932021-05-14 08:34:32 +01004937#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
4938 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004939 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004940 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004941 return( mbedtls_psa_rsa_generate_key( attributes,
4942 key_buffer,
4943 key_buffer_size,
4944 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004945 }
4946 else
Jaeden Amero424fa932021-05-14 08:34:32 +01004947#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
4948 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004949
John Durkop9814fa22020-11-04 12:28:15 -08004950#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004951 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004952 {
Ronald Cron7023db52020-11-20 18:17:42 +01004953 return( mbedtls_psa_ecp_generate_key( attributes,
4954 key_buffer,
4955 key_buffer_size,
4956 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004957 }
4958 else
John Durkop9814fa22020-11-04 12:28:15 -08004959#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004960 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004961 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004962 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004963 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004964
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004965 return( PSA_SUCCESS );
4966}
Darryl Green0c6575a2018-11-07 16:05:30 +00004967
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004968psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004969 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004970{
4971 psa_status_t status;
4972 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004973 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004974 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004975
Ronald Cron81709fc2020-11-14 12:10:32 +01004976 *key = MBEDTLS_SVC_KEY_ID_INIT;
4977
Gilles Peskine0f84d622019-09-12 19:03:13 +02004978 /* Reject any attempt to create a zero-length key so that we don't
4979 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4980 if( psa_get_key_bits( attributes ) == 0 )
4981 return( PSA_ERROR_INVALID_ARGUMENT );
4982
Ronald Cron81709fc2020-11-14 12:10:32 +01004983 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4984 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004985 if( status != PSA_SUCCESS )
4986 goto exit;
4987
Ronald Cron977c2472020-10-13 08:32:21 +02004988 /* In the case of a transparent key or an opaque key stored in local
4989 * storage (thus not in the case of generating a key in a secure element
4990 * or cryptoprocessor with storage), we have to allocate a buffer to
4991 * hold the generated key material. */
4992 if( slot->key.data == NULL )
4993 {
4994 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4995 PSA_KEY_LOCATION_LOCAL_STORAGE )
4996 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004997 status = psa_validate_key_type_and_size_for_key_generation(
4998 attributes->core.type, attributes->core.bits );
4999 if( status != PSA_SUCCESS )
5000 goto exit;
5001
5002 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5003 attributes->core.type,
5004 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005005 }
5006 else
5007 {
5008 status = psa_driver_wrapper_get_key_buffer_size(
5009 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005010 if( status != PSA_SUCCESS )
5011 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005012 }
Ronald Cron977c2472020-10-13 08:32:21 +02005013
5014 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5015 if( status != PSA_SUCCESS )
5016 goto exit;
5017 }
5018
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005019 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005020 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005021
Ronald Cron2b56bc82020-10-05 10:02:26 +02005022 if( status != PSA_SUCCESS )
5023 psa_remove_key_data_from_memory( slot );
5024
Gilles Peskine11792082019-08-06 18:36:36 +02005025exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005026 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005027 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005028 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005029 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005030
Darryl Green0c6575a2018-11-07 16:05:30 +00005031 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005032}
5033
Gilles Peskinee59236f2018-01-27 23:32:46 +01005034/****************************************************************/
5035/* Module setup */
5036/****************************************************************/
5037
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005038#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005039psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5040 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5041 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5042{
5043 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5044 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005045 global_data.rng.entropy_init = entropy_init;
5046 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005047 return( PSA_SUCCESS );
5048}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005049#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005050
Gilles Peskinee59236f2018-01-27 23:32:46 +01005051void mbedtls_psa_crypto_free( void )
5052{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005053 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005054 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5055 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005056 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005057 }
5058 /* Wipe all remaining data, including configuration.
5059 * In particular, this sets all state indicator to the value
5060 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005061 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005062#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005063 /* Unregister all secure element drivers, so that we restart from
5064 * a pristine state. */
5065 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005066#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005067}
5068
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005069#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5070/** Recover a transaction that was interrupted by a power failure.
5071 *
5072 * This function is called during initialization, before psa_crypto_init()
5073 * returns. If this function returns a failure status, the initialization
5074 * fails.
5075 */
5076static psa_status_t psa_crypto_recover_transaction(
5077 const psa_crypto_transaction_t *transaction )
5078{
5079 switch( transaction->unknown.type )
5080 {
5081 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5082 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005083 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005084 * is implemented.
5085 * https://github.com/ARMmbed/mbed-crypto/issues/218
5086 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005087 default:
5088 /* We found an unsupported transaction in the storage.
5089 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005090 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005091 }
5092}
5093#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5094
Gilles Peskinee59236f2018-01-27 23:32:46 +01005095psa_status_t psa_crypto_init( void )
5096{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005097 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005098
Gilles Peskinec6b69072018-11-20 21:42:52 +01005099 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005100 if( global_data.initialized != 0 )
5101 return( PSA_SUCCESS );
5102
Gilles Peskine30524eb2020-11-13 17:02:26 +01005103 /* Initialize and seed the random generator. */
5104 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005105 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005106 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005107 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005108 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005109 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005110
Gilles Peskine66fb1262018-12-10 16:29:04 +01005111 status = psa_initialize_key_slots( );
5112 if( status != PSA_SUCCESS )
5113 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005114
Gilles Peskined9348f22019-10-01 15:22:29 +02005115#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5116 status = psa_init_all_se_drivers( );
5117 if( status != PSA_SUCCESS )
5118 goto exit;
5119#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5120
Gilles Peskine4b734222019-07-24 15:56:31 +02005121#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005122 status = psa_crypto_load_transaction( );
5123 if( status == PSA_SUCCESS )
5124 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005125 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5126 if( status != PSA_SUCCESS )
5127 goto exit;
5128 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005129 }
5130 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5131 {
5132 /* There's no transaction to complete. It's all good. */
5133 status = PSA_SUCCESS;
5134 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005135#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005136
Gilles Peskinec6b69072018-11-20 21:42:52 +01005137 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005138 global_data.initialized = 1;
5139
5140exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005141 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005142 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005143 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005144}
5145
5146#endif /* MBEDTLS_PSA_CRYPTO_C */