blob: aea9f9c72b50024ea361e3f855c2a433da7cbb7a [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
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000079#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087
Gilles Peskine996deb12018-08-01 15:45:45 +020088#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
89
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010090/****************************************************************/
91/* Global data, support functions and library management */
92/****************************************************************/
93
Gilles Peskine48c0ea12018-06-21 14:15:31 +020094static int key_type_is_raw_bytes( psa_key_type_t type )
95{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020096 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097}
98
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010099/* Values for psa_global_data_t::rng_state */
100#define RNG_NOT_INITIALIZED 0
101#define RNG_INITIALIZED 1
102#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100103
Gilles Peskine2d277862018-06-18 15:41:12 +0200104typedef struct
105{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100106 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100109} psa_global_data_t;
110
111static psa_global_data_t global_data;
112
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100113#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
114mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
115 &global_data.rng.drbg;
116#endif
117
itayzafrir0adf0fc2018-09-06 16:24:41 +0300118#define GUARD_MODULE_INITIALIZED \
119 if( global_data.initialized == 0 ) \
120 return( PSA_ERROR_BAD_STATE );
121
Steven Cooreman01164162020-07-20 15:31:37 +0200122psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100124 /* Mbed TLS error codes can combine a high-level error code and a
125 * low-level error code. The low-level error usually reflects the
126 * root cause better, so dispatch on that preferably. */
127 int low_level_ret = - ( -ret & 0x007f );
128 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129 {
130 case 0:
131 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100132
133 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
134 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200136 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
137 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
138 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
139 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
140 case MBEDTLS_ERR_ASN1_INVALID_DATA:
141 return( PSA_ERROR_INVALID_ARGUMENT );
142 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
143 return( PSA_ERROR_INSUFFICIENT_MEMORY );
144 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
145 return( PSA_ERROR_BUFFER_TOO_SMALL );
146
Jaeden Amero93e21112019-02-20 13:57:28 +0000147#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000148 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100150 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_CCM_BAD_INPUT:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_CCM_AUTH_FAILED:
156 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100157
Gilles Peskine26869f22019-05-06 15:25:00 +0200158 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
159 return( PSA_ERROR_INVALID_ARGUMENT );
160
161 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
162 return( PSA_ERROR_BAD_STATE );
163 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
164 return( PSA_ERROR_INVALID_SIGNATURE );
165
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
173 return( PSA_ERROR_INVALID_PADDING );
174 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200175 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
177 return( PSA_ERROR_INVALID_SIGNATURE );
178 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200179 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine82e57d12020-11-13 21:31:17 +0100181#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
182 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100183 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
184 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
186 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
187 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
188 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
191 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100192#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100193
194 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
195 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
Gilles Peskinee59236f2018-01-27 23:32:46 +0100197 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
198 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
199 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201
202 case MBEDTLS_ERR_GCM_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200205 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine82e57d12020-11-13 21:31:17 +0100207#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100211 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
213 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
215 return( PSA_ERROR_NOT_SUPPORTED );
216 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218#endif
219
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
223 return( PSA_ERROR_INVALID_ARGUMENT );
224 case MBEDTLS_ERR_MD_ALLOC_FAILED:
225 return( PSA_ERROR_INSUFFICIENT_MEMORY );
226 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
227 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100228
Gilles Peskinef76aa772018-10-29 19:24:33 +0100229 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
230 return( PSA_ERROR_STORAGE_FAILURE );
231 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
232 return( PSA_ERROR_INVALID_ARGUMENT );
233 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
234 return( PSA_ERROR_INVALID_ARGUMENT );
235 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
236 return( PSA_ERROR_BUFFER_TOO_SMALL );
237 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
238 return( PSA_ERROR_INVALID_ARGUMENT );
239 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
244 return( PSA_ERROR_INSUFFICIENT_MEMORY );
245
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100246 case MBEDTLS_ERR_PK_ALLOC_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_MEMORY );
248 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
249 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100253 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
254 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
255 return( PSA_ERROR_INVALID_ARGUMENT );
256 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
257 return( PSA_ERROR_NOT_SUPPORTED );
258 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
259 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
260 return( PSA_ERROR_NOT_PERMITTED );
261 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_INVALID_ALG:
264 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
265 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
268 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200269 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
270 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100271
Gilles Peskineff2d2002019-05-06 15:26:23 +0200272 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
273 return( PSA_ERROR_HARDWARE_FAILURE );
274 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
275 return( PSA_ERROR_NOT_SUPPORTED );
276
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_RSA_INVALID_PADDING:
280 return( PSA_ERROR_INVALID_PADDING );
281 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
286 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200287 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100288 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
289 return( PSA_ERROR_INVALID_SIGNATURE );
290 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100293 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200294
itayzafrir5c753392018-05-08 11:18:38 +0300295 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300296 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300297 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300298 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
299 return( PSA_ERROR_BUFFER_TOO_SMALL );
300 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
301 return( PSA_ERROR_NOT_SUPPORTED );
302 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
303 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
304 return( PSA_ERROR_INVALID_SIGNATURE );
305 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
306 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100307 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
308 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100309
Janos Follatha13b9052019-11-22 12:48:59 +0000310 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
311 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300312
Gilles Peskinee59236f2018-01-27 23:32:46 +0100313 default:
David Saadab4ecc272019-02-14 13:48:10 +0200314 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100315 }
316}
317
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200319
320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321/****************************************************************/
322/* Key management */
323/****************************************************************/
324
John Durkop07cc04a2020-11-16 22:08:34 -0800325/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
326 * current test driver in key_management.c is using this function
327 * when accelerators are used for ECC key pair and public key.
328 * Once that dependency is resolved these guards can be removed.
329 */
John Durkop9814fa22020-11-04 12:28:15 -0800330#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800331 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
332 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
333 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100334mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100335 size_t bits,
336 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200337{
338 switch( curve )
339 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100340 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100341 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100342 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100343#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100344 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100345 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100346#endif
347#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100348 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100349 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100350#endif
351#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100352 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100353 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100354#endif
355#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100356 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100357 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100358#endif
359#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100360 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100361 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100362 case 528:
363 if( bits_is_sloppy )
364 return( MBEDTLS_ECP_DP_SECP521R1 );
365 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100367 }
368 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100369
Paul Elliott8ff510a2020-06-02 17:19:28 +0100370 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100371 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100372 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100373#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100374 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100375 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100376#endif
377#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#endif
381#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100385 }
386 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100387
Paul Elliott8ff510a2020-06-02 17:19:28 +0100388 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100392 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100393 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
395 if( bits_is_sloppy )
396 return( MBEDTLS_ECP_DP_CURVE25519 );
397 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100398#endif
399#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100400 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100402#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 }
404 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100405
Paul Elliott8ff510a2020-06-02 17:19:28 +0100406 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100410 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100411 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100412#endif
413#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#endif
417#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 }
422 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200423 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100425 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200427}
John Durkop9814fa22020-11-04 12:28:15 -0800428#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800429 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
430 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
431 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432
Archana4d7ae1d2021-07-07 02:50:22 +0530433psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
434 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200435{
436 /* Check that the bit size is acceptable for the key type */
437 switch( type )
438 {
439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200441 case PSA_KEY_TYPE_DERIVE:
442 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_AES:
445 if( bits != 128 && bits != 192 && bits != 256 )
446 return( PSA_ERROR_INVALID_ARGUMENT );
447 break;
448#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_CAMELLIA:
451 if( bits != 128 && bits != 192 && bits != 256 )
452 return( PSA_ERROR_INVALID_ARGUMENT );
453 break;
454#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100455#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456 case PSA_KEY_TYPE_DES:
457 if( bits != 64 && bits != 128 && bits != 192 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100461#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200462 case PSA_KEY_TYPE_CHACHA20:
463 if( bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200467 default:
468 return( PSA_ERROR_NOT_SUPPORTED );
469 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200470 if( bits % 8 != 0 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200472
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 return( PSA_SUCCESS );
474}
475
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100476/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100477 *
Steven Cooremancd640932021-03-08 12:00:27 +0100478 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
479 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100480 *
481 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100482 * \param[in] key_type The key type of the key to be used with the
483 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484 *
485 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100486 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100487 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100491 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100493{
Steven Cooremancd640932021-03-08 12:00:27 +0100494 if( PSA_ALG_IS_HMAC( algorithm ) )
495 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496 if( key_type == PSA_KEY_TYPE_HMAC )
497 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100499
500 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
503 * key. */
504 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
505 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
506 {
507 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
508 * the block length (larger than 1) for block ciphers. */
509 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
510 return( PSA_SUCCESS );
511 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100512 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100513
514 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100515}
516
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200517psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
518 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200519{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100520 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200521 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200522
Ronald Cronea0f8a62020-11-25 17:52:23 +0100523 slot->key.data = mbedtls_calloc( 1, buffer_length );
524 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200525 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200526
Ronald Cronea0f8a62020-11-25 17:52:23 +0100527 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200528 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200529}
530
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200531psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
532 const uint8_t* data,
533 size_t data_length )
534{
535 psa_status_t status = psa_allocate_buffer_to_slot( slot,
536 data_length );
537 if( status != PSA_SUCCESS )
538 return( status );
539
Ronald Cronea0f8a62020-11-25 17:52:23 +0100540 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200541 return( PSA_SUCCESS );
542}
543
Ronald Crona0fe59f2020-11-29 11:14:53 +0100544psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100545 const psa_key_attributes_t *attributes,
546 const uint8_t *data, size_t data_length,
547 uint8_t *key_buffer, size_t key_buffer_size,
548 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100549{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
551 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100552
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200553 /* zero-length keys are never supported. */
554 if( data_length == 0 )
555 return( PSA_ERROR_NOT_SUPPORTED );
556
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100557 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100558 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100559 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200560
Archana4d7ae1d2021-07-07 02:50:22 +0530561 status = psa_validate_unstructured_key_bit_size( attributes->core.type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200562 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200563 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200564
Ronald Crondd04d422020-11-28 15:14:42 +0100565 /* Copy the key material. */
566 memcpy( key_buffer, data, data_length );
567 *key_buffer_length = data_length;
568 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200569
Steven Cooreman40120f62020-10-29 11:42:22 +0100570 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100571 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100572 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200573 {
John Durkop9814fa22020-11-04 12:28:15 -0800574#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
575 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100576 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200577 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100578 return( mbedtls_psa_ecp_import_key( attributes,
579 data, data_length,
580 key_buffer, key_buffer_size,
581 key_buffer_length,
582 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100583 }
John Durkop9814fa22020-11-04 12:28:15 -0800584#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
585 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700586#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
587 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100588 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200589 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100590 return( mbedtls_psa_rsa_import_key( attributes,
591 data, data_length,
592 key_buffer, key_buffer_size,
593 key_buffer_length,
594 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200595 }
John Durkop9814fa22020-11-04 12:28:15 -0800596#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
597 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100598 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100599
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100600 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100601}
602
Gilles Peskinef603c712019-01-19 13:40:11 +0100603/** Calculate the intersection of two algorithm usage policies.
604 *
605 * Return 0 (which allows no operation) on incompatibility.
606 */
607static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100608 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100609 psa_algorithm_t alg1,
610 psa_algorithm_t alg2 )
611{
Gilles Peskine549ea862019-05-22 11:45:59 +0200612 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100613 if( alg1 == alg2 )
614 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100615 /* If the policies are from the same hash-and-sign family, check
616 * if one is a wildcard. If so the other has the specific algorithm. */
617 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
618 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
619 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100620 {
Steven Cooreman03488022021-02-18 12:07:20 +0100621 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
622 return( alg2 );
623 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
624 return( alg1 );
625 }
626 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100627 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100628 * restrictive tag length. */
629 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
630 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
631 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
632 {
633 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
634 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100635 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100636
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100637 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100638 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
639 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100640 {
Steven Cooremancd640932021-03-08 12:00:27 +0100641 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
642 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100643 }
644 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100645 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100646 ( alg1_len <= alg2_len ) )
647 {
648 return( alg2 );
649 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100650 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100651 ( alg2_len <= alg1_len ) )
652 {
653 return( alg1 );
654 }
655 }
656 /* If the policies are from the same MAC family, check whether one
657 * of them is a minimum-MAC-length policy. Calculate the most
658 * restrictive tag length. */
659 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
660 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
661 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
662 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100663 /* Validate the combination of key type and algorithm. Since the base
664 * algorithm of alg1 and alg2 are the same, we only need this once. */
665 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100666 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100667
Steven Cooreman31a876d2021-03-03 20:47:40 +0100668 /* Get the (exact or at-least) output lengths for both sides of the
669 * requested intersection. None of the currently supported algorithms
670 * have an output length dependent on the actual key size, so setting it
671 * to a bogus value of 0 is currently OK.
672 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100673 * Note that for at-least-this-length wildcard algorithms, the output
674 * length is set to the shortest allowed length, which allows us to
675 * calculate the most restrictive tag length for the intersection. */
676 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
677 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100678 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100679
Steven Cooremana1d83222021-02-25 10:20:29 +0100680 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100681 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
682 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100683 {
Steven Cooremancd640932021-03-08 12:00:27 +0100684 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100685 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100686
687 /* If only one is an at-least-this-length policy, the intersection would
688 * be the other (fixed-length) policy as long as said fixed length is
689 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100690 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100691 {
Steven Cooremancd640932021-03-08 12:00:27 +0100692 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100693 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100694 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100695 {
Steven Cooremancd640932021-03-08 12:00:27 +0100696 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100697 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100698
Steven Cooremancd640932021-03-08 12:00:27 +0100699 /* If none of them are wildcards, check whether they define the same tag
700 * length. This is still possible here when one is default-length and
701 * the other specific-length. Ensure to always return the
702 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100703 if( alg1_len == alg2_len )
704 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100705 }
706 /* If the policies are incompatible, allow nothing. */
707 return( 0 );
708}
709
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100710static int psa_key_algorithm_permits( psa_key_type_t key_type,
711 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200712 psa_algorithm_t requested_alg )
713{
Gilles Peskine549ea862019-05-22 11:45:59 +0200714 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200715 if( requested_alg == policy_alg )
716 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100717 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
718 * and requested_alg is the same hash-and-sign family with any hash,
719 * then requested_alg is compliant with policy_alg. */
720 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
721 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200722 {
Steven Cooreman03488022021-02-18 12:07:20 +0100723 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
724 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
725 }
726 /* If policy_alg is a wildcard AEAD algorithm of the same base as
727 * the requested algorithm, check the requested tag length to be
728 * equal-length or longer than the wildcard-specified length. */
729 if( PSA_ALG_IS_AEAD( policy_alg ) &&
730 PSA_ALG_IS_AEAD( requested_alg ) &&
731 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
732 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100733 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100734 {
735 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
736 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
737 }
Steven Cooremancd640932021-03-08 12:00:27 +0100738 /* If policy_alg is a MAC algorithm of the same base as the requested
739 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100740 if( PSA_ALG_IS_MAC( policy_alg ) &&
741 PSA_ALG_IS_MAC( requested_alg ) &&
742 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100743 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100744 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100745 /* Validate the combination of key type and algorithm. Since the policy
746 * and requested algorithms are the same, we only need this once. */
747 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100748 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100749
Steven Cooreman31a876d2021-03-03 20:47:40 +0100750 /* Get both the requested output length for the algorithm which is to be
751 * verified, and the default output length for the base algorithm.
752 * Note that none of the currently supported algorithms have an output
753 * length dependent on actual key size, so setting it to a bogus value
754 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100755 size_t requested_output_length = PSA_MAC_LENGTH(
756 key_type, 0, requested_alg );
757 size_t default_output_length = PSA_MAC_LENGTH(
758 key_type, 0,
759 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100760
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100761 /* If the policy is default-length, only allow an algorithm with
762 * a declared exact-length matching the default. */
763 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100764 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100765
766 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100767 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
769 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
770 {
771 return( 1 );
772 }
773
Steven Cooremancd640932021-03-08 12:00:27 +0100774 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
775 * check for the requested MAC length to be equal to or longer than the
776 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
778 {
779 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100780 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100781 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200782 }
Steven Cooremance48e852020-10-05 16:02:45 +0200783 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200784 * a key derivation with that key agreement should also be allowed. This
785 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200786 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
787 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
788 {
789 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
790 policy_alg );
791 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100792 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200793 return( 0 );
794}
795
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100796/** Test whether a policy permits an algorithm.
797 *
798 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100799 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100800 * \note This function requires providing the key type for which the policy is
801 * being validated, since some algorithm policy definitions (e.g. MAC)
802 * have different properties depending on what kind of cipher it is
803 * combined with.
804 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100805 * \retval PSA_SUCCESS When \p alg is a specific algorithm
806 * allowed by the \p policy.
807 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
808 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
809 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100810 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100811static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100812 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100813 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100814{
Steven Cooremand788fab2021-02-25 11:29:17 +0100815 /* '0' is not a valid algorithm */
816 if( alg == 0 )
817 return( PSA_ERROR_INVALID_ARGUMENT );
818
Steven Cooreman7e39f052021-02-23 14:18:32 +0100819 /* A requested algorithm cannot be a wildcard. */
820 if( PSA_ALG_IS_WILDCARD( alg ) )
821 return( PSA_ERROR_INVALID_ARGUMENT );
822
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100823 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
824 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100825 return( PSA_SUCCESS );
826 else
827 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100828}
829
Gilles Peskinef603c712019-01-19 13:40:11 +0100830/** Restrict a key policy based on a constraint.
831 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100832 * \note This function requires providing the key type for which the policy is
833 * being restricted, since some algorithm policy definitions (e.g. MAC)
834 * have different properties depending on what kind of cipher it is
835 * combined with.
836 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100837 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100838 * \param[in,out] policy The policy to restrict.
839 * \param[in] constraint The policy constraint to apply.
840 *
841 * \retval #PSA_SUCCESS
842 * \c *policy contains the intersection of the original value of
843 * \c *policy and \c *constraint.
844 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100845 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100846 * \c *policy is unchanged.
847 */
848static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100849 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100850 psa_key_policy_t *policy,
851 const psa_key_policy_t *constraint )
852{
853 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100854 psa_key_policy_algorithm_intersection( key_type, policy->alg,
855 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200856 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100857 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
858 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100859 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
860 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200861 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
862 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100863 policy->usage &= constraint->usage;
864 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200865 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 return( PSA_SUCCESS );
867}
868
Ronald Cron5c522922020-11-14 16:35:34 +0100869/** Get the description of a key given its identifier and policy constraints
870 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200871 *
Ronald Cron5c522922020-11-14 16:35:34 +0100872 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100873 * nonzero, the key must allow operations with this algorithm. If \p alg is
874 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100875 *
Ronald Cron5c522922020-11-14 16:35:34 +0100876 * In case of a persistent key, the function loads the description of the key
877 * into a key slot if not already done.
878 *
879 * On success, the returned key slot is locked. It is the responsibility of
880 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200881 */
Ronald Cron5c522922020-11-14 16:35:34 +0100882static psa_status_t psa_get_and_lock_key_slot_with_policy(
883 mbedtls_svc_key_id_t key,
884 psa_key_slot_t **p_slot,
885 psa_key_usage_t usage,
886 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100887{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200888 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
889 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100890
Ronald Cron5c522922020-11-14 16:35:34 +0100891 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100892 if( status != PSA_SUCCESS )
893 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200894 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100895
896 /* Enforce that usage policy for the key slot contains all the flags
897 * required by the usage parameter. There is one exception: public
898 * keys can always be exported, so we treat public key objects as
899 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200900 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100901 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200902
Gilles Peskine8e338702019-07-30 20:06:31 +0200903 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100904 {
905 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200906 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100907 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100908
909 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100910 if( alg != 0 )
911 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100912 status = psa_key_policy_permits( &slot->attr.policy,
913 slot->attr.type,
914 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100915 if( status != PSA_SUCCESS )
916 goto error;
917 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100918
Darryl Green06fd18d2018-07-16 11:21:11 +0100919 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200920
921error:
922 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100923 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200924
925 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100926}
Darryl Green940d72c2018-07-13 13:18:51 +0100927
Ronald Cron5c522922020-11-14 16:35:34 +0100928/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200929 *
930 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200931 * available, as opposed to a key in a secure element and/or to be used
932 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200933 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200934 * This is a temporary function that may be used instead of
935 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
936 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937 *
Ronald Cron5c522922020-11-14 16:35:34 +0100938 * On success, the returned key slot is locked. It is the responsibility of the
939 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200940 */
Ronald Cron5c522922020-11-14 16:35:34 +0100941static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
942 mbedtls_svc_key_id_t key,
943 psa_key_slot_t **p_slot,
944 psa_key_usage_t usage,
945 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200946{
Ronald Cron5c522922020-11-14 16:35:34 +0100947 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
948 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200949 if( status != PSA_SUCCESS )
950 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200951
Ronald Cronddae0f52021-08-24 15:39:44 +0200952 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200953 {
Ronald Cron5c522922020-11-14 16:35:34 +0100954 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 *p_slot = NULL;
956 return( PSA_ERROR_NOT_SUPPORTED );
957 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Gilles Peskine28f8f302019-07-24 13:30:31 +0200959 return( PSA_SUCCESS );
960}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200961
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200962psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000963{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100964 /* Data pointer will always be either a valid pointer or NULL in an
965 * initialized slot, so we can just free it. */
966 if( slot->key.data != NULL )
967 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
968
969 mbedtls_free( slot->key.data );
970 slot->key.data = NULL;
971 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000972
973 return( PSA_SUCCESS );
974}
975
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100976/** Completely wipe a slot in memory, including its policy.
977 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100978psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100979{
980 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100981
TRodziewicz18cddc02021-07-13 12:19:15 +0200982 /*
983 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200984 * do our best to report an unexpected lock counter. Assert with
985 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
986 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
987 * function is called as part of the execution of a test suite, the
988 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200989 */
Ronald Cron5c522922020-11-14 16:35:34 +0100990 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100991 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200992 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100993 status = PSA_ERROR_CORRUPTION_DETECTED;
994 }
995
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200996 /* Multipart operations may still be using the key. This is safe
997 * because all multipart operation objects are independent from
998 * the key slot: if they need to access the key after the setup
999 * phase, they have a copy of the key. Note that this means that
1000 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001001 /* At this point, key material and other type-specific content has
1002 * been wiped. Clear remaining metadata. We can call memset and not
1003 * zeroize because the metadata is not particularly sensitive. */
1004 memset( slot, 0, sizeof( *slot ) );
1005 return( status );
1006}
1007
Ronald Croncf56a0a2020-08-04 09:51:30 +02001008psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001009{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001010 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001011 psa_status_t status; /* status of the last operation */
1012 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001013#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1014 psa_se_drv_table_entry_t *driver;
1015#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001016
Ronald Croncf56a0a2020-08-04 09:51:30 +02001017 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001018 return( PSA_SUCCESS );
1019
Ronald Cronf2911112020-10-29 17:51:10 +01001020 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001021 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001022 * key, this will load the key description from persistent memory if not
1023 * done yet. We cannot avoid this loading as without it we don't know if
1024 * the key is operated by an SE or not and this information is needed by
1025 * the current implementation.
1026 */
Ronald Cron5c522922020-11-14 16:35:34 +01001027 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001028 if( status != PSA_SUCCESS )
1029 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001030
Ronald Cronf2911112020-10-29 17:51:10 +01001031 /*
1032 * If the key slot containing the key description is under access by the
1033 * library (apart from the present access), the key cannot be destroyed
1034 * yet. For the time being, just return in error. Eventually (to be
1035 * implemented), the key should be destroyed when all accesses have
1036 * stopped.
1037 */
Ronald Cron5c522922020-11-14 16:35:34 +01001038 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001039 {
Ronald Cron5c522922020-11-14 16:35:34 +01001040 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001041 return( PSA_ERROR_GENERIC_ERROR );
1042 }
1043
Gilles Peskine6687cd02021-04-21 22:32:05 +02001044 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1045 {
1046 /* Refuse the destruction of a read-only key (which may or may not work
1047 * if we attempt it, depending on whether the key is merely read-only
1048 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001049 * Just do the best we can, which is to wipe the copy in memory
1050 * (done in this function's cleanup code). */
1051 overall_status = PSA_ERROR_NOT_PERMITTED;
1052 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001053 }
1054
Gilles Peskine354f7672019-07-12 23:46:38 +02001055#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001056 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001057 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001058 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001059 /* For a key in a secure element, we need to do three things:
1060 * remove the key file in internal storage, destroy the
1061 * key inside the secure element, and update the driver's
1062 * persistent data. Start a transaction that will encompass these
1063 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001064 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001065 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001066 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001067 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001068 status = psa_crypto_save_transaction( );
1069 if( status != PSA_SUCCESS )
1070 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001071 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001072 /* We should still try to destroy the key in the secure
1073 * element and the key metadata in storage. This is especially
1074 * important if the error is that the storage is full.
1075 * But how to do it exactly without risking an inconsistent
1076 * state after a reset?
1077 * https://github.com/ARMmbed/mbed-crypto/issues/215
1078 */
1079 overall_status = status;
1080 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001081 }
1082
Ronald Cronea0f8a62020-11-25 17:52:23 +01001083 status = psa_destroy_se_key( driver,
1084 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001085 if( overall_status == PSA_SUCCESS )
1086 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001087 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001088#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1089
Darryl Greend49a4992018-06-18 17:27:26 +01001090#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001091 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001092 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001093 status = psa_destroy_persistent_key( slot->attr.id );
1094 if( overall_status == PSA_SUCCESS )
1095 overall_status = status;
1096
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001097 /* TODO: other slots may have a copy of the same key. We should
1098 * invalidate them.
1099 * https://github.com/ARMmbed/mbed-crypto/issues/214
1100 */
Darryl Greend49a4992018-06-18 17:27:26 +01001101 }
1102#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001103
Gilles Peskinefc762652019-07-22 19:30:34 +02001104#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1105 if( driver != NULL )
1106 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001107 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001108 if( overall_status == PSA_SUCCESS )
1109 overall_status = status;
1110 status = psa_crypto_stop_transaction( );
1111 if( overall_status == PSA_SUCCESS )
1112 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001113 }
1114#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1115
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001116exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001117 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001118 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001119 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001120 overall_status = status;
1121 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001122}
1123
John Durkop07cc04a2020-11-16 22:08:34 -08001124#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001125 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001126static psa_status_t psa_get_rsa_public_exponent(
1127 const mbedtls_rsa_context *rsa,
1128 psa_key_attributes_t *attributes )
1129{
1130 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001131 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001132 uint8_t *buffer = NULL;
1133 size_t buflen;
1134 mbedtls_mpi_init( &mpi );
1135
1136 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1137 if( ret != 0 )
1138 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001139 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1140 {
1141 /* It's the default value, which is reported as an empty string,
1142 * so there's nothing to do. */
1143 goto exit;
1144 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001145
1146 buflen = mbedtls_mpi_size( &mpi );
1147 buffer = mbedtls_calloc( 1, buflen );
1148 if( buffer == NULL )
1149 {
1150 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1151 goto exit;
1152 }
1153 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1154 if( ret != 0 )
1155 goto exit;
1156 attributes->domain_parameters = buffer;
1157 attributes->domain_parameters_size = buflen;
1158
1159exit:
1160 mbedtls_mpi_free( &mpi );
1161 if( ret != 0 )
1162 mbedtls_free( buffer );
1163 return( mbedtls_to_psa_error( ret ) );
1164}
John Durkop07cc04a2020-11-16 22:08:34 -08001165#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001166 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001167
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001168/** Retrieve all the publicly-accessible attributes of a key.
1169 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001170psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001171 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001172{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001173 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001174 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001175 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001176
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001177 psa_reset_key_attributes( attributes );
1178
Ronald Cron5c522922020-11-14 16:35:34 +01001179 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001180 if( status != PSA_SUCCESS )
1181 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001182
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001183 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001184 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1185 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1186
1187#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001188 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001189 psa_set_key_slot_number( attributes,
1190 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001191#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001192
Gilles Peskine8e338702019-07-30 20:06:31 +02001193 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001194 {
John Durkop07cc04a2020-11-16 22:08:34 -08001195#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001196 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001197 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001198 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001199 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001200 * is not yet implemented.
1201 * https://github.com/ARMmbed/mbed-crypto/issues/216
1202 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001203 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001204 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001205 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001206
Ronald Cron90857082020-11-25 14:58:33 +01001207 status = mbedtls_psa_rsa_load_representation(
1208 slot->attr.type,
1209 slot->key.data,
1210 slot->key.bytes,
1211 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001212 if( status != PSA_SUCCESS )
1213 break;
1214
Steven Cooremana2371e52020-07-28 14:30:39 +02001215 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001216 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001217 mbedtls_rsa_free( rsa );
1218 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001219 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001220 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001221#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001222 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001223 default:
1224 /* Nothing else to do. */
1225 break;
1226 }
1227
1228 if( status != PSA_SUCCESS )
1229 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001230
Ronald Cron5c522922020-11-14 16:35:34 +01001231 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001232
Ronald Cron5c522922020-11-14 16:35:34 +01001233 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001234}
1235
Gilles Peskinec8000c02019-08-02 20:15:51 +02001236#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1237psa_status_t psa_get_key_slot_number(
1238 const psa_key_attributes_t *attributes,
1239 psa_key_slot_number_t *slot_number )
1240{
1241 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1242 {
1243 *slot_number = attributes->slot_number;
1244 return( PSA_SUCCESS );
1245 }
1246 else
1247 return( PSA_ERROR_INVALID_ARGUMENT );
1248}
1249#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1250
Ronald Crond18b5f82020-11-25 16:46:05 +01001251static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1252 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001253 uint8_t *data,
1254 size_t data_size,
1255 size_t *data_length )
1256{
Ronald Crond18b5f82020-11-25 16:46:05 +01001257 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001258 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001259 memcpy( data, key_buffer, key_buffer_size );
1260 memset( data + key_buffer_size, 0,
1261 data_size - key_buffer_size );
1262 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001263 return( PSA_SUCCESS );
1264}
1265
Ronald Cron7285cda2020-11-26 14:46:37 +01001266psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001267 const psa_key_attributes_t *attributes,
1268 const uint8_t *key_buffer, size_t key_buffer_size,
1269 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001270{
Ronald Crond18b5f82020-11-25 16:46:05 +01001271 psa_key_type_t type = attributes->core.type;
1272
Ronald Crond18b5f82020-11-25 16:46:05 +01001273 if( key_type_is_raw_bytes( type ) ||
1274 PSA_KEY_TYPE_IS_RSA( type ) ||
1275 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001276 {
1277 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001278 key_buffer, key_buffer_size,
1279 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001280 }
1281 else
1282 {
1283 /* This shouldn't happen in the reference implementation, but
1284 it is valid for a special-purpose implementation to omit
1285 support for exporting certain key types. */
1286 return( PSA_ERROR_NOT_SUPPORTED );
1287 }
1288}
1289
1290psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1291 uint8_t *data,
1292 size_t data_size,
1293 size_t *data_length )
1294{
1295 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1296 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1297 psa_key_slot_t *slot;
1298
Ronald Crone907e552021-01-18 13:22:38 +01001299 /* Reject a zero-length output buffer now, since this can never be a
1300 * valid key representation. This way we know that data must be a valid
1301 * pointer and we can do things like memset(data, ..., data_size). */
1302 if( data_size == 0 )
1303 return( PSA_ERROR_BUFFER_TOO_SMALL );
1304
Ronald Cron9486f9d2020-11-26 13:36:23 +01001305 /* Set the key to empty now, so that even when there are errors, we always
1306 * set data_length to a value between 0 and data_size. On error, setting
1307 * the key to empty is a good choice because an empty key representation is
1308 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001309 *data_length = 0;
1310
Ronald Cron9486f9d2020-11-26 13:36:23 +01001311 /* Export requires the EXPORT flag. There is an exception for public keys,
1312 * which don't require any flag, but
1313 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1314 */
1315 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1316 PSA_KEY_USAGE_EXPORT, 0 );
1317 if( status != PSA_SUCCESS )
1318 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001319
Ronald Crond18b5f82020-11-25 16:46:05 +01001320 psa_key_attributes_t attributes = {
1321 .core = slot->attr
1322 };
Ronald Cron67227982020-11-26 15:16:05 +01001323 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001324 slot->key.data, slot->key.bytes,
1325 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001326
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327 unlock_status = psa_unlock_key_slot( slot );
1328
1329 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1330}
1331
Ronald Cron7285cda2020-11-26 14:46:37 +01001332psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001333 const psa_key_attributes_t *attributes,
1334 const uint8_t *key_buffer,
1335 size_t key_buffer_size,
1336 uint8_t *data,
1337 size_t data_size,
1338 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001339{
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001341
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001343 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001344 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001345 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001346 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001347 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001348 key_buffer, key_buffer_size,
1349 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001350 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001351
Ronald Crond18b5f82020-11-25 16:46:05 +01001352 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001353 {
John Durkop0e005192020-10-31 22:06:54 -07001354#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1355 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001356 return( mbedtls_psa_rsa_export_public_key( attributes,
1357 key_buffer,
1358 key_buffer_size,
1359 data,
1360 data_size,
1361 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001362#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001363 /* We don't know how to convert a private RSA key to public. */
1364 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001365#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1366 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001367 }
1368 else
Moran Pekera998bc62018-04-16 18:16:20 +03001369 {
John Durkop6ba40d12020-11-10 08:50:04 -08001370#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1371 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001372 return( mbedtls_psa_ecp_export_public_key( attributes,
1373 key_buffer,
1374 key_buffer_size,
1375 data,
1376 data_size,
1377 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001378#else
1379 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001380 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001381#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1382 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001383 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001384 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001385 else
1386 {
1387 /* This shouldn't happen in the reference implementation, but
1388 it is valid for a special-purpose implementation to omit
1389 support for exporting certain key types. */
1390 return( PSA_ERROR_NOT_SUPPORTED );
1391 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001392}
Ronald Crond18b5f82020-11-25 16:46:05 +01001393
Ronald Croncf56a0a2020-08-04 09:51:30 +02001394psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001395 uint8_t *data,
1396 size_t data_size,
1397 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001398{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001399 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001400 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001401 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001402
Ronald Crone907e552021-01-18 13:22:38 +01001403 /* Reject a zero-length output buffer now, since this can never be a
1404 * valid key representation. This way we know that data must be a valid
1405 * pointer and we can do things like memset(data, ..., data_size). */
1406 if( data_size == 0 )
1407 return( PSA_ERROR_BUFFER_TOO_SMALL );
1408
Darryl Greendd8fb772018-11-07 16:00:44 +00001409 /* Set the key to empty now, so that even when there are errors, we always
1410 * set data_length to a value between 0 and data_size. On error, setting
1411 * the key to empty is a good choice because an empty key representation is
1412 * unlikely to be accepted anywhere. */
1413 *data_length = 0;
1414
1415 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001416 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001417 if( status != PSA_SUCCESS )
1418 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001419
Ronald Cron9486f9d2020-11-26 13:36:23 +01001420 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1421 {
1422 status = PSA_ERROR_INVALID_ARGUMENT;
1423 goto exit;
1424 }
1425
Ronald Crond18b5f82020-11-25 16:46:05 +01001426 psa_key_attributes_t attributes = {
1427 .core = slot->attr
1428 };
Ronald Cron67227982020-11-26 15:16:05 +01001429 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001430 &attributes, slot->key.data, slot->key.bytes,
1431 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001432
1433exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001434 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001435
Ronald Cron5c522922020-11-14 16:35:34 +01001436 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001437}
1438
Gilles Peskine91e8c332019-08-02 19:19:39 +02001439#if defined(static_assert)
1440static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1441 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001442static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001443 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001444static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001445 "One or more key attribute flag is listed as both internal-only and external-only" );
1446#endif
1447
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001448/** Validate that a key policy is internally well-formed.
1449 *
1450 * This function only rejects invalid policies. It does not validate the
1451 * consistency of the policy with respect to other attributes of the key
1452 * such as the key type.
1453 */
1454static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001455{
1456 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001457 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001458 PSA_KEY_USAGE_ENCRYPT |
1459 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001460 PSA_KEY_USAGE_SIGN_MESSAGE |
1461 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001462 PSA_KEY_USAGE_SIGN_HASH |
1463 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001464 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001465 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1466 return( PSA_ERROR_INVALID_ARGUMENT );
1467
Gilles Peskine4747d192019-04-17 15:05:45 +02001468 return( PSA_SUCCESS );
1469}
1470
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001471/** Validate the internal consistency of key attributes.
1472 *
1473 * This function only rejects invalid attribute values. If does not
1474 * validate the consistency of the attributes with any key data that may
1475 * be involved in the creation of the key.
1476 *
1477 * Call this function early in the key creation process.
1478 *
1479 * \param[in] attributes Key attributes for the new key.
1480 * \param[out] p_drv On any return, the driver for the key, if any.
1481 * NULL for a transparent key.
1482 *
1483 */
1484static psa_status_t psa_validate_key_attributes(
1485 const psa_key_attributes_t *attributes,
1486 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001487{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001488 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001489 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001490 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001491
Ronald Cron54b90082020-10-29 15:26:43 +01001492 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001493 if( status != PSA_SUCCESS )
1494 return( status );
1495
Ronald Crond2ed4812020-07-17 16:11:30 +02001496 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001497 if( status != PSA_SUCCESS )
1498 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001499
Ronald Cron65f38a32020-10-23 17:11:13 +02001500 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1501 {
1502 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1503 return( PSA_ERROR_INVALID_ARGUMENT );
1504 }
1505 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001506 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001507 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1508 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001509 }
1510
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001511 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001512 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001513 return( status );
1514
1515 /* Refuse to create overly large keys.
1516 * Note that this doesn't trigger on import if the attributes don't
1517 * explicitly specify a size (so psa_get_key_bits returns 0), so
1518 * psa_import_key() needs its own checks. */
1519 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1520 return( PSA_ERROR_NOT_SUPPORTED );
1521
Gilles Peskine91e8c332019-08-02 19:19:39 +02001522 /* Reject invalid flags. These should not be reachable through the API. */
1523 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1524 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1525 return( PSA_ERROR_INVALID_ARGUMENT );
1526
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001527 return( PSA_SUCCESS );
1528}
1529
Gilles Peskine4747d192019-04-17 15:05:45 +02001530/** Prepare a key slot to receive key material.
1531 *
1532 * This function allocates a key slot and sets its metadata.
1533 *
1534 * If this function fails, call psa_fail_key_creation().
1535 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001536 * This function is intended to be used as follows:
1537 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001538 * it with the specified attributes, and in case of a volatile key assign it
1539 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001540 * -# Populate the slot with the key material.
1541 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1542 * In case of failure at any step, stop the sequence and call
1543 * psa_fail_key_creation().
1544 *
Ronald Cron5c522922020-11-14 16:35:34 +01001545 * On success, the key slot is locked. It is the responsibility of the caller
1546 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001547 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001548 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001549 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001550 * \param[out] p_slot On success, a pointer to the prepared slot.
1551 * \param[out] p_drv On any return, the driver for the key, if any.
1552 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001553 *
1554 * \retval #PSA_SUCCESS
1555 * The key slot is ready to receive key material.
1556 * \return If this function fails, the key slot is an invalid state.
1557 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001558 */
1559static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001560 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001561 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001562 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001563 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001564{
1565 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001566 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001567 psa_key_slot_t *slot;
1568
Gilles Peskinedf179142019-07-15 22:02:14 +02001569 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001570 *p_drv = NULL;
1571
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001572 status = psa_validate_key_attributes( attributes, p_drv );
1573 if( status != PSA_SUCCESS )
1574 return( status );
1575
Ronald Cronc4d1b512020-07-31 11:26:37 +02001576 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001577 if( status != PSA_SUCCESS )
1578 return( status );
1579 slot = *p_slot;
1580
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001581 /* We're storing the declared bit-size of the key. It's up to each
1582 * creation mechanism to verify that this information is correct.
1583 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001584 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001585 * is optional (import, copy). In case of a volatile key, assign it the
1586 * volatile key identifier associated to the slot returned to contain its
1587 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001588
1589 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001590 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1591 {
1592#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1593 slot->attr.id = volatile_key_id;
1594#else
1595 slot->attr.id.key_id = volatile_key_id;
1596#endif
1597 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001598
Gilles Peskine91e8c332019-08-02 19:19:39 +02001599 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001600 * external-only flags, query `attributes`. Thanks to the check
1601 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001602 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001603 * may have set. */
1604 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001605
Gilles Peskinecbaff462019-07-12 23:46:04 +02001606#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001607 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001608 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001609 * create the key file in internal storage, create the
1610 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001611 * persistent data. This is done by starting a transaction that will
1612 * encompass these three actions.
1613 * For registering a volatile key, we just need to find an appropriate
1614 * slot number inside the SE. Since the key is designated volatile, creating
1615 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001616 /* The first thing to do is to find a slot number for the new key.
1617 * We save the slot number in persistent storage as part of the
1618 * transaction data. It will be needed to recover if the power
1619 * fails during the key creation process, to clean up on the secure
1620 * element side after restarting. Obtaining a slot number from the
1621 * secure element driver updates its persistent state, but we do not yet
1622 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001623 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001624 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001625 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001626 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001627 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001628 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001629 if( status != PSA_SUCCESS )
1630 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001631
1632 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001633 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001634 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1635 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001636 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001637 psa_crypto_transaction.key.id = slot->attr.id;
1638 status = psa_crypto_save_transaction( );
1639 if( status != PSA_SUCCESS )
1640 {
1641 (void) psa_crypto_stop_transaction( );
1642 return( status );
1643 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001644 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001645
1646 status = psa_copy_key_material_into_slot(
1647 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001648 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001649
1650 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1651 {
1652 /* Key registration only makes sense with a secure element. */
1653 return( PSA_ERROR_INVALID_ARGUMENT );
1654 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001655#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1656
Ronald Cronc4d1b512020-07-31 11:26:37 +02001657 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001658}
Gilles Peskine4747d192019-04-17 15:05:45 +02001659
1660/** Finalize the creation of a key once its key material has been set.
1661 *
1662 * This entails writing the key to persistent storage.
1663 *
1664 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001665 * See the documentation of psa_start_key_creation() for the intended use
1666 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001667 *
Ronald Cron5c522922020-11-14 16:35:34 +01001668 * If the finalization succeeds, the function unlocks the key slot (it was
1669 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1670 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001671 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001672 * \param[in,out] slot Pointer to the slot with key material.
1673 * \param[in] driver The secure element driver for the key,
1674 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001675 * \param[out] key On success, identifier of the key. Note that the
1676 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001677 *
1678 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001679 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001680 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1681 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1682 * \retval #PSA_ERROR_ALREADY_EXISTS
1683 * \retval #PSA_ERROR_DATA_INVALID
1684 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001685 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001686 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001687 * \return If this function fails, the key slot is an invalid state.
1688 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001689 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001690static psa_status_t psa_finish_key_creation(
1691 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001692 psa_se_drv_table_entry_t *driver,
1693 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001694{
1695 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001696 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001697 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001698
1699#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001700 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001701 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001702#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1703 if( driver != NULL )
1704 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001705 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001706 psa_key_slot_number_t slot_number =
1707 psa_key_slot_get_slot_number( slot ) ;
1708
Gilles Peskineb46bef22019-07-30 21:32:04 +02001709#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001710 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001711 sizeof( data.slot_number ),
1712 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001713#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001714 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001715 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001716 (uint8_t*) &data,
1717 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001718 }
1719 else
1720#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1721 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001722 /* Key material is saved in export representation in the slot, so
1723 * just pass the slot buffer for storage. */
1724 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001725 slot->key.data,
1726 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001727 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001728 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001729#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1730
Gilles Peskinecbaff462019-07-12 23:46:04 +02001731#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001732 /* Finish the transaction for a key creation. This does not
1733 * happen when registering an existing key. Detect this case
1734 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001735 * creation of a persistent key in a secure element requires a transaction,
1736 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001737 if( driver != NULL &&
1738 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001739 {
1740 status = psa_save_se_persistent_data( driver );
1741 if( status != PSA_SUCCESS )
1742 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001743 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001744 return( status );
1745 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001746 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001747 }
1748#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1749
Ronald Cron50972942020-11-14 11:28:25 +01001750 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001751 {
1752 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001753 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001754 if( status != PSA_SUCCESS )
1755 *key = MBEDTLS_SVC_KEY_ID_INIT;
1756 }
Ronald Cron50972942020-11-14 11:28:25 +01001757
Gilles Peskine4747d192019-04-17 15:05:45 +02001758 return( status );
1759}
1760
1761/** Abort the creation of a key.
1762 *
1763 * You may call this function after calling psa_start_key_creation(),
1764 * or after psa_finish_key_creation() fails. In other circumstances, this
1765 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001766 * See the documentation of psa_start_key_creation() for the intended use
1767 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001768 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001769 * \param[in,out] slot Pointer to the slot with key material.
1770 * \param[in] driver The secure element driver for the key,
1771 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001772 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001773static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001774 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001775{
Gilles Peskine011e4282019-06-26 18:34:38 +02001776 (void) driver;
1777
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 if( slot == NULL )
1779 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001780
1781#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001782 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001783 * element, and the failure happened later (when saving metadata
1784 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001785 * element.
1786 * https://github.com/ARMmbed/mbed-crypto/issues/217
1787 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001788
Gilles Peskined7729582019-08-05 15:55:54 +02001789 /* Abort the ongoing transaction if any (there may not be one if
1790 * the creation process failed before starting one, or if the
1791 * key creation is a registration of a key in a secure element).
1792 * Earlier functions must already have done what it takes to undo any
1793 * partial creation. All that's left is to update the transaction data
1794 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001795 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001796#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1797
Gilles Peskine4747d192019-04-17 15:05:45 +02001798 psa_wipe_key_slot( slot );
1799}
1800
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001801/** Validate optional attributes during key creation.
1802 *
1803 * Some key attributes are optional during key creation. If they are
1804 * specified in the attributes structure, check that they are consistent
1805 * with the data in the slot.
1806 *
1807 * This function should be called near the end of key creation, after
1808 * the slot in memory is fully populated but before saving persistent data.
1809 */
1810static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001811 const psa_key_slot_t *slot,
1812 const psa_key_attributes_t *attributes )
1813{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001814 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001815 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001816 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001817 return( PSA_ERROR_INVALID_ARGUMENT );
1818 }
1819
1820 if( attributes->domain_parameters_size != 0 )
1821 {
John Durkop0e005192020-10-31 22:06:54 -07001822#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1823 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001824 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001825 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001826 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001827 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001829
Ronald Cron90857082020-11-25 14:58:33 +01001830 psa_status_t status = mbedtls_psa_rsa_load_representation(
1831 slot->attr.type,
1832 slot->key.data,
1833 slot->key.bytes,
1834 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001835 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001836 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001837
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001838 mbedtls_mpi_init( &actual );
1839 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001840 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001842 mbedtls_rsa_free( rsa );
1843 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001844 if( ret != 0 )
1845 goto rsa_exit;
1846 ret = mbedtls_mpi_read_binary( &required,
1847 attributes->domain_parameters,
1848 attributes->domain_parameters_size );
1849 if( ret != 0 )
1850 goto rsa_exit;
1851 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1852 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1853 rsa_exit:
1854 mbedtls_mpi_free( &actual );
1855 mbedtls_mpi_free( &required );
1856 if( ret != 0)
1857 return( mbedtls_to_psa_error( ret ) );
1858 }
1859 else
John Durkop9814fa22020-11-04 12:28:15 -08001860#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1861 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001862 {
1863 return( PSA_ERROR_INVALID_ARGUMENT );
1864 }
1865 }
1866
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001867 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001868 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001869 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001870 return( PSA_ERROR_INVALID_ARGUMENT );
1871 }
1872
1873 return( PSA_SUCCESS );
1874}
1875
Gilles Peskine4747d192019-04-17 15:05:45 +02001876psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001877 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001878 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001879 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001880{
1881 psa_status_t status;
1882 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001883 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001884 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301885 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001886
Ronald Cron81709fc2020-11-14 12:10:32 +01001887 *key = MBEDTLS_SVC_KEY_ID_INIT;
1888
Gilles Peskine0f84d622019-09-12 19:03:13 +02001889 /* Reject zero-length symmetric keys (including raw data key objects).
1890 * This also rejects any key which might be encoded as an empty string,
1891 * which is never valid. */
1892 if( data_length == 0 )
1893 return( PSA_ERROR_INVALID_ARGUMENT );
1894
Archana6ed4bda2021-08-04 10:47:15 +05301895 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1896 if( data_length > SIZE_MAX / 8 )
1897 return( PSA_ERROR_NOT_SUPPORTED );
1898
Gilles Peskinedf179142019-07-15 22:02:14 +02001899 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001900 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 if( status != PSA_SUCCESS )
1902 goto exit;
1903
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001904 /* In the case of a transparent key or an opaque key stored in local
Archana4d7ae1d2021-07-07 02:50:22 +05301905 * storage( thus not in the case of the old-style secure element interface
1906 * (MBEDTLS_PSA_CRYPTO_SE_C)),we have to allocate a buffer to hold the
1907 * imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001908 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001909 {
Archanad8a83dc2021-06-14 10:04:16 +05301910 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1911 {
1912 status = psa_driver_wrapper_get_key_buffer_size_from_key_data( attributes, data,
1913 data_length , &storage_size );
1914 if( status != PSA_SUCCESS )
1915 goto exit;
1916 }
1917 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001918 if( status != PSA_SUCCESS )
1919 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001920 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001921
1922 bits = slot->attr.bits;
1923 status = psa_driver_wrapper_import_key( attributes,
1924 data, data_length,
1925 slot->key.data,
1926 slot->key.bytes,
1927 &slot->key.bytes, &bits );
1928 if( status != PSA_SUCCESS )
1929 goto exit;
1930
1931 if( slot->attr.bits == 0 )
1932 slot->attr.bits = (psa_key_bits_t) bits;
1933 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001934 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001935 status = PSA_ERROR_INVALID_ARGUMENT;
1936 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001937 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001938
Archana6ed4bda2021-08-04 10:47:15 +05301939 /* Enforce a size limit, and in particular ensure that the bit
1940 * size fits in its representation type.*/
1941 if( bits > PSA_MAX_KEY_BITS )
1942 {
1943 status = PSA_ERROR_NOT_SUPPORTED;
1944 goto exit;
1945 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001946 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001947 if( status != PSA_SUCCESS )
1948 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001949
Ronald Cron81709fc2020-11-14 12:10:32 +01001950 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001951exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001952 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001953 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001954
Gilles Peskine4747d192019-04-17 15:05:45 +02001955 return( status );
1956}
1957
Gilles Peskined7729582019-08-05 15:55:54 +02001958#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1959psa_status_t mbedtls_psa_register_se_key(
1960 const psa_key_attributes_t *attributes )
1961{
1962 psa_status_t status;
1963 psa_key_slot_t *slot = NULL;
1964 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001965 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001966
1967 /* Leaving attributes unspecified is not currently supported.
1968 * It could make sense to query the key type and size from the
1969 * secure element, but not all secure elements support this
1970 * and the driver HAL doesn't currently support it. */
1971 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1972 return( PSA_ERROR_NOT_SUPPORTED );
1973 if( psa_get_key_bits( attributes ) == 0 )
1974 return( PSA_ERROR_NOT_SUPPORTED );
1975
1976 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001977 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001978 if( status != PSA_SUCCESS )
1979 goto exit;
1980
Ronald Cron81709fc2020-11-14 12:10:32 +01001981 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001982
1983exit:
1984 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001985 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001986
Gilles Peskined7729582019-08-05 15:55:54 +02001987 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001988 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001989 return( status );
1990}
1991#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1992
Gilles Peskinef603c712019-01-19 13:40:11 +01001993static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001994 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001995{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001996 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001997 source->key.data,
1998 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001999 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002000 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002001
Steven Cooreman398aee52020-10-13 14:35:45 +02002002 target->attr.type = source->attr.type;
2003 target->attr.bits = source->attr.bits;
2004
2005 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002006}
2007
Ronald Croncf56a0a2020-08-04 09:51:30 +02002008psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002009 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002010 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002011{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002013 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002014 psa_key_slot_t *source_slot = NULL;
2015 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002016 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002017 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002018
Ronald Cron81709fc2020-11-14 12:10:32 +01002019 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2020
Ronald Cron5c522922020-11-14 16:35:34 +01002021 status = psa_get_and_lock_transparent_key_slot_with_policy(
2022 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002023 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002024 goto exit;
2025
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002026 status = psa_validate_optional_attributes( source_slot,
2027 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002028 if( status != PSA_SUCCESS )
2029 goto exit;
2030
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002031 status = psa_restrict_key_policy( source_slot->attr.type,
2032 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002033 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002034 if( status != PSA_SUCCESS )
2035 goto exit;
2036
Ronald Cron81709fc2020-11-14 12:10:32 +01002037 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2038 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002039 if( status != PSA_SUCCESS )
2040 goto exit;
2041
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002042#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2043 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002044 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002045 /* Copying to a secure element is not implemented yet. */
2046 status = PSA_ERROR_NOT_SUPPORTED;
2047 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002048 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002049#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002050
Ronald Cron6cc66312021-04-02 12:27:47 +02002051 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2052 {
2053 /*
2054 * Copying through an opaque driver is not implemented yet, consider
2055 * a lifetime with an external location as an invalid parameter for
2056 * now.
2057 */
2058 status = PSA_ERROR_INVALID_ARGUMENT;
2059 goto exit;
2060 }
2061
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002062 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002063 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002064 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002065
Ronald Cron81709fc2020-11-14 12:10:32 +01002066 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002067exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002068 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002069 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002070
Ronald Cron5c522922020-11-14 16:35:34 +01002071 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002072
Ronald Cron5c522922020-11-14 16:35:34 +01002073 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002074}
2075
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002076
2077
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002078/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002079/* Message digests */
2080/****************************************************************/
2081
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002082psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2083{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002084 /* Aborting a non-active operation is allowed */
2085 if( operation->id == 0 )
2086 return( PSA_SUCCESS );
2087
2088 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2089 operation->id = 0;
2090
2091 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002092}
2093
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002094psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002095 psa_algorithm_t alg )
2096{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002098
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002099 /* A context must be freshly initialized before it can be set up. */
2100 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002101 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002102 status = PSA_ERROR_BAD_STATE;
2103 goto exit;
2104 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002105
2106 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002107 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002108 status = PSA_ERROR_INVALID_ARGUMENT;
2109 goto exit;
2110 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002111
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002112 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2113 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002114 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2115
Dave Rodgman685b6a72021-06-24 11:49:14 +01002116 status = psa_driver_wrapper_hash_setup( operation, alg );
2117
2118exit:
2119 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002120 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002121
2122 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002123}
2124
2125psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2126 const uint8_t *input,
2127 size_t input_length )
2128{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2130
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002131 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002132 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002133 status = PSA_ERROR_BAD_STATE;
2134 goto exit;
2135 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002136
Steven Cooremanc8288352021-03-04 14:02:19 +01002137 /* Don't require hash implementations to behave correctly on a
2138 * zero-length input, which may have an invalid pointer. */
2139 if( input_length == 0 )
2140 return( PSA_SUCCESS );
2141
Dave Rodgman685b6a72021-06-24 11:49:14 +01002142 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2143
2144exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002145 if( status != PSA_SUCCESS )
2146 psa_hash_abort( operation );
2147
2148 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002149}
2150
2151psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2152 uint8_t *hash,
2153 size_t hash_size,
2154 size_t *hash_length )
2155{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002156 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157 if( operation->id == 0 )
2158 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002159
Steven Cooreman1e582352021-02-18 17:24:37 +01002160 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002161 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002162 psa_hash_abort( operation );
2163 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002164}
2165
Gilles Peskine2d277862018-06-18 15:41:12 +02002166psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2167 const uint8_t *hash,
2168 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002169{
2170 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2171 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002172 psa_status_t status = psa_hash_finish(
2173 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002174 actual_hash, sizeof( actual_hash ),
2175 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002176
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002178 goto exit;
2179
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002180 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002181 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002182 status = PSA_ERROR_INVALID_SIGNATURE;
2183 goto exit;
2184 }
2185
Steven Cooreman36876a02021-04-29 16:37:59 +02002186 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002187 status = PSA_ERROR_INVALID_SIGNATURE;
2188
2189exit:
2190 if( status != PSA_SUCCESS )
2191 psa_hash_abort(operation);
2192
2193 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194}
2195
Gilles Peskine0a749c82019-11-28 19:33:58 +01002196psa_status_t psa_hash_compute( psa_algorithm_t alg,
2197 const uint8_t *input, size_t input_length,
2198 uint8_t *hash, size_t hash_size,
2199 size_t *hash_length )
2200{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002201 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002202 if( !PSA_ALG_IS_HASH( alg ) )
2203 return( PSA_ERROR_INVALID_ARGUMENT );
2204
Steven Cooreman1e582352021-02-18 17:24:37 +01002205 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2206 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002207}
2208
2209psa_status_t psa_hash_compare( psa_algorithm_t alg,
2210 const uint8_t *input, size_t input_length,
2211 const uint8_t *hash, size_t hash_length )
2212{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002213 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2214 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002215
2216 if( !PSA_ALG_IS_HASH( alg ) )
2217 return( PSA_ERROR_INVALID_ARGUMENT );
2218
Steven Cooreman1e582352021-02-18 17:24:37 +01002219 psa_status_t status = psa_driver_wrapper_hash_compute(
2220 alg, input, input_length,
2221 actual_hash, sizeof(actual_hash),
2222 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002223 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002224 return( status );
2225 if( actual_hash_length != hash_length )
2226 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002227 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002228 return( PSA_ERROR_INVALID_SIGNATURE );
2229 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002230}
2231
Gilles Peskineeb35d782019-01-22 17:56:16 +01002232psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2233 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002234{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002235 if( source_operation->id == 0 ||
2236 target_operation->id != 0 )
2237 {
2238 return( PSA_ERROR_BAD_STATE );
2239 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002240
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002241 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2242 target_operation );
2243 if( status != PSA_SUCCESS )
2244 psa_hash_abort( target_operation );
2245
2246 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002247}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002248
2249
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002251/* MAC */
2252/****************************************************************/
2253
Steven Cooremane6804192021-03-19 18:28:56 +01002254psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002255{
Steven Cooremane6804192021-03-19 18:28:56 +01002256 /* Aborting a non-active operation is allowed */
2257 if( operation->id == 0 )
2258 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002259
Steven Cooremane6804192021-03-19 18:28:56 +01002260 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002261 operation->mac_size = 0;
2262 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002263 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002264
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002265 return( status );
2266}
2267
Ronald Cron2dff3b22021-06-17 16:33:22 +02002268static psa_status_t psa_mac_finalize_alg_and_key_validation(
2269 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002270 const psa_key_attributes_t *attributes,
2271 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002272{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002273 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002274 psa_key_type_t key_type = psa_get_key_type( attributes );
2275 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002276
Ronald Cron28ea0502021-06-17 16:10:24 +02002277 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002278 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002279
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002280 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002281 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002282 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002283 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002284
Steven Cooremand1a68f12021-05-10 11:13:41 +02002285 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002286 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002287
Ronald Cron79bdd822021-06-17 16:46:44 +02002288 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002289 {
2290 /* A very short MAC is too short for security since it can be
2291 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2292 * so we make this our minimum, even though 32 bits is still
2293 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002294 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002295 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002296
Ronald Cron79bdd822021-06-17 16:46:44 +02002297 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2298 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002299 {
2300 /* It's impossible to "truncate" to a larger length than the full length
2301 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002302 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002303 }
2304
Ronald Cron79bdd822021-06-17 16:46:44 +02002305 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002306}
2307
Gilles Peskinee59236f2018-01-27 23:32:46 +01002308static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2309 mbedtls_svc_key_id_t key,
2310 psa_algorithm_t alg,
2311 int is_sign )
2312{
2313 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2314 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002315 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002316
2317 /* A context must be freshly initialized before it can be set up. */
2318 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002319 {
Dave Rodgman54648242021-06-24 11:49:45 +01002320 status = PSA_ERROR_BAD_STATE;
2321 goto exit;
2322 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002323
Gilles Peskine8c9def32018-02-08 10:02:12 +01002324 status = psa_get_and_lock_key_slot_with_policy(
2325 key,
2326 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002327 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328 alg );
2329 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002330 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002331
2332 psa_key_attributes_t attributes = {
2333 .core = slot->attr
2334 };
2335
Ronald Cron79bdd822021-06-17 16:46:44 +02002336 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2337 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002338 if( status != PSA_SUCCESS )
2339 goto exit;
2340
2341 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002342 /* Dispatch the MAC setup call with validated input */
2343 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002344 {
Steven Cooremane6804192021-03-19 18:28:56 +01002345 status = psa_driver_wrapper_mac_sign_setup( operation,
2346 &attributes,
2347 slot->key.data,
2348 slot->key.bytes,
2349 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002350 }
2351 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002352 {
Steven Cooremane6804192021-03-19 18:28:56 +01002353 status = psa_driver_wrapper_mac_verify_setup( operation,
2354 &attributes,
2355 slot->key.data,
2356 slot->key.bytes,
2357 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002358 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002359
Gilles Peskinefbfac682018-07-08 20:51:54 +02002360exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002361 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002362 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002363
Ronald Cron5c522922020-11-14 16:35:34 +01002364 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002365
Ronald Cron5c522922020-11-14 16:35:34 +01002366 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002367}
2368
Gilles Peskine89167cb2018-07-08 20:12:23 +02002369psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002370 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002371 psa_algorithm_t alg )
2372{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002373 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002374}
2375
2376psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002377 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002378 psa_algorithm_t alg )
2379{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002380 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002381}
2382
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002383psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002384 const uint8_t *input,
2385 size_t input_length )
2386{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002387 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002388 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002389
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002390 /* Don't require hash implementations to behave correctly on a
2391 * zero-length input, which may have an invalid pointer. */
2392 if( input_length == 0 )
2393 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002394
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002395 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2396 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002397 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002398 psa_mac_abort( operation );
2399
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002400 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002401}
2402
Steven Cooremana5b860a2021-03-19 19:04:39 +01002403psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002404 uint8_t *mac,
2405 size_t mac_size,
2406 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002407{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2409 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002410
Steven Cooremana5b860a2021-03-19 19:04:39 +01002411 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002412 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002413 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002414 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002415 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002416
Steven Cooreman72f736a2021-05-07 14:14:37 +02002417 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002418 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002419 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002420 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002421 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002422
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002423 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2424 * once all the error checks are done. */
2425 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002426 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002427 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002428 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002429 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002430
2431 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002432 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002433 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002434 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002435 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002436
Steven Cooremana5b860a2021-03-19 19:04:39 +01002437 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002438 mac, operation->mac_size,
2439 mac_length );
2440
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002441exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002442 /* In case of success, set the potential excess room in the output buffer
2443 * to an invalid value, to avoid potentially leaking a longer MAC.
2444 * In case of error, set the output length and content to a safe default,
2445 * such that in case the caller misses an error check, the output would be
2446 * an unachievable MAC.
2447 */
2448 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002449 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002450 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002451 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002452 }
mohammad16036df908f2018-04-02 08:34:15 -07002453
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002454 if( mac_size > operation->mac_size )
2455 memset( &mac[operation->mac_size], '!',
2456 mac_size - operation->mac_size );
2457
Steven Cooremana5b860a2021-03-19 19:04:39 +01002458 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002459
Steven Cooremana5b860a2021-03-19 19:04:39 +01002460 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002461}
2462
Steven Cooremana5b860a2021-03-19 19:04:39 +01002463psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002464 const uint8_t *mac,
2465 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002466{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002467 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2468 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002469
Steven Cooremana5b860a2021-03-19 19:04:39 +01002470 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002471 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002472 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002473 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002474 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002475
Steven Cooreman72f736a2021-05-07 14:14:37 +02002476 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002477 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002478 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002479 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002480 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002481
2482 if( operation->mac_size != mac_length )
2483 {
2484 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002485 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002486 }
2487
Steven Cooremana5b860a2021-03-19 19:04:39 +01002488 status = psa_driver_wrapper_mac_verify_finish( operation,
2489 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002490
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002491exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002492 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002493
Steven Cooremana5b860a2021-03-19 19:04:39 +01002494 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002495}
2496
Ronald Croncd989b52021-06-18 14:23:33 +02002497static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2498 psa_algorithm_t alg,
2499 const uint8_t *input,
2500 size_t input_length,
2501 uint8_t *mac,
2502 size_t mac_size,
2503 size_t *mac_length,
2504 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002505{
2506 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002507 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2508 psa_key_slot_t *slot;
2509 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002510
Ronald Cron51131b52021-06-17 17:17:20 +02002511 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002512 key,
2513 &slot,
2514 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002515 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002516 if( status != PSA_SUCCESS )
2517 goto exit;
2518
Ronald Cron51131b52021-06-17 17:17:20 +02002519 psa_key_attributes_t attributes = {
2520 .core = slot->attr
2521 };
2522
2523 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2524 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002525 if( status != PSA_SUCCESS )
2526 goto exit;
2527
Ronald Cron51131b52021-06-17 17:17:20 +02002528 if( mac_size < operation_mac_size )
2529 {
2530 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002531 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002532 }
2533
2534 status = psa_driver_wrapper_mac_compute(
2535 &attributes,
2536 slot->key.data, slot->key.bytes,
2537 alg,
2538 input, input_length,
2539 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002540
2541exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002542 /* In case of success, set the potential excess room in the output buffer
2543 * to an invalid value, to avoid potentially leaking a longer MAC.
2544 * In case of error, set the output length and content to a safe default,
2545 * such that in case the caller misses an error check, the output would be
2546 * an unachievable MAC.
2547 */
2548 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002549 {
Ronald Cron51131b52021-06-17 17:17:20 +02002550 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002551 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002552 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002553 if( mac_size > operation_mac_size )
2554 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002555
Ronald Cron51131b52021-06-17 17:17:20 +02002556 unlock_status = psa_unlock_key_slot( slot );
2557
2558 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002559}
2560
Ronald Croncd989b52021-06-18 14:23:33 +02002561psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2562 psa_algorithm_t alg,
2563 const uint8_t *input,
2564 size_t input_length,
2565 uint8_t *mac,
2566 size_t mac_size,
2567 size_t *mac_length)
2568{
2569 return( psa_mac_compute_internal( key, alg,
2570 input, input_length,
2571 mac, mac_size, mac_length, 1 ) );
2572}
2573
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002574psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2575 psa_algorithm_t alg,
2576 const uint8_t *input,
2577 size_t input_length,
2578 const uint8_t *mac,
2579 size_t mac_length)
2580{
2581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002582 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2583 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002584
Ronald Crona587cbc2021-06-18 14:51:29 +02002585 status = psa_mac_compute_internal( key, alg,
2586 input, input_length,
2587 actual_mac, sizeof( actual_mac ),
2588 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002589 if( status != PSA_SUCCESS )
2590 goto exit;
2591
Ronald Crona587cbc2021-06-18 14:51:29 +02002592 if( mac_length != actual_mac_length )
2593 {
2594 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002595 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002596 }
2597 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2598 {
2599 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002600 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002601 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602
2603exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002604 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002605
2606 return ( status );
2607}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002608
Gilles Peskinee59236f2018-01-27 23:32:46 +01002609/****************************************************************/
2610/* Asymmetric cryptography */
2611/****************************************************************/
2612
gabor-mezei-armf0486182021-05-12 11:03:09 +02002613static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002614 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002615{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002616 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002617 {
2618 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2619 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002620
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002621 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2622 {
2623 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2624 return( PSA_ERROR_INVALID_ARGUMENT );
2625 }
2626 }
2627 else
2628 {
2629 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2630 return( PSA_ERROR_INVALID_ARGUMENT );
2631 }
2632
2633 return( PSA_SUCCESS );
2634}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002635
2636static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002637 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002638 psa_algorithm_t alg,
2639 const uint8_t * input,
2640 size_t input_length,
2641 uint8_t * signature,
2642 size_t signature_size,
2643 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002644{
2645 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2646 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2647 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002648
2649 *signature_length = 0;
2650
gabor-mezei-armf0486182021-05-12 11:03:09 +02002651 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002652 if( status != PSA_SUCCESS )
2653 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002654
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002655 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002656 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002657 * buffer can in principle be empty since it doesn't actually have
2658 * to be a hash.) */
2659 if( signature_size == 0 )
2660 return( PSA_ERROR_BUFFER_TOO_SMALL );
2661
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002662 status = psa_get_and_lock_key_slot_with_policy(
2663 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002664 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2665 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002666 alg );
2667
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002668 if( status != PSA_SUCCESS )
2669 goto exit;
2670
2671 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2672 {
2673 status = PSA_ERROR_INVALID_ARGUMENT;
2674 goto exit;
2675 }
2676
2677 psa_key_attributes_t attributes = {
2678 .core = slot->attr
2679 };
2680
gabor-mezei-armf0486182021-05-12 11:03:09 +02002681 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002682 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002683 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002684 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002685 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002686 signature, signature_size, signature_length );
2687 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002688 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002689 {
2690
2691 status = psa_driver_wrapper_sign_hash(
2692 &attributes, slot->key.data, slot->key.bytes,
2693 alg, input, input_length,
2694 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002695 }
2696
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002697
2698exit:
2699 /* Fill the unused part of the output buffer (the whole buffer on error,
2700 * the trailing part on success) with something that isn't a valid signature
2701 * (barring an attack on the signature and deliberately-crafted input),
2702 * in case the caller doesn't check the return status properly. */
2703 if( status == PSA_SUCCESS )
2704 memset( signature + *signature_length, '!',
2705 signature_size - *signature_length );
2706 else
2707 memset( signature, '!', signature_size );
2708 /* If signature_size is 0 then we have nothing to do. We must not call
2709 * memset because signature may be NULL in this case. */
2710
2711 unlock_status = psa_unlock_key_slot( slot );
2712
2713 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2714}
2715
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002716static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002717 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002718 psa_algorithm_t alg,
2719 const uint8_t * input,
2720 size_t input_length,
2721 const uint8_t * signature,
2722 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002723{
2724 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2725 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2726 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002727
gabor-mezei-armf0486182021-05-12 11:03:09 +02002728 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002729 if( status != PSA_SUCCESS )
2730 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002731
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002732 status = psa_get_and_lock_key_slot_with_policy(
2733 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002734 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2735 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002736 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002737
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002738 if( status != PSA_SUCCESS )
2739 return( status );
2740
2741 psa_key_attributes_t attributes = {
2742 .core = slot->attr
2743 };
2744
gabor-mezei-armf0486182021-05-12 11:03:09 +02002745 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002746 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002747 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002748 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002749 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002750 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002751 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002752 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002753 {
2754 status = psa_driver_wrapper_verify_hash(
2755 &attributes, slot->key.data, slot->key.bytes,
2756 alg, input, input_length,
2757 signature, signature_length );
2758 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002759
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002760 unlock_status = psa_unlock_key_slot( slot );
2761
2762 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002763
2764}
2765
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002766psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002767 const psa_key_attributes_t *attributes,
2768 const uint8_t *key_buffer,
2769 size_t key_buffer_size,
2770 psa_algorithm_t alg,
2771 const uint8_t *input,
2772 size_t input_length,
2773 uint8_t *signature,
2774 size_t signature_size,
2775 size_t *signature_length )
2776{
2777 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002778
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002779 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2780 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002781 size_t hash_length;
2782 uint8_t hash[PSA_HASH_MAX_SIZE];
2783
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002784 status = psa_driver_wrapper_hash_compute(
2785 PSA_ALG_SIGN_GET_HASH( alg ),
2786 input, input_length,
2787 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002788
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002789 if( status != PSA_SUCCESS )
2790 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002791
2792 return psa_driver_wrapper_sign_hash(
2793 attributes, key_buffer, key_buffer_size,
2794 alg, hash, hash_length,
2795 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002796 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002797
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002798 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002799}
2800
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002801psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2802 psa_algorithm_t alg,
2803 const uint8_t * input,
2804 size_t input_length,
2805 uint8_t * signature,
2806 size_t signature_size,
2807 size_t * signature_length )
2808{
2809 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002810 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002811 signature, signature_size, signature_length );
2812}
2813
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002814psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002815 const psa_key_attributes_t *attributes,
2816 const uint8_t *key_buffer,
2817 size_t key_buffer_size,
2818 psa_algorithm_t alg,
2819 const uint8_t *input,
2820 size_t input_length,
2821 const uint8_t *signature,
2822 size_t signature_length )
2823{
2824 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002825
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002826 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2827 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002828 size_t hash_length;
2829 uint8_t hash[PSA_HASH_MAX_SIZE];
2830
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002831 status = psa_driver_wrapper_hash_compute(
2832 PSA_ALG_SIGN_GET_HASH( alg ),
2833 input, input_length,
2834 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002835
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002836 if( status != PSA_SUCCESS )
2837 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002838
2839 return psa_driver_wrapper_verify_hash(
2840 attributes, key_buffer, key_buffer_size,
2841 alg, hash, hash_length,
2842 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002843 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002844
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002845 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002846}
2847
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002848psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2849 psa_algorithm_t alg,
2850 const uint8_t * input,
2851 size_t input_length,
2852 const uint8_t * signature,
2853 size_t signature_length )
2854{
2855 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002856 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002857 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002858}
2859
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002860psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002861 const psa_key_attributes_t *attributes,
2862 const uint8_t *key_buffer, size_t key_buffer_size,
2863 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2864 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002865{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002866 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002867 {
Ronald Cron4501c982021-03-19 20:09:32 +01002868 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2869 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002870 {
Ronald Cron4501c982021-03-19 20:09:32 +01002871#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2872 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2873 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002874 attributes,
2875 key_buffer, key_buffer_size,
2876 alg, hash, hash_length,
2877 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002878#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2879 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002880 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002881 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002882 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002883 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002884 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002885 }
2886 else
Ronald Cron4501c982021-03-19 20:09:32 +01002887 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2888 {
2889 if( PSA_ALG_IS_ECDSA( alg ) )
2890 {
2891#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2892 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2893 return( mbedtls_psa_ecdsa_sign_hash(
2894 attributes,
2895 key_buffer, key_buffer_size,
2896 alg, hash, hash_length,
2897 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002898#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2899 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002900 }
2901 else
2902 {
2903 return( PSA_ERROR_INVALID_ARGUMENT );
2904 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002905 }
Ronald Cron4501c982021-03-19 20:09:32 +01002906
2907 (void)key_buffer;
2908 (void)key_buffer_size;
2909 (void)hash;
2910 (void)hash_length;
2911 (void)signature;
2912 (void)signature_size;
2913 (void)signature_length;
2914
2915 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002916}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002917
2918psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2919 psa_algorithm_t alg,
2920 const uint8_t *hash,
2921 size_t hash_length,
2922 uint8_t *signature,
2923 size_t signature_size,
2924 size_t *signature_length )
2925{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002926 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002927 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002928 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002929}
2930
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002931psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002932 const psa_key_attributes_t *attributes,
2933 const uint8_t *key_buffer, size_t key_buffer_size,
2934 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2935 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002936{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002937 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002938 {
Ronald Cron4501c982021-03-19 20:09:32 +01002939 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2940 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002941 {
Ronald Cron4501c982021-03-19 20:09:32 +01002942#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2943 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2944 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002945 attributes,
2946 key_buffer, key_buffer_size,
2947 alg, hash, hash_length,
2948 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002949#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2950 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002951 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002952 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002953 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002954 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002955 }
itayzafrir5c753392018-05-08 11:18:38 +03002956 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002957 else
Ronald Cron4501c982021-03-19 20:09:32 +01002958 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002959 {
Ronald Cron4501c982021-03-19 20:09:32 +01002960 if( PSA_ALG_IS_ECDSA( alg ) )
2961 {
2962#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2963 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2964 return( mbedtls_psa_ecdsa_verify_hash(
2965 attributes,
2966 key_buffer, key_buffer_size,
2967 alg, hash, hash_length,
2968 signature, signature_length ) );
2969#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2970 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2971 }
2972 else
2973 {
2974 return( PSA_ERROR_INVALID_ARGUMENT );
2975 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002976 }
Ronald Cron4501c982021-03-19 20:09:32 +01002977
2978 (void)key_buffer;
2979 (void)key_buffer_size;
2980 (void)hash;
2981 (void)hash_length;
2982 (void)signature;
2983 (void)signature_length;
2984
2985 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002986}
2987
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002988psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2989 psa_algorithm_t alg,
2990 const uint8_t *hash,
2991 size_t hash_length,
2992 const uint8_t *signature,
2993 size_t signature_length )
2994{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002995 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002996 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002997 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002998}
2999
John Durkop0e005192020-10-31 22:06:54 -07003000#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003001static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3002 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003003{
3004 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3005 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3006 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003007
3008 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003009}
John Durkop0e005192020-10-31 22:06:54 -07003010#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003011
Ronald Croncf56a0a2020-08-04 09:51:30 +02003012psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003013 psa_algorithm_t alg,
3014 const uint8_t *input,
3015 size_t input_length,
3016 const uint8_t *salt,
3017 size_t salt_length,
3018 uint8_t *output,
3019 size_t output_size,
3020 size_t *output_length )
3021{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003022 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003023 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003024 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003025
Darryl Green5cc689a2018-07-24 15:34:10 +01003026 (void) input;
3027 (void) input_length;
3028 (void) salt;
3029 (void) output;
3030 (void) output_size;
3031
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003032 *output_length = 0;
3033
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003034 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3035 return( PSA_ERROR_INVALID_ARGUMENT );
3036
Ronald Cron5c522922020-11-14 16:35:34 +01003037 status = psa_get_and_lock_transparent_key_slot_with_policy(
3038 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003039 if( status != PSA_SUCCESS )
3040 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003041 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3042 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003043 {
3044 status = PSA_ERROR_INVALID_ARGUMENT;
3045 goto exit;
3046 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003047
John Durkop6ba40d12020-11-10 08:50:04 -08003048#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3049 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003050 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003051 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003052 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003053 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3054 slot->key.data,
3055 slot->key.bytes,
3056 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003057 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003058 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003059
3060 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003061 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003062 status = PSA_ERROR_BUFFER_TOO_SMALL;
3063 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003064 }
John Durkop0e005192020-10-31 22:06:54 -07003065#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003066 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3067 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003068 status = mbedtls_to_psa_error(
3069 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003070 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003071 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003072 input_length,
3073 input,
3074 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075 }
3076 else
John Durkop0e005192020-10-31 22:06:54 -07003077#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3078#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003079 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3080 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003081 status = mbedtls_to_psa_error(
3082 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3083 if( status != PSA_SUCCESS )
3084 goto rsa_exit;
3085
Steven Cooreman4fed4552020-08-03 14:46:03 +02003086 status = mbedtls_to_psa_error(
3087 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003088 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003089 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003090 salt, salt_length,
3091 input_length,
3092 input,
3093 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003094 }
3095 else
John Durkop0e005192020-10-31 22:06:54 -07003096#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003097 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003098 status = PSA_ERROR_INVALID_ARGUMENT;
3099 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003100 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003101rsa_exit:
3102 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003103 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003104
Steven Cooremana2371e52020-07-28 14:30:39 +02003105 mbedtls_rsa_free( rsa );
3106 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003107 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108 else
John Durkop9814fa22020-11-04 12:28:15 -08003109#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003110 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003111 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003112 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003113 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003114
3115exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003116 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003117
Ronald Cron5c522922020-11-14 16:35:34 +01003118 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003119}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120
Ronald Croncf56a0a2020-08-04 09:51:30 +02003121psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003122 psa_algorithm_t alg,
3123 const uint8_t *input,
3124 size_t input_length,
3125 const uint8_t *salt,
3126 size_t salt_length,
3127 uint8_t *output,
3128 size_t output_size,
3129 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003130{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003131 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003132 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003133 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003134
Darryl Green5cc689a2018-07-24 15:34:10 +01003135 (void) input;
3136 (void) input_length;
3137 (void) salt;
3138 (void) output;
3139 (void) output_size;
3140
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003141 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003142
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003143 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3144 return( PSA_ERROR_INVALID_ARGUMENT );
3145
Ronald Cron5c522922020-11-14 16:35:34 +01003146 status = psa_get_and_lock_transparent_key_slot_with_policy(
3147 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003148 if( status != PSA_SUCCESS )
3149 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003150 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003151 {
3152 status = PSA_ERROR_INVALID_ARGUMENT;
3153 goto exit;
3154 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003155
John Durkop6ba40d12020-11-10 08:50:04 -08003156#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3157 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003158 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003159 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003160 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003161 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3162 slot->key.data,
3163 slot->key.bytes,
3164 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003165 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003166 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003167
Steven Cooremana2371e52020-07-28 14:30:39 +02003168 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003169 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003170 status = PSA_ERROR_INVALID_ARGUMENT;
3171 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003172 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003173
John Durkop0e005192020-10-31 22:06:54 -07003174#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003175 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003176 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003177 status = mbedtls_to_psa_error(
3178 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003179 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003180 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003181 output_length,
3182 input,
3183 output,
3184 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003185 }
3186 else
John Durkop0e005192020-10-31 22:06:54 -07003187#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3188#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003189 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003190 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003191 status = mbedtls_to_psa_error(
3192 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3193 if( status != PSA_SUCCESS )
3194 goto rsa_exit;
3195
Steven Cooreman4fed4552020-08-03 14:46:03 +02003196 status = mbedtls_to_psa_error(
3197 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003198 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003199 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003200 salt, salt_length,
3201 output_length,
3202 input,
3203 output,
3204 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205 }
3206 else
John Durkop0e005192020-10-31 22:06:54 -07003207#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003208 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003209 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003211
Steven Cooreman4fed4552020-08-03 14:46:03 +02003212rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003213 mbedtls_rsa_free( rsa );
3214 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003215 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003216 else
John Durkop6ba40d12020-11-10 08:50:04 -08003217#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3218 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003219 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003220 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003221 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003222
3223exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003224 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003225
Ronald Cron5c522922020-11-14 16:35:34 +01003226 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003227}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003228
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003229
3230
mohammad1603503973b2018-03-12 15:59:30 +02003231/****************************************************************/
3232/* Symmetric cryptography */
3233/****************************************************************/
3234
Ronald Cronab99ac22020-10-01 16:38:28 +02003235static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3236 mbedtls_svc_key_id_t key,
3237 psa_algorithm_t alg,
3238 mbedtls_operation_t cipher_operation )
3239{
3240 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3241 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003242 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003243 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3244 PSA_KEY_USAGE_ENCRYPT :
3245 PSA_KEY_USAGE_DECRYPT );
3246
3247 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003248 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003249 {
Dave Rodgman54648242021-06-24 11:49:45 +01003250 status = PSA_ERROR_BAD_STATE;
3251 goto exit;
3252 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003253
Ronald Cronab99ac22020-10-01 16:38:28 +02003254 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003255 {
Dave Rodgman54648242021-06-24 11:49:45 +01003256 status = PSA_ERROR_INVALID_ARGUMENT;
3257 goto exit;
3258 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003259
Ronald Cronab99ac22020-10-01 16:38:28 +02003260 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3261 if( status != PSA_SUCCESS )
3262 goto exit;
3263
Ronald Cron49fafa92021-03-10 08:34:23 +01003264 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003265 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003266 * so we only set it (in the driver wrapper) after resources have been
3267 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003268 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003269 if( alg == PSA_ALG_ECB_NO_PADDING )
3270 operation->iv_required = 0;
3271 else
3272 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003273 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003274
Ronald Crona4af55f2020-12-14 14:36:06 +01003275 psa_key_attributes_t attributes = {
3276 .core = slot->attr
3277 };
3278
Ronald Cronab99ac22020-10-01 16:38:28 +02003279 /* Try doing the operation through a driver before using software fallback. */
3280 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003281 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3282 &attributes,
3283 slot->key.data,
3284 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003285 alg );
3286 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003287 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3288 &attributes,
3289 slot->key.data,
3290 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003291 alg );
3292
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003293exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003294 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003295 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003296
Ronald Cron5c522922020-11-14 16:35:34 +01003297 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003298
Ronald Cron5c522922020-11-14 16:35:34 +01003299 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003300}
3301
Gilles Peskinefe119512018-07-08 21:39:34 +02003302psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003303 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003304 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003305{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003306 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003307}
3308
Gilles Peskinefe119512018-07-08 21:39:34 +02003309psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003310 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003311 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003312{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003313 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003314}
3315
Gilles Peskinefe119512018-07-08 21:39:34 +02003316psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003317 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003318 size_t iv_size,
3319 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003320{
Ronald Cron6d051732020-10-01 14:10:20 +02003321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003322
Ronald Cron5618a392021-03-26 09:52:26 +01003323 *iv_length = 0;
3324
Ronald Cron49fafa92021-03-10 08:34:23 +01003325 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003326 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003327 status = PSA_ERROR_BAD_STATE;
3328 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003329 }
3330
Steven Cooreman7df02922020-09-09 15:28:49 +02003331 if( operation->iv_set || ! operation->iv_required )
3332 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003333 status = PSA_ERROR_BAD_STATE;
3334 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003335 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003336
Ronald Cron5618a392021-03-26 09:52:26 +01003337 if( iv_size < operation->default_iv_length )
3338 {
3339 status = PSA_ERROR_BUFFER_TOO_SMALL;
3340 goto exit;
3341 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003342
Ronald Cron5618a392021-03-26 09:52:26 +01003343 status = psa_generate_random( iv, operation->default_iv_length );
3344 if( status != PSA_SUCCESS )
3345 goto exit;
3346
3347 status = psa_driver_wrapper_cipher_set_iv( operation,
3348 iv,
3349 operation->default_iv_length );
3350
3351exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003352 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003353 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003354 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003355 *iv_length = operation->default_iv_length;
3356 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003357 else
Moran Peker395db872018-05-31 14:07:14 +03003358 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003359
itayzafrir534bd7c2018-08-02 13:56:32 +03003360 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003361}
3362
Gilles Peskinefe119512018-07-08 21:39:34 +02003363psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003364 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003365 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003366{
Ronald Cron6d051732020-10-01 14:10:20 +02003367 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003368
Ronald Cron49fafa92021-03-10 08:34:23 +01003369 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003370 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003371 status = PSA_ERROR_BAD_STATE;
3372 goto exit;
3373 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003374
Steven Cooreman7df02922020-09-09 15:28:49 +02003375 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003376 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003377 status = PSA_ERROR_BAD_STATE;
3378 goto exit;
3379 }
Ronald Crona0d68172021-03-26 10:15:08 +01003380
3381 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003382 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003383 status = PSA_ERROR_INVALID_ARGUMENT;
3384 goto exit;
3385 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003386
Ronald Crondd24c9b2020-12-15 14:10:01 +01003387 status = psa_driver_wrapper_cipher_set_iv( operation,
3388 iv,
3389 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003390
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003391exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003392 if( status == PSA_SUCCESS )
3393 operation->iv_set = 1;
3394 else
mohammad1603503973b2018-03-12 15:59:30 +02003395 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003396 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003397}
3398
Gilles Peskinee553c652018-06-04 16:22:46 +02003399psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3400 const uint8_t *input,
3401 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003402 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003403 size_t output_size,
3404 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003405{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003407
Ronald Cron49fafa92021-03-10 08:34:23 +01003408 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003409 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003410 status = PSA_ERROR_BAD_STATE;
3411 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003412 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003413
Steven Cooreman7df02922020-09-09 15:28:49 +02003414 if( operation->iv_required && ! operation->iv_set )
3415 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003416 status = PSA_ERROR_BAD_STATE;
3417 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003418 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003419
Ronald Crondd24c9b2020-12-15 14:10:01 +01003420 status = psa_driver_wrapper_cipher_update( operation,
3421 input,
3422 input_length,
3423 output,
3424 output_size,
3425 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003426
3427exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003428 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003429 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003430
itayzafrir534bd7c2018-08-02 13:56:32 +03003431 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003432}
3433
Gilles Peskinee553c652018-06-04 16:22:46 +02003434psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3435 uint8_t *output,
3436 size_t output_size,
3437 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003438{
David Saadab4ecc272019-02-14 13:48:10 +02003439 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003440
Ronald Cron49fafa92021-03-10 08:34:23 +01003441 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003442 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003443 status = PSA_ERROR_BAD_STATE;
3444 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003445 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003446
Steven Cooreman7df02922020-09-09 15:28:49 +02003447 if( operation->iv_required && ! operation->iv_set )
3448 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003449 status = PSA_ERROR_BAD_STATE;
3450 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003451 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003452
Ronald Crondd24c9b2020-12-15 14:10:01 +01003453 status = psa_driver_wrapper_cipher_finish( operation,
3454 output,
3455 output_size,
3456 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003457
3458exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003459 if( status == PSA_SUCCESS )
3460 return( psa_cipher_abort( operation ) );
3461 else
3462 {
3463 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003464 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003465
Steven Cooremanef8575e2020-09-11 11:44:50 +02003466 return( status );
3467 }
mohammad1603503973b2018-03-12 15:59:30 +02003468}
3469
Gilles Peskinee553c652018-06-04 16:22:46 +02003470psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3471{
Ronald Cron49fafa92021-03-10 08:34:23 +01003472 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003473 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003474 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003475 * in use. It's ok to call abort on such an object, and there's
3476 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003477 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003478 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003479
Ronald Crondd24c9b2020-12-15 14:10:01 +01003480 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003481
Ronald Cron49fafa92021-03-10 08:34:23 +01003482 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003483 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003484 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003485
Moran Peker395db872018-05-31 14:07:14 +03003486 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003487}
3488
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003489psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3490 psa_algorithm_t alg,
3491 const uint8_t *input,
3492 size_t input_length,
3493 uint8_t *output,
3494 size_t output_size,
3495 size_t *output_length )
3496{
3497 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003498 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3499 psa_key_slot_t *slot;
3500 psa_key_type_t key_type;
3501 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003502
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003503 *output_length = 0;
3504
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003505 if( ! PSA_ALG_IS_CIPHER( alg ) )
3506 return( PSA_ERROR_INVALID_ARGUMENT );
3507
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003508 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3509 PSA_KEY_USAGE_ENCRYPT,
3510 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003511 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003512 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003513
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003514 psa_key_attributes_t attributes = {
3515 .core = slot->attr
3516 };
3517
3518 key_type = slot->attr.type;
3519 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3520
3521 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003522 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003523 if( output_size < iv_length )
3524 {
3525 status = PSA_ERROR_BUFFER_TOO_SMALL;
3526 goto exit;
3527 }
3528
3529 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003530 if( status != PSA_SUCCESS )
3531 goto exit;
3532 }
3533
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003534 status = psa_driver_wrapper_cipher_encrypt(
3535 &attributes, slot->key.data, slot->key.bytes,
3536 alg, input, input_length,
3537 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003538
3539exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003540 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003541
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003542 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003543}
3544
3545psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3546 psa_algorithm_t alg,
3547 const uint8_t *input,
3548 size_t input_length,
3549 uint8_t *output,
3550 size_t output_size,
3551 size_t *output_length )
3552{
3553 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003554 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3555 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003556
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003557 *output_length = 0;
3558
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003559 if( ! PSA_ALG_IS_CIPHER( alg ) )
3560 return( PSA_ERROR_INVALID_ARGUMENT );
3561
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003562 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3563 PSA_KEY_USAGE_DECRYPT,
3564 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003565 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003566 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003567
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003568 psa_key_attributes_t attributes = {
3569 .core = slot->attr
3570 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003571
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003572 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3573 {
3574 status = PSA_ERROR_INVALID_ARGUMENT;
3575 goto exit;
3576 }
3577
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003578 status = psa_driver_wrapper_cipher_decrypt(
3579 &attributes, slot->key.data, slot->key.bytes,
3580 alg, input, input_length,
3581 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003582
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003583exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003584 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003585
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003586 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003587}
3588
3589
mohammad16035955c982018-04-26 00:53:03 +03003590/****************************************************************/
3591/* AEAD */
3592/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003593
Ronald Croncf56a0a2020-08-04 09:51:30 +02003594psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003595 psa_algorithm_t alg,
3596 const uint8_t *nonce,
3597 size_t nonce_length,
3598 const uint8_t *additional_data,
3599 size_t additional_data_length,
3600 const uint8_t *plaintext,
3601 size_t plaintext_length,
3602 uint8_t *ciphertext,
3603 size_t ciphertext_size,
3604 size_t *ciphertext_length )
3605{
Ronald Cron215633c2021-03-16 17:15:37 +01003606 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3607 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003608
mohammad1603f08a5502018-06-03 15:05:47 +03003609 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003610
Steven Cooremanea7ab132021-03-17 16:28:00 +01003611 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3612 return( PSA_ERROR_NOT_SUPPORTED );
3613
Ronald Cron9a986162021-03-26 12:40:07 +01003614 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003615 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003616 if( status != PSA_SUCCESS )
3617 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003618
Ronald Cron215633c2021-03-16 17:15:37 +01003619 psa_key_attributes_t attributes = {
3620 .core = slot->attr
3621 };
mohammad16035955c982018-04-26 00:53:03 +03003622
Ronald Cronde822812021-03-17 16:08:20 +01003623 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003624 &attributes, slot->key.data, slot->key.bytes,
3625 alg,
3626 nonce, nonce_length,
3627 additional_data, additional_data_length,
3628 plaintext, plaintext_length,
3629 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003630
Gilles Peskineedf9a652018-08-17 18:11:56 +02003631 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3632 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003633
Ronald Cron9f310172021-03-16 16:36:37 +01003634 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003635
mohammad16035955c982018-04-26 00:53:03 +03003636 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003637}
3638
Ronald Croncf56a0a2020-08-04 09:51:30 +02003639psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003640 psa_algorithm_t alg,
3641 const uint8_t *nonce,
3642 size_t nonce_length,
3643 const uint8_t *additional_data,
3644 size_t additional_data_length,
3645 const uint8_t *ciphertext,
3646 size_t ciphertext_length,
3647 uint8_t *plaintext,
3648 size_t plaintext_size,
3649 size_t *plaintext_length )
3650{
Ronald Cron215633c2021-03-16 17:15:37 +01003651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3652 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003653
Gilles Peskineee652a32018-06-01 19:23:52 +02003654 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003655
Steven Cooremanea7ab132021-03-17 16:28:00 +01003656 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3657 return( PSA_ERROR_NOT_SUPPORTED );
3658
Ronald Cron9a986162021-03-26 12:40:07 +01003659 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003660 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003661 if( status != PSA_SUCCESS )
3662 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003663
Ronald Cron215633c2021-03-16 17:15:37 +01003664 psa_key_attributes_t attributes = {
3665 .core = slot->attr
3666 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003667
Ronald Cronde822812021-03-17 16:08:20 +01003668 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003669 &attributes, slot->key.data, slot->key.bytes,
3670 alg,
3671 nonce, nonce_length,
3672 additional_data, additional_data_length,
3673 ciphertext, ciphertext_length,
3674 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003675
Gilles Peskineedf9a652018-08-17 18:11:56 +02003676 if( status != PSA_SUCCESS && plaintext_size != 0 )
3677 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003678
Ronald Cron215633c2021-03-16 17:15:37 +01003679 psa_unlock_key_slot( slot );
3680
Gilles Peskineedf9a652018-08-17 18:11:56 +02003681 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003682}
3683
Gilles Peskinee59236f2018-01-27 23:32:46 +01003684/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003685/* Generators */
3686/****************************************************************/
3687
John Durkop07cc04a2020-11-16 22:08:34 -08003688#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3689 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3690 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3691#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003692#endif /* At least one builtin KDF */
3693
3694#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3695 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3696 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3697static psa_status_t psa_key_derivation_start_hmac(
3698 psa_mac_operation_t *operation,
3699 psa_algorithm_t hash_alg,
3700 const uint8_t *hmac_key,
3701 size_t hmac_key_length )
3702{
3703 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3704 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3705 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3706 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3707 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3708
Steven Cooreman72f736a2021-05-07 14:14:37 +02003709 operation->is_sign = 1;
3710 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3711
Steven Cooreman094a77e2021-05-06 17:58:36 +02003712 status = psa_driver_wrapper_mac_sign_setup( operation,
3713 &attributes,
3714 hmac_key, hmac_key_length,
3715 PSA_ALG_HMAC( hash_alg ) );
3716
3717 psa_reset_key_attributes( &attributes );
3718 return( status );
3719}
3720#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003721
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003722#define HKDF_STATE_INIT 0 /* no input yet */
3723#define HKDF_STATE_STARTED 1 /* got salt */
3724#define HKDF_STATE_KEYED 2 /* got key */
3725#define HKDF_STATE_OUTPUT 3 /* output started */
3726
Gilles Peskinecbe66502019-05-16 16:59:18 +02003727static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003728 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003729{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003730 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3731 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003732 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003733 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003734}
3735
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003736psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003737{
3738 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003739 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003740 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003741 {
3742 /* The object has (apparently) been initialized but it is not
3743 * in use. It's ok to call abort on such an object, and there's
3744 * nothing to do. */
3745 }
3746 else
John Durkopd0321952020-10-29 21:37:36 -07003747#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003748 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003749 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003750 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003751 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003752 }
John Durkop07cc04a2020-11-16 22:08:34 -08003753 else
3754#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3755#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3756 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3757 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003758 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003759 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003760 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003761 if( operation->ctx.tls12_prf.secret != NULL )
3762 {
3763 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3764 operation->ctx.tls12_prf.secret_length );
3765 mbedtls_free( operation->ctx.tls12_prf.secret );
3766 }
3767
Janos Follath6a1d2622019-06-11 10:37:28 +01003768 if( operation->ctx.tls12_prf.seed != NULL )
3769 {
3770 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3771 operation->ctx.tls12_prf.seed_length );
3772 mbedtls_free( operation->ctx.tls12_prf.seed );
3773 }
3774
3775 if( operation->ctx.tls12_prf.label != NULL )
3776 {
3777 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3778 operation->ctx.tls12_prf.label_length );
3779 mbedtls_free( operation->ctx.tls12_prf.label );
3780 }
3781
Steven Cooremana6df6042021-04-29 19:32:25 +02003782 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003783
3784 /* We leave the fields Ai and output_block to be erased safely by the
3785 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003786 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003787 else
John Durkop07cc04a2020-11-16 22:08:34 -08003788#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3789 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003790 {
3791 status = PSA_ERROR_BAD_STATE;
3792 }
Janos Follath083036a2019-06-11 10:22:26 +01003793 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003794 return( status );
3795}
3796
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003797psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003798 size_t *capacity)
3799{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003800 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003801 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003802 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003803 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003804 }
3805
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003806 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003807 return( PSA_SUCCESS );
3808}
3809
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003810psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003811 size_t capacity )
3812{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003813 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003814 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003815 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003816 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003817 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003818 return( PSA_SUCCESS );
3819}
3820
John Durkopd0321952020-10-29 21:37:36 -07003821#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003822/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003823 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003824static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003825 psa_algorithm_t hash_alg,
3826 uint8_t *output,
3827 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003828{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003829 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003830 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003831 psa_status_t status;
3832
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003833 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3834 return( PSA_ERROR_BAD_STATE );
3835 hkdf->state = HKDF_STATE_OUTPUT;
3836
Gilles Peskinebef7f142018-07-12 17:22:21 +02003837 while( output_length != 0 )
3838 {
3839 /* Copy what remains of the current block */
3840 uint8_t n = hash_length - hkdf->offset_in_block;
3841 if( n > output_length )
3842 n = (uint8_t) output_length;
3843 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3844 output += n;
3845 output_length -= n;
3846 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003847 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003848 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003849 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003850 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003851 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003852 * object was corrupted or if this function is called directly
3853 * inside the library. */
3854 if( hkdf->block_number == 0xff )
3855 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003856
3857 /* We need a new block */
3858 ++hkdf->block_number;
3859 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003860
Steven Cooreman094a77e2021-05-06 17:58:36 +02003861 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3862 hash_alg,
3863 hkdf->prk,
3864 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003865 if( status != PSA_SUCCESS )
3866 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003867
Gilles Peskinebef7f142018-07-12 17:22:21 +02003868 if( hkdf->block_number != 1 )
3869 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003870 status = psa_mac_update( &hkdf->hmac,
3871 hkdf->output_block,
3872 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003873 if( status != PSA_SUCCESS )
3874 return( status );
3875 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003876 status = psa_mac_update( &hkdf->hmac,
3877 hkdf->info,
3878 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003879 if( status != PSA_SUCCESS )
3880 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003881 status = psa_mac_update( &hkdf->hmac,
3882 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003883 if( status != PSA_SUCCESS )
3884 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003885 status = psa_mac_sign_finish( &hkdf->hmac,
3886 hkdf->output_block,
3887 sizeof( hkdf->output_block ),
3888 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003889 if( status != PSA_SUCCESS )
3890 return( status );
3891 }
3892
3893 return( PSA_SUCCESS );
3894}
John Durkop07cc04a2020-11-16 22:08:34 -08003895#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003896
John Durkop07cc04a2020-11-16 22:08:34 -08003897#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3898 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003899static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3900 psa_tls12_prf_key_derivation_t *tls12_prf,
3901 psa_algorithm_t alg )
3902{
3903 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003904 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003905 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3906 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003907 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003908
Janos Follath7742fee2019-06-17 12:58:10 +01003909 /* We can't be wanting more output after block 0xff, otherwise
3910 * the capacity check in psa_key_derivation_output_bytes() would have
3911 * prevented this call. It could happen only if the operation
3912 * object was corrupted or if this function is called directly
3913 * inside the library. */
3914 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003915 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003916
3917 /* We need a new block */
3918 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003919 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003920
3921 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3922 *
3923 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3924 *
3925 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3926 * HMAC_hash(secret, A(2) + seed) +
3927 * HMAC_hash(secret, A(3) + seed) + ...
3928 *
3929 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003930 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003931 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003932 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003933 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003934 * is currently extracted as `output_block` and where i is
3935 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003936 */
3937
Steven Cooreman094a77e2021-05-06 17:58:36 +02003938 status = psa_key_derivation_start_hmac( &hmac,
3939 hash_alg,
3940 tls12_prf->secret,
3941 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003942 if( status != PSA_SUCCESS )
3943 goto cleanup;
3944
3945 /* Calculate A(i) where i = tls12_prf->block_number. */
3946 if( tls12_prf->block_number == 1 )
3947 {
3948 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3949 * the variable seed and in this instance means it in the context of the
3950 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003951 status = psa_mac_update( &hmac,
3952 tls12_prf->label,
3953 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003954 if( status != PSA_SUCCESS )
3955 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003956 status = psa_mac_update( &hmac,
3957 tls12_prf->seed,
3958 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003959 if( status != PSA_SUCCESS )
3960 goto cleanup;
3961 }
3962 else
3963 {
3964 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003965 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003966 if( status != PSA_SUCCESS )
3967 goto cleanup;
3968 }
3969
Steven Cooremana6df6042021-04-29 19:32:25 +02003970 status = psa_mac_sign_finish( &hmac,
3971 tls12_prf->Ai, hash_length,
3972 &hmac_output_length );
3973 if( hmac_output_length != hash_length )
3974 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003975 if( status != PSA_SUCCESS )
3976 goto cleanup;
3977
3978 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003979 status = psa_key_derivation_start_hmac( &hmac,
3980 hash_alg,
3981 tls12_prf->secret,
3982 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003983 if( status != PSA_SUCCESS )
3984 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003985 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003986 if( status != PSA_SUCCESS )
3987 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003988 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003989 if( status != PSA_SUCCESS )
3990 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003991 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003992 if( status != PSA_SUCCESS )
3993 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003994 status = psa_mac_sign_finish( &hmac,
3995 tls12_prf->output_block, hash_length,
3996 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003997 if( status != PSA_SUCCESS )
3998 goto cleanup;
3999
Janos Follath7742fee2019-06-17 12:58:10 +01004000
4001cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004002 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004003 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4004 status = cleanup_status;
4005
4006 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004007}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004008
Janos Follath844eb0e2019-06-19 12:10:49 +01004009static psa_status_t psa_key_derivation_tls12_prf_read(
4010 psa_tls12_prf_key_derivation_t *tls12_prf,
4011 psa_algorithm_t alg,
4012 uint8_t *output,
4013 size_t output_length )
4014{
4015 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004016 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004017 psa_status_t status;
4018 uint8_t offset, length;
4019
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004020 switch( tls12_prf->state )
4021 {
4022 case PSA_TLS12_PRF_STATE_LABEL_SET:
4023 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4024 break;
4025 case PSA_TLS12_PRF_STATE_OUTPUT:
4026 break;
4027 default:
4028 return( PSA_ERROR_BAD_STATE );
4029 }
4030
Janos Follath844eb0e2019-06-19 12:10:49 +01004031 while( output_length != 0 )
4032 {
4033 /* Check if we have fully processed the current block. */
4034 if( tls12_prf->left_in_block == 0 )
4035 {
4036 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4037 alg );
4038 if( status != PSA_SUCCESS )
4039 return( status );
4040
4041 continue;
4042 }
4043
4044 if( tls12_prf->left_in_block > output_length )
4045 length = (uint8_t) output_length;
4046 else
4047 length = tls12_prf->left_in_block;
4048
4049 offset = hash_length - tls12_prf->left_in_block;
4050 memcpy( output, tls12_prf->output_block + offset, length );
4051 output += length;
4052 output_length -= length;
4053 tls12_prf->left_in_block -= length;
4054 }
4055
4056 return( PSA_SUCCESS );
4057}
John Durkop07cc04a2020-11-16 22:08:34 -08004058#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4059 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004060
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004061psa_status_t psa_key_derivation_output_bytes(
4062 psa_key_derivation_operation_t *operation,
4063 uint8_t *output,
4064 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004065{
4066 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004067 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004068
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004069 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004070 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004071 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004072 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004073 }
4074
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004075 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004076 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004077 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004078 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004079 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004080 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004081 goto exit;
4082 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004083 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004084 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004085 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004086 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004087 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4088 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004089 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004090 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004091 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004092 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004093 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004094
John Durkopd0321952020-10-29 21:37:36 -07004095#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004096 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004097 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004098 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004099 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004100 output, output_length );
4101 }
Janos Follathadbec812019-06-14 11:05:39 +01004102 else
John Durkop07cc04a2020-11-16 22:08:34 -08004103#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4104#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4105 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004106 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004107 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004108 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004109 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004110 kdf_alg, output,
4111 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004112 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004113 else
John Durkop07cc04a2020-11-16 22:08:34 -08004114#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4115 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004116 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004117 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004118 return( PSA_ERROR_BAD_STATE );
4119 }
4120
4121exit:
4122 if( status != PSA_SUCCESS )
4123 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004124 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004125 * This allows us to differentiate between exhausted operations and
4126 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4127 * operations. */
4128 psa_algorithm_t alg = operation->alg;
4129 psa_key_derivation_abort( operation );
4130 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004131 memset( output, '!', output_length );
4132 }
4133 return( status );
4134}
4135
David Brown7807bf72021-02-09 16:28:23 -07004136#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004137static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4138{
4139 if( data_size >= 8 )
4140 mbedtls_des_key_set_parity( data );
4141 if( data_size >= 16 )
4142 mbedtls_des_key_set_parity( data + 8 );
4143 if( data_size >= 24 )
4144 mbedtls_des_key_set_parity( data + 16 );
4145}
David Brown7807bf72021-02-09 16:28:23 -07004146#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004147
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004148static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004149 psa_key_slot_t *slot,
4150 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004151 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004152{
4153 uint8_t *data = NULL;
4154 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304155 size_t storage_size = bytes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004156 psa_status_t status;
4157
Gilles Peskine8e338702019-07-30 20:06:31 +02004158 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004159 return( PSA_ERROR_INVALID_ARGUMENT );
4160 if( bits % 8 != 0 )
4161 return( PSA_ERROR_INVALID_ARGUMENT );
4162 data = mbedtls_calloc( 1, bytes );
4163 if( data == NULL )
4164 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4165
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004166 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004167 if( status != PSA_SUCCESS )
4168 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004169#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004170 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004171 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004172#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004173
Ronald Cronbf33c932020-11-28 18:06:53 +01004174 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004175 psa_key_attributes_t attributes = {
4176 .core = slot->attr
4177 };
4178
Archanad8a83dc2021-06-14 10:04:16 +05304179 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4180 {
4181 status = psa_driver_wrapper_get_key_buffer_size( &attributes, &storage_size );
4182 if( status != PSA_SUCCESS )
4183 goto exit;
4184 }
4185 status = psa_allocate_buffer_to_slot( slot, storage_size );
4186 if( status != PSA_SUCCESS )
4187 goto exit;
4188
Ronald Cronbf33c932020-11-28 18:06:53 +01004189 status = psa_driver_wrapper_import_key( &attributes,
4190 data, bytes,
4191 slot->key.data,
4192 slot->key.bytes,
4193 &slot->key.bytes, &bits );
4194 if( bits != slot->attr.bits )
4195 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004196
4197exit:
4198 mbedtls_free( data );
4199 return( status );
4200}
4201
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004202psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004203 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004204 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004205{
4206 psa_status_t status;
4207 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004208 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004209
Ronald Cron81709fc2020-11-14 12:10:32 +01004210 *key = MBEDTLS_SVC_KEY_ID_INIT;
4211
Gilles Peskine0f84d622019-09-12 19:03:13 +02004212 /* Reject any attempt to create a zero-length key so that we don't
4213 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4214 if( psa_get_key_bits( attributes ) == 0 )
4215 return( PSA_ERROR_INVALID_ARGUMENT );
4216
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004217 if( ! operation->can_output_key )
4218 return( PSA_ERROR_NOT_PERMITTED );
4219
Ronald Cron81709fc2020-11-14 12:10:32 +01004220 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4221 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004222#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4223 if( driver != NULL )
4224 {
4225 /* Deriving a key in a secure element is not implemented yet. */
4226 status = PSA_ERROR_NOT_SUPPORTED;
4227 }
4228#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004229 if( status == PSA_SUCCESS )
4230 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004231 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004232 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004233 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004234 }
4235 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004236 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004237 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004238 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004239
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004240 return( status );
4241}
4242
Gilles Peskineeab56e42018-07-12 17:12:33 +02004243
4244
4245/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004246/* Key derivation */
4247/****************************************************************/
4248
Steven Cooreman932ffb72021-02-15 12:14:32 +01004249#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004250static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004251 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004252 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004253{
John Durkop07cc04a2020-11-16 22:08:34 -08004254 int is_kdf_alg_supported;
4255
Janos Follath5fe19732019-06-20 15:09:30 +01004256 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4257 * initialisers for this union leave some bytes unspecified.) */
4258 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4259
Gilles Peskine969c5d62019-01-16 15:53:06 +01004260 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004261#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004262 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4263 is_kdf_alg_supported = 1;
4264 else
4265#endif
4266#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4267 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4268 is_kdf_alg_supported = 1;
4269 else
4270#endif
4271#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4272 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4273 is_kdf_alg_supported = 1;
4274 else
4275#endif
4276 is_kdf_alg_supported = 0;
4277
4278 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004279 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004280 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004281 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004282 if( hash_size == 0 )
4283 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004284 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4285 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004286 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004287 {
4288 return( PSA_ERROR_NOT_SUPPORTED );
4289 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004290 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004291 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004292 }
John Durkop07cc04a2020-11-16 22:08:34 -08004293
4294 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004295}
John Durkop07cc04a2020-11-16 22:08:34 -08004296#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004297
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004298psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004299 psa_algorithm_t alg )
4300{
4301 psa_status_t status;
4302
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004303 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004304 return( PSA_ERROR_BAD_STATE );
4305
Gilles Peskine6843c292019-01-18 16:44:49 +01004306 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4307 return( PSA_ERROR_INVALID_ARGUMENT );
4308 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004309 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004310#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004311 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004312 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004313#else
4314 return( PSA_ERROR_NOT_SUPPORTED );
4315#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004316 }
4317 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4318 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004319#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004320 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004321#else
4322 return( PSA_ERROR_NOT_SUPPORTED );
4323#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004324 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004325 else
4326 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004327
4328 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004329 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004330 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004331}
4332
John Durkopd0321952020-10-29 21:37:36 -07004333#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004334static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004335 psa_algorithm_t hash_alg,
4336 psa_key_derivation_step_t step,
4337 const uint8_t *data,
4338 size_t data_length )
4339{
4340 psa_status_t status;
4341 switch( step )
4342 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004343 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004344 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004345 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004346 else
4347 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004348 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4349 hash_alg,
4350 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004351 if( status != PSA_SUCCESS )
4352 return( status );
4353 hkdf->state = HKDF_STATE_STARTED;
4354 return( PSA_SUCCESS );
4355 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004356 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004357 /* If no salt was provided, use an empty salt. */
4358 if( hkdf->state == HKDF_STATE_INIT )
4359 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004360 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4361 hash_alg,
4362 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004363 if( status != PSA_SUCCESS )
4364 return( status );
4365 hkdf->state = HKDF_STATE_STARTED;
4366 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004367 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004368 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004369 status = psa_mac_update( &hkdf->hmac,
4370 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004371 if( status != PSA_SUCCESS )
4372 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004373 status = psa_mac_sign_finish( &hkdf->hmac,
4374 hkdf->prk,
4375 sizeof( hkdf->prk ),
4376 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004377 if( status != PSA_SUCCESS )
4378 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004379 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004380 hkdf->block_number = 0;
4381 hkdf->state = HKDF_STATE_KEYED;
4382 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004383 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004384 if( hkdf->state == HKDF_STATE_OUTPUT )
4385 return( PSA_ERROR_BAD_STATE );
4386 if( hkdf->info_set )
4387 return( PSA_ERROR_BAD_STATE );
4388 hkdf->info_length = data_length;
4389 if( data_length != 0 )
4390 {
4391 hkdf->info = mbedtls_calloc( 1, data_length );
4392 if( hkdf->info == NULL )
4393 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4394 memcpy( hkdf->info, data, data_length );
4395 }
4396 hkdf->info_set = 1;
4397 return( PSA_SUCCESS );
4398 default:
4399 return( PSA_ERROR_INVALID_ARGUMENT );
4400 }
4401}
John Durkop07cc04a2020-11-16 22:08:34 -08004402#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004403
John Durkop07cc04a2020-11-16 22:08:34 -08004404#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4405 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004406static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4407 const uint8_t *data,
4408 size_t data_length )
4409{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004410 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004411 return( PSA_ERROR_BAD_STATE );
4412
Janos Follathd6dce9f2019-07-04 09:11:38 +01004413 if( data_length != 0 )
4414 {
4415 prf->seed = mbedtls_calloc( 1, data_length );
4416 if( prf->seed == NULL )
4417 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004418
Janos Follathd6dce9f2019-07-04 09:11:38 +01004419 memcpy( prf->seed, data, data_length );
4420 prf->seed_length = data_length;
4421 }
Janos Follathf08e2652019-06-13 09:05:41 +01004422
Gilles Peskine43f958b2020-12-13 14:55:14 +01004423 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004424
4425 return( PSA_SUCCESS );
4426}
4427
Janos Follath81550542019-06-13 14:26:34 +01004428static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004429 const uint8_t *data,
4430 size_t data_length )
4431{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004432 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004433 return( PSA_ERROR_BAD_STATE );
4434
Steven Cooremana6df6042021-04-29 19:32:25 +02004435 if( data_length != 0 )
4436 {
4437 prf->secret = mbedtls_calloc( 1, data_length );
4438 if( prf->secret == NULL )
4439 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4440
4441 memcpy( prf->secret, data, data_length );
4442 prf->secret_length = data_length;
4443 }
Janos Follath81550542019-06-13 14:26:34 +01004444
Gilles Peskine43f958b2020-12-13 14:55:14 +01004445 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004446
4447 return( PSA_SUCCESS );
4448}
4449
Janos Follath63028dd2019-06-13 09:15:47 +01004450static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4451 const uint8_t *data,
4452 size_t data_length )
4453{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004454 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004455 return( PSA_ERROR_BAD_STATE );
4456
Janos Follathd6dce9f2019-07-04 09:11:38 +01004457 if( data_length != 0 )
4458 {
4459 prf->label = mbedtls_calloc( 1, data_length );
4460 if( prf->label == NULL )
4461 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004462
Janos Follathd6dce9f2019-07-04 09:11:38 +01004463 memcpy( prf->label, data, data_length );
4464 prf->label_length = data_length;
4465 }
Janos Follath63028dd2019-06-13 09:15:47 +01004466
Gilles Peskine43f958b2020-12-13 14:55:14 +01004467 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004468
4469 return( PSA_SUCCESS );
4470}
4471
Janos Follathb03233e2019-06-11 15:30:30 +01004472static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004473 psa_key_derivation_step_t step,
4474 const uint8_t *data,
4475 size_t data_length )
4476{
Janos Follathb03233e2019-06-11 15:30:30 +01004477 switch( step )
4478 {
Janos Follathf08e2652019-06-13 09:05:41 +01004479 case PSA_KEY_DERIVATION_INPUT_SEED:
4480 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004481 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004482 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004483 case PSA_KEY_DERIVATION_INPUT_LABEL:
4484 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004485 default:
4486 return( PSA_ERROR_INVALID_ARGUMENT );
4487 }
4488}
John Durkop07cc04a2020-11-16 22:08:34 -08004489#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4490 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4491
4492#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4493static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4494 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004495 const uint8_t *data,
4496 size_t data_length )
4497{
4498 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004499 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004500 uint8_t *cur = pms;
4501
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004502 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004503 return( PSA_ERROR_INVALID_ARGUMENT );
4504
4505 /* Quoting RFC 4279, Section 2:
4506 *
4507 * The premaster secret is formed as follows: if the PSK is N octets
4508 * long, concatenate a uint16 with the value N, N zero octets, a second
4509 * uint16 with the value N, and the PSK itself.
4510 */
4511
Joe Subbiani5ecac212021-06-24 13:00:03 +01004512 *cur++ = MBEDTLS_BYTE_1( data_length );
4513 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004514 memset( cur, 0, data_length );
4515 cur += data_length;
4516 *cur++ = pms[0];
4517 *cur++ = pms[1];
4518 memcpy( cur, data, data_length );
4519 cur += data_length;
4520
Steven Cooremana6df6042021-04-29 19:32:25 +02004521 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004522
4523 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4524 return( status );
4525}
Janos Follath6660f0e2019-06-17 08:44:03 +01004526
4527static psa_status_t psa_tls12_prf_psk_to_ms_input(
4528 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004529 psa_key_derivation_step_t step,
4530 const uint8_t *data,
4531 size_t data_length )
4532{
4533 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004534 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004535 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004536 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004537 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004538
Steven Cooremana6df6042021-04-29 19:32:25 +02004539 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004540}
John Durkop07cc04a2020-11-16 22:08:34 -08004541#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004542
Gilles Peskineb8965192019-09-24 16:21:10 +02004543/** Check whether the given key type is acceptable for the given
4544 * input step of a key derivation.
4545 *
4546 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4547 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4548 * Both secret and non-secret inputs can alternatively have the type
4549 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4550 * that the input was passed as a buffer rather than via a key object.
4551 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004552static int psa_key_derivation_check_input_type(
4553 psa_key_derivation_step_t step,
4554 psa_key_type_t key_type )
4555{
4556 switch( step )
4557 {
4558 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004559 if( key_type == PSA_KEY_TYPE_DERIVE )
4560 return( PSA_SUCCESS );
4561 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004562 return( PSA_SUCCESS );
4563 break;
4564 case PSA_KEY_DERIVATION_INPUT_LABEL:
4565 case PSA_KEY_DERIVATION_INPUT_SALT:
4566 case PSA_KEY_DERIVATION_INPUT_INFO:
4567 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004568 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4569 return( PSA_SUCCESS );
4570 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004571 return( PSA_SUCCESS );
4572 break;
4573 }
4574 return( PSA_ERROR_INVALID_ARGUMENT );
4575}
4576
Janos Follathb80a94e2019-06-12 15:54:46 +01004577static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004578 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004579 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004580 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004581 const uint8_t *data,
4582 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004583{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004584 psa_status_t status;
4585 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4586
4587 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004588 if( status != PSA_SUCCESS )
4589 goto exit;
4590
John Durkopd0321952020-10-29 21:37:36 -07004591#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004592 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004593 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004594 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004595 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004596 step, data, data_length );
4597 }
John Durkop07cc04a2020-11-16 22:08:34 -08004598 else
4599#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4600#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4601 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004602 {
Janos Follathb03233e2019-06-11 15:30:30 +01004603 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004604 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004605 }
John Durkop07cc04a2020-11-16 22:08:34 -08004606 else
4607#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4608#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4609 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004610 {
4611 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004612 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004613 }
4614 else
John Durkop07cc04a2020-11-16 22:08:34 -08004615#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004616 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004617 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004618 (void) data;
4619 (void) data_length;
4620 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004621 return( PSA_ERROR_BAD_STATE );
4622 }
4623
Gilles Peskine224b0d62019-09-23 18:13:17 +02004624exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004625 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004626 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004627 return( status );
4628}
4629
Janos Follath51f4a0f2019-06-14 11:35:55 +01004630psa_status_t psa_key_derivation_input_bytes(
4631 psa_key_derivation_operation_t *operation,
4632 psa_key_derivation_step_t step,
4633 const uint8_t *data,
4634 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004635{
Gilles Peskineb8965192019-09-24 16:21:10 +02004636 return( psa_key_derivation_input_internal( operation, step,
4637 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004638 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004639}
4640
Janos Follath51f4a0f2019-06-14 11:35:55 +01004641psa_status_t psa_key_derivation_input_key(
4642 psa_key_derivation_operation_t *operation,
4643 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004644 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004645{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004647 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004648 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004649
Ronald Cron5c522922020-11-14 16:35:34 +01004650 status = psa_get_and_lock_transparent_key_slot_with_policy(
4651 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004652 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004653 {
4654 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004655 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004656 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004657
4658 /* Passing a key object as a SECRET input unlocks the permission
4659 * to output to a key object. */
4660 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4661 operation->can_output_key = 1;
4662
Ronald Cronf95a2b12020-10-22 15:24:49 +02004663 status = psa_key_derivation_input_internal( operation,
4664 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004665 slot->key.data,
4666 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004667
Ronald Cron5c522922020-11-14 16:35:34 +01004668 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004669
Ronald Cron5c522922020-11-14 16:35:34 +01004670 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004671}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004672
4673
4674
4675/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004676/* Key agreement */
4677/****************************************************************/
4678
John Durkop6ba40d12020-11-10 08:50:04 -08004679#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004680static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4681 size_t peer_key_length,
4682 const mbedtls_ecp_keypair *our_key,
4683 uint8_t *shared_secret,
4684 size_t shared_secret_size,
4685 size_t *shared_secret_length )
4686{
Steven Cooremand4867872020-08-05 16:31:39 +02004687 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004688 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004689 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004690 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004691 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004692 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004693
Ronald Cron90857082020-11-25 14:58:33 +01004694 status = mbedtls_psa_ecp_load_representation(
4695 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004696 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004697 peer_key,
4698 peer_key_length,
4699 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004700 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004701 goto exit;
4702
Jaeden Amero97271b32019-01-10 19:38:51 +00004703 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004704 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004705 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004706 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004707 status = mbedtls_to_psa_error(
4708 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4709 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004710 goto exit;
4711
Jaeden Amero97271b32019-01-10 19:38:51 +00004712 status = mbedtls_to_psa_error(
4713 mbedtls_ecdh_calc_secret( &ecdh,
4714 shared_secret_length,
4715 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004716 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004717 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004718 if( status != PSA_SUCCESS )
4719 goto exit;
4720 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4721 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004722
4723exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004724 if( status != PSA_SUCCESS )
4725 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004726 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004727 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004728 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004729
Jaeden Amero97271b32019-01-10 19:38:51 +00004730 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004731}
John Durkop6ba40d12020-11-10 08:50:04 -08004732#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004733
Gilles Peskine01d718c2018-09-18 12:01:02 +02004734#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4735
Gilles Peskine0216fe12019-04-11 21:23:21 +02004736static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4737 psa_key_slot_t *private_key,
4738 const uint8_t *peer_key,
4739 size_t peer_key_length,
4740 uint8_t *shared_secret,
4741 size_t shared_secret_size,
4742 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004743{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004744 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004745 {
John Durkop6ba40d12020-11-10 08:50:04 -08004746#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004747 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004748 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004749 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004750 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004751 psa_status_t status = mbedtls_psa_ecp_load_representation(
4752 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004753 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004754 private_key->key.data,
4755 private_key->key.bytes,
4756 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004757 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004758 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004759 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004760 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004761 shared_secret, shared_secret_size,
4762 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004763 mbedtls_ecp_keypair_free( ecp );
4764 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004765 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004766#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004767 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004768 (void) private_key;
4769 (void) peer_key;
4770 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004771 (void) shared_secret;
4772 (void) shared_secret_size;
4773 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004774 return( PSA_ERROR_NOT_SUPPORTED );
4775 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004776}
4777
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004778/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004779 * to potentially free embedded data structures and wipe confidential data.
4780 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004781static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004782 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004783 psa_key_slot_t *private_key,
4784 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004785 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004786{
4787 psa_status_t status;
4788 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4789 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004790 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004791
4792 /* Step 1: run the secret agreement algorithm to generate the shared
4793 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004794 status = psa_key_agreement_raw_internal( ka_alg,
4795 private_key,
4796 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004797 shared_secret,
4798 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004799 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004800 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004801 goto exit;
4802
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004803 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004804 * the shared secret. A shared secret is permitted wherever a key
4805 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004806 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004807 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004808 shared_secret,
4809 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004810exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004811 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004812 return( status );
4813}
4814
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004815psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004816 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004817 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004818 const uint8_t *peer_key,
4819 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004820{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004821 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004822 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004823 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004824
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004825 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004826 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004827 status = psa_get_and_lock_transparent_key_slot_with_policy(
4828 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004829 if( status != PSA_SUCCESS )
4830 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004831 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004832 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004833 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004834 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004835 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004836 else
4837 {
4838 /* If a private key has been added as SECRET, we allow the derived
4839 * key material to be used as a key in PSA Crypto. */
4840 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4841 operation->can_output_key = 1;
4842 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004843
Ronald Cron5c522922020-11-14 16:35:34 +01004844 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004845
Ronald Cron5c522922020-11-14 16:35:34 +01004846 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004847}
4848
Gilles Peskinebe697d82019-05-16 18:00:41 +02004849psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004850 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004851 const uint8_t *peer_key,
4852 size_t peer_key_length,
4853 uint8_t *output,
4854 size_t output_size,
4855 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004856{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004857 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004858 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004859 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004860
4861 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4862 {
4863 status = PSA_ERROR_INVALID_ARGUMENT;
4864 goto exit;
4865 }
Ronald Cron5c522922020-11-14 16:35:34 +01004866 status = psa_get_and_lock_transparent_key_slot_with_policy(
4867 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004868 if( status != PSA_SUCCESS )
4869 goto exit;
4870
4871 status = psa_key_agreement_raw_internal( alg, slot,
4872 peer_key, peer_key_length,
4873 output, output_size,
4874 output_length );
4875
4876exit:
4877 if( status != PSA_SUCCESS )
4878 {
4879 /* If an error happens and is not handled properly, the output
4880 * may be used as a key to protect sensitive data. Arrange for such
4881 * a key to be random, which is likely to result in decryption or
4882 * verification errors. This is better than filling the buffer with
4883 * some constant data such as zeros, which would result in the data
4884 * being protected with a reproducible, easily knowable key.
4885 */
4886 psa_generate_random( output, output_size );
4887 *output_length = output_size;
4888 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004889
Ronald Cron5c522922020-11-14 16:35:34 +01004890 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004891
Ronald Cron5c522922020-11-14 16:35:34 +01004892 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004893}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004894
4895
Gilles Peskine30524eb2020-11-13 17:02:26 +01004896
Gilles Peskine86a440b2018-11-12 18:39:40 +01004897/****************************************************************/
4898/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004899/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004900
Gilles Peskine30524eb2020-11-13 17:02:26 +01004901/** Initialize the PSA random generator.
4902 */
4903static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4904{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004905#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4906 memset( rng, 0, sizeof( *rng ) );
4907#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4908
Gilles Peskine30524eb2020-11-13 17:02:26 +01004909 /* Set default configuration if
4910 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4911 if( rng->entropy_init == NULL )
4912 rng->entropy_init = mbedtls_entropy_init;
4913 if( rng->entropy_free == NULL )
4914 rng->entropy_free = mbedtls_entropy_free;
4915
4916 rng->entropy_init( &rng->entropy );
4917#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4918 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4919 /* The PSA entropy injection feature depends on using NV seed as an entropy
4920 * source. Add NV seed as an entropy source for PSA entropy injection. */
4921 mbedtls_entropy_add_source( &rng->entropy,
4922 mbedtls_nv_seed_poll, NULL,
4923 MBEDTLS_ENTROPY_BLOCK_SIZE,
4924 MBEDTLS_ENTROPY_SOURCE_STRONG );
4925#endif
4926
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004927 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004928#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004929}
4930
4931/** Deinitialize the PSA random generator.
4932 */
4933static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4934{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004935#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4936 memset( rng, 0, sizeof( *rng ) );
4937#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004938 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004939 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004940#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004941}
4942
4943/** Seed the PSA random generator.
4944 */
4945static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4946{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004947#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4948 /* Do nothing: the external RNG seeds itself. */
4949 (void) rng;
4950 return( PSA_SUCCESS );
4951#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004952 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004953 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4954 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004955 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004956#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004957}
4958
Gilles Peskinee59236f2018-01-27 23:32:46 +01004959psa_status_t psa_generate_random( uint8_t *output,
4960 size_t output_size )
4961{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004962 GUARD_MODULE_INITIALIZED;
4963
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004964#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4965
4966 size_t output_length = 0;
4967 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4968 output, output_size,
4969 &output_length );
4970 if( status != PSA_SUCCESS )
4971 return( status );
4972 /* Breaking up a request into smaller chunks is currently not supported
4973 * for the extrernal RNG interface. */
4974 if( output_length != output_size )
4975 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4976 return( PSA_SUCCESS );
4977
4978#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4979
Gilles Peskine71ddab92021-01-04 21:01:07 +01004980 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004981 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004982 size_t request_size =
4983 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4984 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4985 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004986 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4987 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004988 if( ret != 0 )
4989 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004990 output_size -= request_size;
4991 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004992 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004993 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004994#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004995}
4996
Gilles Peskine8814fc42020-12-14 15:33:44 +01004997/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004998 *
4999 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5000 * `psa_generate_random(...)`. The state parameter is ignored since the
5001 * PSA API doesn't support passing an explicit state.
5002 *
5003 * In the non-external case, psa_generate_random() calls an
5004 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5005 * and semantics as mbedtls_psa_get_random(). As an optimization,
5006 * instead of doing this back-and-forth between the PSA API and the
5007 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5008 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005009 */
5010#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5011int mbedtls_psa_get_random( void *p_rng,
5012 unsigned char *output,
5013 size_t output_size )
5014{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005015 /* This function takes a pointer to the RNG state because that's what
5016 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5017 * its own state internally and doesn't let the caller access that state.
5018 * So we just ignore the state parameter, and in practice we'll pass
5019 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005020 (void) p_rng;
5021 psa_status_t status = psa_generate_random( output, output_size );
5022 if( status == PSA_SUCCESS )
5023 return( 0 );
5024 else
5025 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5026}
5027#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5028
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005029#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005030#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005031
Gilles Peskine7228da22019-07-15 11:06:15 +02005032psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005033 size_t seed_size )
5034{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005035 if( global_data.initialized )
5036 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005037
5038 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5039 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5040 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5041 return( PSA_ERROR_INVALID_ARGUMENT );
5042
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005043 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005044}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005045#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005046
Ronald Cron3772afe2021-02-08 16:10:05 +01005047/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005048 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005049 * \param type The key type
5050 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005051 *
5052 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005053 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005054 * \retval #PSA_ERROR_INVALID_ARGUMENT
5055 * The size in bits of the key is not valid.
5056 * \retval #PSA_ERROR_NOT_SUPPORTED
5057 * The type and/or the size in bits of the key or the combination of
5058 * the two is not supported.
5059 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005060static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5061 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005062{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005063 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005064
Gilles Peskinee59236f2018-01-27 23:32:46 +01005065 if( key_type_is_raw_bytes( type ) )
5066 {
Archana4d7ae1d2021-07-07 02:50:22 +05305067 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005068 if( status != PSA_SUCCESS )
5069 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005070 }
5071 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005072#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005073 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5074 {
5075 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5076 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005077
Ronald Cron01b2aba2020-10-05 09:42:02 +02005078 /* Accept only byte-aligned keys, for the same reasons as
5079 * in psa_import_rsa_key(). */
5080 if( bits % 8 != 0 )
5081 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005082 }
5083 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005084#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005085
Ronald Cron5c4d3862020-12-07 11:07:24 +01005086#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005087 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5088 {
Ronald Crond81ab562021-02-16 09:01:16 +01005089 /* To avoid empty block, return successfully here. */
5090 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005091 }
5092 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005093#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005094 {
5095 return( PSA_ERROR_NOT_SUPPORTED );
5096 }
5097
5098 return( PSA_SUCCESS );
5099}
5100
Ronald Cron55ed0592020-10-05 10:30:40 +02005101psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005102 const psa_key_attributes_t *attributes,
5103 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005104{
5105 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005106 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005107
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005108 if( ( attributes->domain_parameters == NULL ) &&
5109 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005110 return( PSA_ERROR_INVALID_ARGUMENT );
5111
Ronald Cron01b2aba2020-10-05 09:42:02 +02005112 if( key_type_is_raw_bytes( type ) )
5113 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005114 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005115 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005116 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005117
David Brown12ca5032021-02-11 11:02:00 -07005118#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005119 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005120 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005121#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005122 }
5123 else
5124
Jaeden Amero424fa932021-05-14 08:34:32 +01005125#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5126 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005127 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005128 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005129 return( mbedtls_psa_rsa_generate_key( attributes,
5130 key_buffer,
5131 key_buffer_size,
5132 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005133 }
5134 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005135#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5136 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005137
John Durkop9814fa22020-11-04 12:28:15 -08005138#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005139 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005140 {
Ronald Cron7023db52020-11-20 18:17:42 +01005141 return( mbedtls_psa_ecp_generate_key( attributes,
5142 key_buffer,
5143 key_buffer_size,
5144 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005145 }
5146 else
John Durkop9814fa22020-11-04 12:28:15 -08005147#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005148 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005149 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005150 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005151 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005152
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005153 return( PSA_SUCCESS );
5154}
Darryl Green0c6575a2018-11-07 16:05:30 +00005155
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005156psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005157 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005158{
5159 psa_status_t status;
5160 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005161 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005162 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005163
Ronald Cron81709fc2020-11-14 12:10:32 +01005164 *key = MBEDTLS_SVC_KEY_ID_INIT;
5165
Gilles Peskine0f84d622019-09-12 19:03:13 +02005166 /* Reject any attempt to create a zero-length key so that we don't
5167 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5168 if( psa_get_key_bits( attributes ) == 0 )
5169 return( PSA_ERROR_INVALID_ARGUMENT );
5170
Ronald Cron81709fc2020-11-14 12:10:32 +01005171 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5172 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005173 if( status != PSA_SUCCESS )
5174 goto exit;
5175
Ronald Cron977c2472020-10-13 08:32:21 +02005176 /* In the case of a transparent key or an opaque key stored in local
Archana4d7ae1d2021-07-07 02:50:22 +05305177 * storage( thus not in the case of the old-style secure element interface
5178 * (MBEDTLS_PSA_CRYPTO_SE_C)),we have to allocate a buffer to hold the
5179 * imported key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005180 if( slot->key.data == NULL )
5181 {
5182 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5183 PSA_KEY_LOCATION_LOCAL_STORAGE )
5184 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005185 status = psa_validate_key_type_and_size_for_key_generation(
5186 attributes->core.type, attributes->core.bits );
5187 if( status != PSA_SUCCESS )
5188 goto exit;
5189
5190 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5191 attributes->core.type,
5192 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005193 }
5194 else
5195 {
5196 status = psa_driver_wrapper_get_key_buffer_size(
5197 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005198 if( status != PSA_SUCCESS )
5199 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005200 }
Ronald Cron977c2472020-10-13 08:32:21 +02005201
5202 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5203 if( status != PSA_SUCCESS )
5204 goto exit;
5205 }
5206
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005207 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005208 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005209
Ronald Cron2b56bc82020-10-05 10:02:26 +02005210 if( status != PSA_SUCCESS )
5211 psa_remove_key_data_from_memory( slot );
5212
Gilles Peskine11792082019-08-06 18:36:36 +02005213exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005214 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005215 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005216 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005217 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005218
Darryl Green0c6575a2018-11-07 16:05:30 +00005219 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005220}
5221
Gilles Peskinee59236f2018-01-27 23:32:46 +01005222/****************************************************************/
5223/* Module setup */
5224/****************************************************************/
5225
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005226#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005227psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5228 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5229 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5230{
5231 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5232 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005233 global_data.rng.entropy_init = entropy_init;
5234 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005235 return( PSA_SUCCESS );
5236}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005237#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005238
Gilles Peskinee59236f2018-01-27 23:32:46 +01005239void mbedtls_psa_crypto_free( void )
5240{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005241 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005242 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5243 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005244 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005245 }
5246 /* Wipe all remaining data, including configuration.
5247 * In particular, this sets all state indicator to the value
5248 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005249 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005250#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005251 /* Unregister all secure element drivers, so that we restart from
5252 * a pristine state. */
5253 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005254#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005255}
5256
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005257#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5258/** Recover a transaction that was interrupted by a power failure.
5259 *
5260 * This function is called during initialization, before psa_crypto_init()
5261 * returns. If this function returns a failure status, the initialization
5262 * fails.
5263 */
5264static psa_status_t psa_crypto_recover_transaction(
5265 const psa_crypto_transaction_t *transaction )
5266{
5267 switch( transaction->unknown.type )
5268 {
5269 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5270 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005271 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005272 * is implemented.
5273 * https://github.com/ARMmbed/mbed-crypto/issues/218
5274 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005275 default:
5276 /* We found an unsupported transaction in the storage.
5277 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005278 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005279 }
5280}
5281#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5282
Gilles Peskinee59236f2018-01-27 23:32:46 +01005283psa_status_t psa_crypto_init( void )
5284{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005285 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005286
Gilles Peskinec6b69072018-11-20 21:42:52 +01005287 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005288 if( global_data.initialized != 0 )
5289 return( PSA_SUCCESS );
5290
Gilles Peskine30524eb2020-11-13 17:02:26 +01005291 /* Initialize and seed the random generator. */
5292 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005293 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005294 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005295 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005296 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005297 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005298
Gilles Peskine66fb1262018-12-10 16:29:04 +01005299 status = psa_initialize_key_slots( );
5300 if( status != PSA_SUCCESS )
5301 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005302
Gilles Peskined9348f22019-10-01 15:22:29 +02005303#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5304 status = psa_init_all_se_drivers( );
5305 if( status != PSA_SUCCESS )
5306 goto exit;
5307#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5308
Gilles Peskine4b734222019-07-24 15:56:31 +02005309#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005310 status = psa_crypto_load_transaction( );
5311 if( status == PSA_SUCCESS )
5312 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005313 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5314 if( status != PSA_SUCCESS )
5315 goto exit;
5316 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005317 }
5318 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5319 {
5320 /* There's no transaction to complete. It's all good. */
5321 status = PSA_SUCCESS;
5322 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005323#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005324
Gilles Peskinec6b69072018-11-20 21:42:52 +01005325 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005326 global_data.initialized = 1;
5327
5328exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005329 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005330 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005331 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005332}
5333
5334#endif /* MBEDTLS_PSA_CRYPTO_C */