blob: d3f7c2eca9f9cec08da35576c0726e92b5ebcba3 [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
Gilles Peskine73167e12019-07-12 23:44:37 +0200325#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
326static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
327{
Gilles Peskine8e338702019-07-30 20:06:31 +0200328 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200329}
330#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
331
John Durkop07cc04a2020-11-16 22:08:34 -0800332/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
333 * current test driver in key_management.c is using this function
334 * when accelerators are used for ECC key pair and public key.
335 * Once that dependency is resolved these guards can be removed.
336 */
John Durkop9814fa22020-11-04 12:28:15 -0800337#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800338 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
339 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
340 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100341mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100342 size_t bits,
343 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200344{
345 switch( curve )
346 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100347 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100348 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100349 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100350#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100351 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100352 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100353#endif
354#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100355 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100356 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100357#endif
358#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100359 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100360 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100361#endif
362#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100363 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100364 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100365#endif
366#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100367 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100368 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100369 case 528:
370 if( bits_is_sloppy )
371 return( MBEDTLS_ECP_DP_SECP521R1 );
372 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100373#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100374 }
375 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100376
Paul Elliott8ff510a2020-06-02 17:19:28 +0100377 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100381 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100382 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100383#endif
384#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100385 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100386 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100387#endif
388#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 }
393 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100394
Paul Elliott8ff510a2020-06-02 17:19:28 +0100395 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100396 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100397 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100398#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100399 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100400 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100401 case 256:
402 if( bits_is_sloppy )
403 return( MBEDTLS_ECP_DP_CURVE25519 );
404 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100405#endif
406#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 }
411 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100412
Paul Elliott8ff510a2020-06-02 17:19:28 +0100413 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100417 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100418 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100419#endif
420#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100421 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100422 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100423#endif
424#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100427#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 }
429 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200430 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100432 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100433 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200434}
John Durkop9814fa22020-11-04 12:28:15 -0800435#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800436 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
437 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
438 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200439
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200440static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
441 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200442{
443 /* Check that the bit size is acceptable for the key type */
444 switch( type )
445 {
446 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200447 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200448 case PSA_KEY_TYPE_DERIVE:
449 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100450#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200451 case PSA_KEY_TYPE_AES:
452 if( bits != 128 && bits != 192 && bits != 256 )
453 return( PSA_ERROR_INVALID_ARGUMENT );
454 break;
455#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100456#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200457 case PSA_KEY_TYPE_CAMELLIA:
458 if( bits != 128 && bits != 192 && bits != 256 )
459 return( PSA_ERROR_INVALID_ARGUMENT );
460 break;
461#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100462#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200463 case PSA_KEY_TYPE_DES:
464 if( bits != 64 && bits != 128 && bits != 192 )
465 return( PSA_ERROR_INVALID_ARGUMENT );
466 break;
467#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100468#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200469 case PSA_KEY_TYPE_CHACHA20:
470 if( bits != 256 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
472 break;
473#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200474 default:
475 return( PSA_ERROR_NOT_SUPPORTED );
476 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200477 if( bits % 8 != 0 )
478 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200479
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200480 return( PSA_SUCCESS );
481}
482
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100483/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484 *
Steven Cooremancd640932021-03-08 12:00:27 +0100485 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
486 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100487 *
488 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 * \param[in] key_type The key type of the key to be used with the
490 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100491 *
492 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100493 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100494 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100495 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100496 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100497MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100498 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100499 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100500{
Steven Cooremancd640932021-03-08 12:00:27 +0100501 if( PSA_ALG_IS_HMAC( algorithm ) )
502 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100503 if( key_type == PSA_KEY_TYPE_HMAC )
504 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506
507 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100508 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100509 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
510 * key. */
511 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
512 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
513 {
514 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
515 * the block length (larger than 1) for block ciphers. */
516 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
517 return( PSA_SUCCESS );
518 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100519 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100520
521 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100522}
523
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200524psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
525 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200526{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100527 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200528 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200529
Ronald Cronea0f8a62020-11-25 17:52:23 +0100530 slot->key.data = mbedtls_calloc( 1, buffer_length );
531 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200532 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200533
Ronald Cronea0f8a62020-11-25 17:52:23 +0100534 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200535 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200536}
537
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200538psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
539 const uint8_t* data,
540 size_t data_length )
541{
542 psa_status_t status = psa_allocate_buffer_to_slot( slot,
543 data_length );
544 if( status != PSA_SUCCESS )
545 return( status );
546
Ronald Cronea0f8a62020-11-25 17:52:23 +0100547 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200548 return( PSA_SUCCESS );
549}
550
Ronald Crona0fe59f2020-11-29 11:14:53 +0100551psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100552 const psa_key_attributes_t *attributes,
553 const uint8_t *data, size_t data_length,
554 uint8_t *key_buffer, size_t key_buffer_size,
555 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100556{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100557 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
558 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100559
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200560 /* zero-length keys are never supported. */
561 if( data_length == 0 )
562 return( PSA_ERROR_NOT_SUPPORTED );
563
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100564 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100565 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100566 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200567
Steven Cooreman75b74362020-07-28 14:30:13 +0200568 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
569 if( data_length > SIZE_MAX / 8 )
570 return( PSA_ERROR_NOT_SUPPORTED );
571
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200572 /* Enforce a size limit, and in particular ensure that the bit
573 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100574 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200575 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200576
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100577 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200578 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200579 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200580
Ronald Crondd04d422020-11-28 15:14:42 +0100581 /* Copy the key material. */
582 memcpy( key_buffer, data, data_length );
583 *key_buffer_length = data_length;
584 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200585
Steven Cooreman40120f62020-10-29 11:42:22 +0100586 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100587 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100588 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200589 {
John Durkop9814fa22020-11-04 12:28:15 -0800590#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
591 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100592 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200593 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100594 return( mbedtls_psa_ecp_import_key( attributes,
595 data, data_length,
596 key_buffer, key_buffer_size,
597 key_buffer_length,
598 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100599 }
John Durkop9814fa22020-11-04 12:28:15 -0800600#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
601 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700602#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
603 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100604 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200605 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100606 return( mbedtls_psa_rsa_import_key( attributes,
607 data, data_length,
608 key_buffer, key_buffer_size,
609 key_buffer_length,
610 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200611 }
John Durkop9814fa22020-11-04 12:28:15 -0800612#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
613 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100614 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100615
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100616 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100617}
618
Gilles Peskinef603c712019-01-19 13:40:11 +0100619/** Calculate the intersection of two algorithm usage policies.
620 *
621 * Return 0 (which allows no operation) on incompatibility.
622 */
623static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100624 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100625 psa_algorithm_t alg1,
626 psa_algorithm_t alg2 )
627{
Gilles Peskine549ea862019-05-22 11:45:59 +0200628 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100629 if( alg1 == alg2 )
630 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100631 /* If the policies are from the same hash-and-sign family, check
632 * if one is a wildcard. If so the other has the specific algorithm. */
633 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
634 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
635 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100636 {
Steven Cooreman03488022021-02-18 12:07:20 +0100637 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
638 return( alg2 );
639 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
640 return( alg1 );
641 }
642 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100643 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100644 * restrictive tag length. */
645 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
646 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
647 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
648 {
649 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
650 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100651 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100652
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100653 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100654 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
655 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100656 {
Steven Cooremancd640932021-03-08 12:00:27 +0100657 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
658 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100659 }
660 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100661 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100662 ( alg1_len <= alg2_len ) )
663 {
664 return( alg2 );
665 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100666 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100667 ( alg2_len <= alg1_len ) )
668 {
669 return( alg1 );
670 }
671 }
672 /* If the policies are from the same MAC family, check whether one
673 * of them is a minimum-MAC-length policy. Calculate the most
674 * restrictive tag length. */
675 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
676 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
677 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
678 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100679 /* Validate the combination of key type and algorithm. Since the base
680 * algorithm of alg1 and alg2 are the same, we only need this once. */
681 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100682 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100683
Steven Cooreman31a876d2021-03-03 20:47:40 +0100684 /* Get the (exact or at-least) output lengths for both sides of the
685 * requested intersection. None of the currently supported algorithms
686 * have an output length dependent on the actual key size, so setting it
687 * to a bogus value of 0 is currently OK.
688 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100689 * Note that for at-least-this-length wildcard algorithms, the output
690 * length is set to the shortest allowed length, which allows us to
691 * calculate the most restrictive tag length for the intersection. */
692 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
693 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100694 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100695
Steven Cooremana1d83222021-02-25 10:20:29 +0100696 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100697 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
698 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100699 {
Steven Cooremancd640932021-03-08 12:00:27 +0100700 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100701 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100702
703 /* If only one is an at-least-this-length policy, the intersection would
704 * be the other (fixed-length) policy as long as said fixed length is
705 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100706 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100707 {
Steven Cooremancd640932021-03-08 12:00:27 +0100708 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100709 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100710 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100711 {
Steven Cooremancd640932021-03-08 12:00:27 +0100712 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100713 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100714
Steven Cooremancd640932021-03-08 12:00:27 +0100715 /* If none of them are wildcards, check whether they define the same tag
716 * length. This is still possible here when one is default-length and
717 * the other specific-length. Ensure to always return the
718 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100719 if( alg1_len == alg2_len )
720 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100721 }
722 /* If the policies are incompatible, allow nothing. */
723 return( 0 );
724}
725
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100726static int psa_key_algorithm_permits( psa_key_type_t key_type,
727 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200728 psa_algorithm_t requested_alg )
729{
Gilles Peskine549ea862019-05-22 11:45:59 +0200730 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200731 if( requested_alg == policy_alg )
732 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100733 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
734 * and requested_alg is the same hash-and-sign family with any hash,
735 * then requested_alg is compliant with policy_alg. */
736 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
737 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200738 {
Steven Cooreman03488022021-02-18 12:07:20 +0100739 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
740 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
741 }
742 /* If policy_alg is a wildcard AEAD algorithm of the same base as
743 * the requested algorithm, check the requested tag length to be
744 * equal-length or longer than the wildcard-specified length. */
745 if( PSA_ALG_IS_AEAD( policy_alg ) &&
746 PSA_ALG_IS_AEAD( requested_alg ) &&
747 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
748 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100749 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100750 {
751 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
752 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
753 }
Steven Cooremancd640932021-03-08 12:00:27 +0100754 /* If policy_alg is a MAC algorithm of the same base as the requested
755 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100756 if( PSA_ALG_IS_MAC( policy_alg ) &&
757 PSA_ALG_IS_MAC( requested_alg ) &&
758 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100759 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100760 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100761 /* Validate the combination of key type and algorithm. Since the policy
762 * and requested algorithms are the same, we only need this once. */
763 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100764 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100765
Steven Cooreman31a876d2021-03-03 20:47:40 +0100766 /* Get both the requested output length for the algorithm which is to be
767 * verified, and the default output length for the base algorithm.
768 * Note that none of the currently supported algorithms have an output
769 * length dependent on actual key size, so setting it to a bogus value
770 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100771 size_t requested_output_length = PSA_MAC_LENGTH(
772 key_type, 0, requested_alg );
773 size_t default_output_length = PSA_MAC_LENGTH(
774 key_type, 0,
775 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100776
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 /* If the policy is default-length, only allow an algorithm with
778 * a declared exact-length matching the default. */
779 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100780 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100781
782 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100783 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
785 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
786 {
787 return( 1 );
788 }
789
Steven Cooremancd640932021-03-08 12:00:27 +0100790 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
791 * check for the requested MAC length to be equal to or longer than the
792 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100793 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
794 {
795 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100796 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100797 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200798 }
Steven Cooremance48e852020-10-05 16:02:45 +0200799 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200800 * a key derivation with that key agreement should also be allowed. This
801 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200802 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
803 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
804 {
805 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
806 policy_alg );
807 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100808 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200809 return( 0 );
810}
811
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100812/** Test whether a policy permits an algorithm.
813 *
814 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100815 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100816 * \note This function requires providing the key type for which the policy is
817 * being validated, since some algorithm policy definitions (e.g. MAC)
818 * have different properties depending on what kind of cipher it is
819 * combined with.
820 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100821 * \retval PSA_SUCCESS When \p alg is a specific algorithm
822 * allowed by the \p policy.
823 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
824 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
825 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100826 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100827static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100828 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100829 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100830{
Steven Cooremand788fab2021-02-25 11:29:17 +0100831 /* '0' is not a valid algorithm */
832 if( alg == 0 )
833 return( PSA_ERROR_INVALID_ARGUMENT );
834
Steven Cooreman7e39f052021-02-23 14:18:32 +0100835 /* A requested algorithm cannot be a wildcard. */
836 if( PSA_ALG_IS_WILDCARD( alg ) )
837 return( PSA_ERROR_INVALID_ARGUMENT );
838
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100839 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
840 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100841 return( PSA_SUCCESS );
842 else
843 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100844}
845
Gilles Peskinef603c712019-01-19 13:40:11 +0100846/** Restrict a key policy based on a constraint.
847 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100848 * \note This function requires providing the key type for which the policy is
849 * being restricted, since some algorithm policy definitions (e.g. MAC)
850 * have different properties depending on what kind of cipher it is
851 * combined with.
852 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100853 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100854 * \param[in,out] policy The policy to restrict.
855 * \param[in] constraint The policy constraint to apply.
856 *
857 * \retval #PSA_SUCCESS
858 * \c *policy contains the intersection of the original value of
859 * \c *policy and \c *constraint.
860 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100861 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100862 * \c *policy is unchanged.
863 */
864static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100865 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 psa_key_policy_t *policy,
867 const psa_key_policy_t *constraint )
868{
869 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100870 psa_key_policy_algorithm_intersection( key_type, policy->alg,
871 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200872 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100873 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
874 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
876 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200877 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
878 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100879 policy->usage &= constraint->usage;
880 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200881 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100882 return( PSA_SUCCESS );
883}
884
Ronald Cron5c522922020-11-14 16:35:34 +0100885/** Get the description of a key given its identifier and policy constraints
886 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200887 *
Ronald Cron5c522922020-11-14 16:35:34 +0100888 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100889 * nonzero, the key must allow operations with this algorithm. If \p alg is
890 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100891 *
Ronald Cron5c522922020-11-14 16:35:34 +0100892 * In case of a persistent key, the function loads the description of the key
893 * into a key slot if not already done.
894 *
895 * On success, the returned key slot is locked. It is the responsibility of
896 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200897 */
Ronald Cron5c522922020-11-14 16:35:34 +0100898static psa_status_t psa_get_and_lock_key_slot_with_policy(
899 mbedtls_svc_key_id_t key,
900 psa_key_slot_t **p_slot,
901 psa_key_usage_t usage,
902 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100903{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
905 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100906
Ronald Cron5c522922020-11-14 16:35:34 +0100907 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 if( status != PSA_SUCCESS )
909 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200910 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100911
912 /* Enforce that usage policy for the key slot contains all the flags
913 * required by the usage parameter. There is one exception: public
914 * keys can always be exported, so we treat public key objects as
915 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200916 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100917 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200918
Gilles Peskine8e338702019-07-30 20:06:31 +0200919 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100920 {
921 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200922 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100923 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100924
925 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100926 if( alg != 0 )
927 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100928 status = psa_key_policy_permits( &slot->attr.policy,
929 slot->attr.type,
930 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100931 if( status != PSA_SUCCESS )
932 goto error;
933 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100934
Darryl Green06fd18d2018-07-16 11:21:11 +0100935 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200936
937error:
938 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100939 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200940
941 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100942}
Darryl Green940d72c2018-07-13 13:18:51 +0100943
Ronald Cron5c522922020-11-14 16:35:34 +0100944/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200945 *
946 * A transparent key is a key for which the key material is directly
947 * available, as opposed to a key in a secure element.
948 *
Ronald Cron5c522922020-11-14 16:35:34 +0100949 * This is a temporary function to use instead of
950 * psa_get_and_lock_key_slot_with_policy() until secure element support is
951 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200952 *
Ronald Cron5c522922020-11-14 16:35:34 +0100953 * On success, the returned key slot is locked. It is the responsibility of the
954 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 */
956#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100957static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
958 mbedtls_svc_key_id_t key,
959 psa_key_slot_t **p_slot,
960 psa_key_usage_t usage,
961 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962{
Ronald Cron5c522922020-11-14 16:35:34 +0100963 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
964 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200965 if( status != PSA_SUCCESS )
966 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200967
Gilles Peskineadad8132019-07-25 11:31:23 +0200968 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200969 {
Ronald Cron5c522922020-11-14 16:35:34 +0100970 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200971 *p_slot = NULL;
972 return( PSA_ERROR_NOT_SUPPORTED );
973 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200974
Gilles Peskine28f8f302019-07-24 13:30:31 +0200975 return( PSA_SUCCESS );
976}
977#else /* MBEDTLS_PSA_CRYPTO_SE_C */
978/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100979#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
980 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
982
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200983psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000984{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100985 /* Data pointer will always be either a valid pointer or NULL in an
986 * initialized slot, so we can just free it. */
987 if( slot->key.data != NULL )
988 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
989
990 mbedtls_free( slot->key.data );
991 slot->key.data = NULL;
992 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000993
994 return( PSA_SUCCESS );
995}
996
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100997/** Completely wipe a slot in memory, including its policy.
998 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100999psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001000{
1001 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001002
Ronald Cron5c522922020-11-14 16:35:34 +01001003 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001004 {
Ronald Cronddd3d052020-10-30 14:07:07 +01001005 status = PSA_ERROR_CORRUPTION_DETECTED;
1006 }
1007
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001008 /* Multipart operations may still be using the key. This is safe
1009 * because all multipart operation objects are independent from
1010 * the key slot: if they need to access the key after the setup
1011 * phase, they have a copy of the key. Note that this means that
1012 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001013 /* At this point, key material and other type-specific content has
1014 * been wiped. Clear remaining metadata. We can call memset and not
1015 * zeroize because the metadata is not particularly sensitive. */
1016 memset( slot, 0, sizeof( *slot ) );
1017 return( status );
1018}
1019
Ronald Croncf56a0a2020-08-04 09:51:30 +02001020psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001021{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001022 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001023 psa_status_t status; /* status of the last operation */
1024 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001025#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1026 psa_se_drv_table_entry_t *driver;
1027#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001028
Ronald Croncf56a0a2020-08-04 09:51:30 +02001029 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001030 return( PSA_SUCCESS );
1031
Ronald Cronf2911112020-10-29 17:51:10 +01001032 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001033 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001034 * key, this will load the key description from persistent memory if not
1035 * done yet. We cannot avoid this loading as without it we don't know if
1036 * the key is operated by an SE or not and this information is needed by
1037 * the current implementation.
1038 */
Ronald Cron5c522922020-11-14 16:35:34 +01001039 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001040 if( status != PSA_SUCCESS )
1041 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001042
Ronald Cronf2911112020-10-29 17:51:10 +01001043 /*
1044 * If the key slot containing the key description is under access by the
1045 * library (apart from the present access), the key cannot be destroyed
1046 * yet. For the time being, just return in error. Eventually (to be
1047 * implemented), the key should be destroyed when all accesses have
1048 * stopped.
1049 */
Ronald Cron5c522922020-11-14 16:35:34 +01001050 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001051 {
Ronald Cron5c522922020-11-14 16:35:34 +01001052 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001053 return( PSA_ERROR_GENERIC_ERROR );
1054 }
1055
Gilles Peskine6687cd02021-04-21 22:32:05 +02001056 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1057 {
1058 /* Refuse the destruction of a read-only key (which may or may not work
1059 * if we attempt it, depending on whether the key is merely read-only
1060 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001061 * Just do the best we can, which is to wipe the copy in memory
1062 * (done in this function's cleanup code). */
1063 overall_status = PSA_ERROR_NOT_PERMITTED;
1064 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001065 }
1066
Gilles Peskine354f7672019-07-12 23:46:38 +02001067#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001068 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001069 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001070 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001071 /* For a key in a secure element, we need to do three things:
1072 * remove the key file in internal storage, destroy the
1073 * key inside the secure element, and update the driver's
1074 * persistent data. Start a transaction that will encompass these
1075 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001076 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001077 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001078 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001079 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001080 status = psa_crypto_save_transaction( );
1081 if( status != PSA_SUCCESS )
1082 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001083 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001084 /* We should still try to destroy the key in the secure
1085 * element and the key metadata in storage. This is especially
1086 * important if the error is that the storage is full.
1087 * But how to do it exactly without risking an inconsistent
1088 * state after a reset?
1089 * https://github.com/ARMmbed/mbed-crypto/issues/215
1090 */
1091 overall_status = status;
1092 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001093 }
1094
Ronald Cronea0f8a62020-11-25 17:52:23 +01001095 status = psa_destroy_se_key( driver,
1096 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001097 if( overall_status == PSA_SUCCESS )
1098 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001099 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001100#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1101
Darryl Greend49a4992018-06-18 17:27:26 +01001102#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001103 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001104 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001105 status = psa_destroy_persistent_key( slot->attr.id );
1106 if( overall_status == PSA_SUCCESS )
1107 overall_status = status;
1108
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001109 /* TODO: other slots may have a copy of the same key. We should
1110 * invalidate them.
1111 * https://github.com/ARMmbed/mbed-crypto/issues/214
1112 */
Darryl Greend49a4992018-06-18 17:27:26 +01001113 }
1114#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001115
Gilles Peskinefc762652019-07-22 19:30:34 +02001116#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1117 if( driver != NULL )
1118 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001119 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001120 if( overall_status == PSA_SUCCESS )
1121 overall_status = status;
1122 status = psa_crypto_stop_transaction( );
1123 if( overall_status == PSA_SUCCESS )
1124 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001125 }
1126#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1127
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001128exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001129 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001130 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001131 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001132 overall_status = status;
1133 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001134}
1135
John Durkop07cc04a2020-11-16 22:08:34 -08001136#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001137 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001138static psa_status_t psa_get_rsa_public_exponent(
1139 const mbedtls_rsa_context *rsa,
1140 psa_key_attributes_t *attributes )
1141{
1142 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001144 uint8_t *buffer = NULL;
1145 size_t buflen;
1146 mbedtls_mpi_init( &mpi );
1147
1148 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1149 if( ret != 0 )
1150 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001151 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1152 {
1153 /* It's the default value, which is reported as an empty string,
1154 * so there's nothing to do. */
1155 goto exit;
1156 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001157
1158 buflen = mbedtls_mpi_size( &mpi );
1159 buffer = mbedtls_calloc( 1, buflen );
1160 if( buffer == NULL )
1161 {
1162 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1163 goto exit;
1164 }
1165 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1166 if( ret != 0 )
1167 goto exit;
1168 attributes->domain_parameters = buffer;
1169 attributes->domain_parameters_size = buflen;
1170
1171exit:
1172 mbedtls_mpi_free( &mpi );
1173 if( ret != 0 )
1174 mbedtls_free( buffer );
1175 return( mbedtls_to_psa_error( ret ) );
1176}
John Durkop07cc04a2020-11-16 22:08:34 -08001177#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001178 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001179
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001180/** Retrieve all the publicly-accessible attributes of a key.
1181 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001182psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001183 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001184{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001186 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001187 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001188
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001189 psa_reset_key_attributes( attributes );
1190
Ronald Cron5c522922020-11-14 16:35:34 +01001191 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001192 if( status != PSA_SUCCESS )
1193 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001194
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001195 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001196 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1197 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1198
1199#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1200 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001201 psa_set_key_slot_number( attributes,
1202 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001203#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001204
Gilles Peskine8e338702019-07-30 20:06:31 +02001205 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001206 {
John Durkop07cc04a2020-11-16 22:08:34 -08001207#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001208 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001209 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001210 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001211#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001212 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001213 * is not yet implemented.
1214 * https://github.com/ARMmbed/mbed-crypto/issues/216
1215 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001216 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001217 break;
1218#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001219 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001220 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001221
Ronald Cron90857082020-11-25 14:58:33 +01001222 status = mbedtls_psa_rsa_load_representation(
1223 slot->attr.type,
1224 slot->key.data,
1225 slot->key.bytes,
1226 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001227 if( status != PSA_SUCCESS )
1228 break;
1229
Steven Cooremana2371e52020-07-28 14:30:39 +02001230 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001231 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001232 mbedtls_rsa_free( rsa );
1233 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001234 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001235 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001236#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001237 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001238 default:
1239 /* Nothing else to do. */
1240 break;
1241 }
1242
1243 if( status != PSA_SUCCESS )
1244 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001245
Ronald Cron5c522922020-11-14 16:35:34 +01001246 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001247
Ronald Cron5c522922020-11-14 16:35:34 +01001248 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001249}
1250
Gilles Peskinec8000c02019-08-02 20:15:51 +02001251#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1252psa_status_t psa_get_key_slot_number(
1253 const psa_key_attributes_t *attributes,
1254 psa_key_slot_number_t *slot_number )
1255{
1256 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1257 {
1258 *slot_number = attributes->slot_number;
1259 return( PSA_SUCCESS );
1260 }
1261 else
1262 return( PSA_ERROR_INVALID_ARGUMENT );
1263}
1264#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1265
Ronald Crond18b5f82020-11-25 16:46:05 +01001266static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1267 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001268 uint8_t *data,
1269 size_t data_size,
1270 size_t *data_length )
1271{
Ronald Crond18b5f82020-11-25 16:46:05 +01001272 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001273 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001274 memcpy( data, key_buffer, key_buffer_size );
1275 memset( data + key_buffer_size, 0,
1276 data_size - key_buffer_size );
1277 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001278 return( PSA_SUCCESS );
1279}
1280
Ronald Cron7285cda2020-11-26 14:46:37 +01001281psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 const psa_key_attributes_t *attributes,
1283 const uint8_t *key_buffer, size_t key_buffer_size,
1284 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001285{
Ronald Crond18b5f82020-11-25 16:46:05 +01001286 psa_key_type_t type = attributes->core.type;
1287
Ronald Crond18b5f82020-11-25 16:46:05 +01001288 if( key_type_is_raw_bytes( type ) ||
1289 PSA_KEY_TYPE_IS_RSA( type ) ||
1290 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001291 {
1292 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001293 key_buffer, key_buffer_size,
1294 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001295 }
1296 else
1297 {
1298 /* This shouldn't happen in the reference implementation, but
1299 it is valid for a special-purpose implementation to omit
1300 support for exporting certain key types. */
1301 return( PSA_ERROR_NOT_SUPPORTED );
1302 }
1303}
1304
1305psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1306 uint8_t *data,
1307 size_t data_size,
1308 size_t *data_length )
1309{
1310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1311 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1312 psa_key_slot_t *slot;
1313
Ronald Crone907e552021-01-18 13:22:38 +01001314 /* Reject a zero-length output buffer now, since this can never be a
1315 * valid key representation. This way we know that data must be a valid
1316 * pointer and we can do things like memset(data, ..., data_size). */
1317 if( data_size == 0 )
1318 return( PSA_ERROR_BUFFER_TOO_SMALL );
1319
Ronald Cron9486f9d2020-11-26 13:36:23 +01001320 /* Set the key to empty now, so that even when there are errors, we always
1321 * set data_length to a value between 0 and data_size. On error, setting
1322 * the key to empty is a good choice because an empty key representation is
1323 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001324 *data_length = 0;
1325
Ronald Cron9486f9d2020-11-26 13:36:23 +01001326 /* Export requires the EXPORT flag. There is an exception for public keys,
1327 * which don't require any flag, but
1328 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1329 */
1330 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1331 PSA_KEY_USAGE_EXPORT, 0 );
1332 if( status != PSA_SUCCESS )
1333 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001334
Ronald Crond18b5f82020-11-25 16:46:05 +01001335 psa_key_attributes_t attributes = {
1336 .core = slot->attr
1337 };
Ronald Cron67227982020-11-26 15:16:05 +01001338 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001339 slot->key.data, slot->key.bytes,
1340 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001341
Ronald Cron9486f9d2020-11-26 13:36:23 +01001342 unlock_status = psa_unlock_key_slot( slot );
1343
1344 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1345}
1346
Ronald Cron7285cda2020-11-26 14:46:37 +01001347psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001348 const psa_key_attributes_t *attributes,
1349 const uint8_t *key_buffer,
1350 size_t key_buffer_size,
1351 uint8_t *data,
1352 size_t data_size,
1353 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001354{
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001356
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001358 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001359 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001360 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001361 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001362 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 key_buffer, key_buffer_size,
1364 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001365 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001366
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001368 {
John Durkop0e005192020-10-31 22:06:54 -07001369#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1370 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001371 return( mbedtls_psa_rsa_export_public_key( attributes,
1372 key_buffer,
1373 key_buffer_size,
1374 data,
1375 data_size,
1376 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001377#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001378 /* We don't know how to convert a private RSA key to public. */
1379 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001380#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1381 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001382 }
1383 else
Moran Pekera998bc62018-04-16 18:16:20 +03001384 {
John Durkop6ba40d12020-11-10 08:50:04 -08001385#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1386 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001387 return( mbedtls_psa_ecp_export_public_key( attributes,
1388 key_buffer,
1389 key_buffer_size,
1390 data,
1391 data_size,
1392 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001393#else
1394 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001395 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001396#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1397 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001398 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001399 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001400 else
1401 {
1402 /* This shouldn't happen in the reference implementation, but
1403 it is valid for a special-purpose implementation to omit
1404 support for exporting certain key types. */
1405 return( PSA_ERROR_NOT_SUPPORTED );
1406 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001407}
Ronald Crond18b5f82020-11-25 16:46:05 +01001408
Ronald Croncf56a0a2020-08-04 09:51:30 +02001409psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001410 uint8_t *data,
1411 size_t data_size,
1412 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001413{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001414 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001415 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001416 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001417
Ronald Crone907e552021-01-18 13:22:38 +01001418 /* Reject a zero-length output buffer now, since this can never be a
1419 * valid key representation. This way we know that data must be a valid
1420 * pointer and we can do things like memset(data, ..., data_size). */
1421 if( data_size == 0 )
1422 return( PSA_ERROR_BUFFER_TOO_SMALL );
1423
Darryl Greendd8fb772018-11-07 16:00:44 +00001424 /* Set the key to empty now, so that even when there are errors, we always
1425 * set data_length to a value between 0 and data_size. On error, setting
1426 * the key to empty is a good choice because an empty key representation is
1427 * unlikely to be accepted anywhere. */
1428 *data_length = 0;
1429
1430 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001431 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001432 if( status != PSA_SUCCESS )
1433 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001434
Ronald Cron9486f9d2020-11-26 13:36:23 +01001435 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1436 {
1437 status = PSA_ERROR_INVALID_ARGUMENT;
1438 goto exit;
1439 }
1440
Ronald Crond18b5f82020-11-25 16:46:05 +01001441 psa_key_attributes_t attributes = {
1442 .core = slot->attr
1443 };
Ronald Cron67227982020-11-26 15:16:05 +01001444 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001445 &attributes, slot->key.data, slot->key.bytes,
1446 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001447
1448exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001449 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001450
Ronald Cron5c522922020-11-14 16:35:34 +01001451 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001452}
1453
Gilles Peskine91e8c332019-08-02 19:19:39 +02001454#if defined(static_assert)
1455static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1456 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001457static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001458 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001459static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001460 "One or more key attribute flag is listed as both internal-only and external-only" );
1461#endif
1462
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001463/** Validate that a key policy is internally well-formed.
1464 *
1465 * This function only rejects invalid policies. It does not validate the
1466 * consistency of the policy with respect to other attributes of the key
1467 * such as the key type.
1468 */
1469static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001470{
1471 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001472 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001473 PSA_KEY_USAGE_ENCRYPT |
1474 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001475 PSA_KEY_USAGE_SIGN_MESSAGE |
1476 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001477 PSA_KEY_USAGE_SIGN_HASH |
1478 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001479 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001480 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1481 return( PSA_ERROR_INVALID_ARGUMENT );
1482
Gilles Peskine4747d192019-04-17 15:05:45 +02001483 return( PSA_SUCCESS );
1484}
1485
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001486/** Validate the internal consistency of key attributes.
1487 *
1488 * This function only rejects invalid attribute values. If does not
1489 * validate the consistency of the attributes with any key data that may
1490 * be involved in the creation of the key.
1491 *
1492 * Call this function early in the key creation process.
1493 *
1494 * \param[in] attributes Key attributes for the new key.
1495 * \param[out] p_drv On any return, the driver for the key, if any.
1496 * NULL for a transparent key.
1497 *
1498 */
1499static psa_status_t psa_validate_key_attributes(
1500 const psa_key_attributes_t *attributes,
1501 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001502{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001503 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001504 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001505 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001506
Ronald Cron54b90082020-10-29 15:26:43 +01001507 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001508 if( status != PSA_SUCCESS )
1509 return( status );
1510
Ronald Crond2ed4812020-07-17 16:11:30 +02001511 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001512 if( status != PSA_SUCCESS )
1513 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001514
Ronald Cron65f38a32020-10-23 17:11:13 +02001515 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1516 {
1517 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1518 return( PSA_ERROR_INVALID_ARGUMENT );
1519 }
1520 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001521 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001522 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1523 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001524 }
1525
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001526 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001527 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001528 return( status );
1529
1530 /* Refuse to create overly large keys.
1531 * Note that this doesn't trigger on import if the attributes don't
1532 * explicitly specify a size (so psa_get_key_bits returns 0), so
1533 * psa_import_key() needs its own checks. */
1534 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1535 return( PSA_ERROR_NOT_SUPPORTED );
1536
Gilles Peskine91e8c332019-08-02 19:19:39 +02001537 /* Reject invalid flags. These should not be reachable through the API. */
1538 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1539 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1540 return( PSA_ERROR_INVALID_ARGUMENT );
1541
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001542 return( PSA_SUCCESS );
1543}
1544
Gilles Peskine4747d192019-04-17 15:05:45 +02001545/** Prepare a key slot to receive key material.
1546 *
1547 * This function allocates a key slot and sets its metadata.
1548 *
1549 * If this function fails, call psa_fail_key_creation().
1550 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001551 * This function is intended to be used as follows:
1552 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001553 * it with the specified attributes, and in case of a volatile key assign it
1554 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001555 * -# Populate the slot with the key material.
1556 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1557 * In case of failure at any step, stop the sequence and call
1558 * psa_fail_key_creation().
1559 *
Ronald Cron5c522922020-11-14 16:35:34 +01001560 * On success, the key slot is locked. It is the responsibility of the caller
1561 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001562 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001563 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001564 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001565 * \param[out] p_slot On success, a pointer to the prepared slot.
1566 * \param[out] p_drv On any return, the driver for the key, if any.
1567 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001568 *
1569 * \retval #PSA_SUCCESS
1570 * The key slot is ready to receive key material.
1571 * \return If this function fails, the key slot is an invalid state.
1572 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001573 */
1574static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001575 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001576 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001577 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001578 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001579{
1580 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001581 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001582 psa_key_slot_t *slot;
1583
Gilles Peskinedf179142019-07-15 22:02:14 +02001584 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001585 *p_drv = NULL;
1586
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001587 status = psa_validate_key_attributes( attributes, p_drv );
1588 if( status != PSA_SUCCESS )
1589 return( status );
1590
Ronald Cronc4d1b512020-07-31 11:26:37 +02001591 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001592 if( status != PSA_SUCCESS )
1593 return( status );
1594 slot = *p_slot;
1595
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001596 /* We're storing the declared bit-size of the key. It's up to each
1597 * creation mechanism to verify that this information is correct.
1598 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001599 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001600 * is optional (import, copy). In case of a volatile key, assign it the
1601 * volatile key identifier associated to the slot returned to contain its
1602 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001603
1604 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001605 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1606 {
1607#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1608 slot->attr.id = volatile_key_id;
1609#else
1610 slot->attr.id.key_id = volatile_key_id;
1611#endif
1612 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001613
Gilles Peskine91e8c332019-08-02 19:19:39 +02001614 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001615 * external-only flags, query `attributes`. Thanks to the check
1616 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001617 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001618 * may have set. */
1619 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001620
Gilles Peskinecbaff462019-07-12 23:46:04 +02001621#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001622 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001623 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001624 * create the key file in internal storage, create the
1625 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001626 * persistent data. This is done by starting a transaction that will
1627 * encompass these three actions.
1628 * For registering a volatile key, we just need to find an appropriate
1629 * slot number inside the SE. Since the key is designated volatile, creating
1630 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001631 /* The first thing to do is to find a slot number for the new key.
1632 * We save the slot number in persistent storage as part of the
1633 * transaction data. It will be needed to recover if the power
1634 * fails during the key creation process, to clean up on the secure
1635 * element side after restarting. Obtaining a slot number from the
1636 * secure element driver updates its persistent state, but we do not yet
1637 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001638 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001639 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001640 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001641 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001642 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001643 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001644 if( status != PSA_SUCCESS )
1645 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646
1647 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001648 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001649 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1650 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001651 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001652 psa_crypto_transaction.key.id = slot->attr.id;
1653 status = psa_crypto_save_transaction( );
1654 if( status != PSA_SUCCESS )
1655 {
1656 (void) psa_crypto_stop_transaction( );
1657 return( status );
1658 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001659 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001660
1661 status = psa_copy_key_material_into_slot(
1662 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001663 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001664
1665 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1666 {
1667 /* Key registration only makes sense with a secure element. */
1668 return( PSA_ERROR_INVALID_ARGUMENT );
1669 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001670#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1671
Ronald Cronc4d1b512020-07-31 11:26:37 +02001672 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001673}
Gilles Peskine4747d192019-04-17 15:05:45 +02001674
1675/** Finalize the creation of a key once its key material has been set.
1676 *
1677 * This entails writing the key to persistent storage.
1678 *
1679 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001680 * See the documentation of psa_start_key_creation() for the intended use
1681 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001682 *
Ronald Cron5c522922020-11-14 16:35:34 +01001683 * If the finalization succeeds, the function unlocks the key slot (it was
1684 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1685 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001686 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001687 * \param[in,out] slot Pointer to the slot with key material.
1688 * \param[in] driver The secure element driver for the key,
1689 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001690 * \param[out] key On success, identifier of the key. Note that the
1691 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001692 *
1693 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001694 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001695 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1696 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1697 * \retval #PSA_ERROR_ALREADY_EXISTS
1698 * \retval #PSA_ERROR_DATA_INVALID
1699 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001700 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001701 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001702 * \return If this function fails, the key slot is an invalid state.
1703 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001704 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001705static psa_status_t psa_finish_key_creation(
1706 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001707 psa_se_drv_table_entry_t *driver,
1708 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001709{
1710 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001711 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001712 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001713
1714#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001715 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001716 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001717#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1718 if( driver != NULL )
1719 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001720 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001721 psa_key_slot_number_t slot_number =
1722 psa_key_slot_get_slot_number( slot ) ;
1723
Gilles Peskineb46bef22019-07-30 21:32:04 +02001724#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001725 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001726 sizeof( data.slot_number ),
1727 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001728#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001729 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001730 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001731 (uint8_t*) &data,
1732 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001733 }
1734 else
1735#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1736 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001737 /* Key material is saved in export representation in the slot, so
1738 * just pass the slot buffer for storage. */
1739 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001740 slot->key.data,
1741 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001742 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001743 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001744#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1745
Gilles Peskinecbaff462019-07-12 23:46:04 +02001746#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001747 /* Finish the transaction for a key creation. This does not
1748 * happen when registering an existing key. Detect this case
1749 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001750 * creation of a persistent key in a secure element requires a transaction,
1751 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001752 if( driver != NULL &&
1753 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001754 {
1755 status = psa_save_se_persistent_data( driver );
1756 if( status != PSA_SUCCESS )
1757 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001758 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001759 return( status );
1760 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001761 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001762 }
1763#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1764
Ronald Cron50972942020-11-14 11:28:25 +01001765 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001766 {
1767 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001768 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001769 if( status != PSA_SUCCESS )
1770 *key = MBEDTLS_SVC_KEY_ID_INIT;
1771 }
Ronald Cron50972942020-11-14 11:28:25 +01001772
Gilles Peskine4747d192019-04-17 15:05:45 +02001773 return( status );
1774}
1775
1776/** Abort the creation of a key.
1777 *
1778 * You may call this function after calling psa_start_key_creation(),
1779 * or after psa_finish_key_creation() fails. In other circumstances, this
1780 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001781 * See the documentation of psa_start_key_creation() for the intended use
1782 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001783 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001784 * \param[in,out] slot Pointer to the slot with key material.
1785 * \param[in] driver The secure element driver for the key,
1786 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001787 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001788static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001789 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001790{
Gilles Peskine011e4282019-06-26 18:34:38 +02001791 (void) driver;
1792
Gilles Peskine4747d192019-04-17 15:05:45 +02001793 if( slot == NULL )
1794 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001795
1796#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001797 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001798 * element, and the failure happened later (when saving metadata
1799 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001800 * element.
1801 * https://github.com/ARMmbed/mbed-crypto/issues/217
1802 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001803
Gilles Peskined7729582019-08-05 15:55:54 +02001804 /* Abort the ongoing transaction if any (there may not be one if
1805 * the creation process failed before starting one, or if the
1806 * key creation is a registration of a key in a secure element).
1807 * Earlier functions must already have done what it takes to undo any
1808 * partial creation. All that's left is to update the transaction data
1809 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001810 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001811#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1812
Gilles Peskine4747d192019-04-17 15:05:45 +02001813 psa_wipe_key_slot( slot );
1814}
1815
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001816/** Validate optional attributes during key creation.
1817 *
1818 * Some key attributes are optional during key creation. If they are
1819 * specified in the attributes structure, check that they are consistent
1820 * with the data in the slot.
1821 *
1822 * This function should be called near the end of key creation, after
1823 * the slot in memory is fully populated but before saving persistent data.
1824 */
1825static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001826 const psa_key_slot_t *slot,
1827 const psa_key_attributes_t *attributes )
1828{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001829 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001830 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001831 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001832 return( PSA_ERROR_INVALID_ARGUMENT );
1833 }
1834
1835 if( attributes->domain_parameters_size != 0 )
1836 {
John Durkop0e005192020-10-31 22:06:54 -07001837#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1838 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001839 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001841 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001842 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001844
Ronald Cron90857082020-11-25 14:58:33 +01001845 psa_status_t status = mbedtls_psa_rsa_load_representation(
1846 slot->attr.type,
1847 slot->key.data,
1848 slot->key.bytes,
1849 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001850 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001851 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001852
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001853 mbedtls_mpi_init( &actual );
1854 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001855 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001856 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001857 mbedtls_rsa_free( rsa );
1858 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001859 if( ret != 0 )
1860 goto rsa_exit;
1861 ret = mbedtls_mpi_read_binary( &required,
1862 attributes->domain_parameters,
1863 attributes->domain_parameters_size );
1864 if( ret != 0 )
1865 goto rsa_exit;
1866 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1867 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1868 rsa_exit:
1869 mbedtls_mpi_free( &actual );
1870 mbedtls_mpi_free( &required );
1871 if( ret != 0)
1872 return( mbedtls_to_psa_error( ret ) );
1873 }
1874 else
John Durkop9814fa22020-11-04 12:28:15 -08001875#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1876 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 {
1878 return( PSA_ERROR_INVALID_ARGUMENT );
1879 }
1880 }
1881
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001882 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001883 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001884 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001885 return( PSA_ERROR_INVALID_ARGUMENT );
1886 }
1887
1888 return( PSA_SUCCESS );
1889}
1890
Gilles Peskine4747d192019-04-17 15:05:45 +02001891psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001892 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001893 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001894 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001895{
1896 psa_status_t status;
1897 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001898 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001899 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001900
Ronald Cron81709fc2020-11-14 12:10:32 +01001901 *key = MBEDTLS_SVC_KEY_ID_INIT;
1902
Gilles Peskine0f84d622019-09-12 19:03:13 +02001903 /* Reject zero-length symmetric keys (including raw data key objects).
1904 * This also rejects any key which might be encoded as an empty string,
1905 * which is never valid. */
1906 if( data_length == 0 )
1907 return( PSA_ERROR_INVALID_ARGUMENT );
1908
Gilles Peskinedf179142019-07-15 22:02:14 +02001909 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001910 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001911 if( status != PSA_SUCCESS )
1912 goto exit;
1913
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001914 /* In the case of a transparent key or an opaque key stored in local
1915 * storage (thus not in the case of generating a key in a secure element
1916 * or cryptoprocessor with storage), we have to allocate a buffer to
1917 * hold the generated key material. */
1918 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001919 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001920 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001921 if( status != PSA_SUCCESS )
1922 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001923 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001924
1925 bits = slot->attr.bits;
1926 status = psa_driver_wrapper_import_key( attributes,
1927 data, data_length,
1928 slot->key.data,
1929 slot->key.bytes,
1930 &slot->key.bytes, &bits );
1931 if( status != PSA_SUCCESS )
1932 goto exit;
1933
1934 if( slot->attr.bits == 0 )
1935 slot->attr.bits = (psa_key_bits_t) bits;
1936 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001937 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001938 status = PSA_ERROR_INVALID_ARGUMENT;
1939 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001940 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001941
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001942 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001943 if( status != PSA_SUCCESS )
1944 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001945
Ronald Cron81709fc2020-11-14 12:10:32 +01001946 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001947exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001948 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001949 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001950
Gilles Peskine4747d192019-04-17 15:05:45 +02001951 return( status );
1952}
1953
Gilles Peskined7729582019-08-05 15:55:54 +02001954#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1955psa_status_t mbedtls_psa_register_se_key(
1956 const psa_key_attributes_t *attributes )
1957{
1958 psa_status_t status;
1959 psa_key_slot_t *slot = NULL;
1960 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001961 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001962
1963 /* Leaving attributes unspecified is not currently supported.
1964 * It could make sense to query the key type and size from the
1965 * secure element, but not all secure elements support this
1966 * and the driver HAL doesn't currently support it. */
1967 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1968 return( PSA_ERROR_NOT_SUPPORTED );
1969 if( psa_get_key_bits( attributes ) == 0 )
1970 return( PSA_ERROR_NOT_SUPPORTED );
1971
1972 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001973 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001974 if( status != PSA_SUCCESS )
1975 goto exit;
1976
Ronald Cron81709fc2020-11-14 12:10:32 +01001977 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001978
1979exit:
1980 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001981 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001982
Gilles Peskined7729582019-08-05 15:55:54 +02001983 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001984 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001985 return( status );
1986}
1987#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1988
Gilles Peskinef603c712019-01-19 13:40:11 +01001989static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001990 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001991{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001992 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001993 source->key.data,
1994 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001995 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001996 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001997
Steven Cooreman398aee52020-10-13 14:35:45 +02001998 target->attr.type = source->attr.type;
1999 target->attr.bits = source->attr.bits;
2000
2001 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002002}
2003
Ronald Croncf56a0a2020-08-04 09:51:30 +02002004psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002005 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002006 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002007{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002008 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002009 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002010 psa_key_slot_t *source_slot = NULL;
2011 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002012 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002013 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002014
Ronald Cron81709fc2020-11-14 12:10:32 +01002015 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2016
Ronald Cron5c522922020-11-14 16:35:34 +01002017 status = psa_get_and_lock_transparent_key_slot_with_policy(
2018 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002019 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002020 goto exit;
2021
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002022 status = psa_validate_optional_attributes( source_slot,
2023 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002024 if( status != PSA_SUCCESS )
2025 goto exit;
2026
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002027 status = psa_restrict_key_policy( source_slot->attr.type,
2028 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002029 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002030 if( status != PSA_SUCCESS )
2031 goto exit;
2032
Ronald Cron81709fc2020-11-14 12:10:32 +01002033 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2034 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002035 if( status != PSA_SUCCESS )
2036 goto exit;
2037
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002038#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2039 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002040 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002041 /* Copying to a secure element is not implemented yet. */
2042 status = PSA_ERROR_NOT_SUPPORTED;
2043 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002044 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002045#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002046
Ronald Cron6cc66312021-04-02 12:27:47 +02002047 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2048 {
2049 /*
2050 * Copying through an opaque driver is not implemented yet, consider
2051 * a lifetime with an external location as an invalid parameter for
2052 * now.
2053 */
2054 status = PSA_ERROR_INVALID_ARGUMENT;
2055 goto exit;
2056 }
2057
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002058 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002059 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002060 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002061
Ronald Cron81709fc2020-11-14 12:10:32 +01002062 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002063exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002064 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002065 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002066
Ronald Cron5c522922020-11-14 16:35:34 +01002067 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002068
Ronald Cron5c522922020-11-14 16:35:34 +01002069 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002070}
2071
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002072
2073
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002074/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002075/* Message digests */
2076/****************************************************************/
2077
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002078psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2079{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002080 /* Aborting a non-active operation is allowed */
2081 if( operation->id == 0 )
2082 return( PSA_SUCCESS );
2083
2084 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2085 operation->id = 0;
2086
2087 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002088}
2089
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002090psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002091 psa_algorithm_t alg )
2092{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002093 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002094
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002095 /* A context must be freshly initialized before it can be set up. */
2096 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002097 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002098 status = PSA_ERROR_BAD_STATE;
2099 goto exit;
2100 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002101
2102 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002103 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002104 status = PSA_ERROR_INVALID_ARGUMENT;
2105 goto exit;
2106 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002107
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002108 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2109 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002110 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2111
Dave Rodgman685b6a72021-06-24 11:49:14 +01002112 status = psa_driver_wrapper_hash_setup( operation, alg );
2113
2114exit:
2115 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002116 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002117
2118 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002119}
2120
2121psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2122 const uint8_t *input,
2123 size_t input_length )
2124{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002125 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2126
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002127 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002128 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002129 status = PSA_ERROR_BAD_STATE;
2130 goto exit;
2131 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002132
Steven Cooremanc8288352021-03-04 14:02:19 +01002133 /* Don't require hash implementations to behave correctly on a
2134 * zero-length input, which may have an invalid pointer. */
2135 if( input_length == 0 )
2136 return( PSA_SUCCESS );
2137
Dave Rodgman685b6a72021-06-24 11:49:14 +01002138 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2139
2140exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002141 if( status != PSA_SUCCESS )
2142 psa_hash_abort( operation );
2143
2144 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002145}
2146
2147psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2148 uint8_t *hash,
2149 size_t hash_size,
2150 size_t *hash_length )
2151{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002152 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002153 if( operation->id == 0 )
2154 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155
Steven Cooreman1e582352021-02-18 17:24:37 +01002156 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002158 psa_hash_abort( operation );
2159 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002160}
2161
Gilles Peskine2d277862018-06-18 15:41:12 +02002162psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2163 const uint8_t *hash,
2164 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002165{
2166 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2167 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002168 psa_status_t status = psa_hash_finish(
2169 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002170 actual_hash, sizeof( actual_hash ),
2171 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002172
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002173 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002174 goto exit;
2175
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002176 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002177 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002178 status = PSA_ERROR_INVALID_SIGNATURE;
2179 goto exit;
2180 }
2181
Steven Cooreman36876a02021-04-29 16:37:59 +02002182 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002183 status = PSA_ERROR_INVALID_SIGNATURE;
2184
2185exit:
2186 if( status != PSA_SUCCESS )
2187 psa_hash_abort(operation);
2188
2189 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002190}
2191
Gilles Peskine0a749c82019-11-28 19:33:58 +01002192psa_status_t psa_hash_compute( psa_algorithm_t alg,
2193 const uint8_t *input, size_t input_length,
2194 uint8_t *hash, size_t hash_size,
2195 size_t *hash_length )
2196{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002197 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002198 if( !PSA_ALG_IS_HASH( alg ) )
2199 return( PSA_ERROR_INVALID_ARGUMENT );
2200
Steven Cooreman1e582352021-02-18 17:24:37 +01002201 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2202 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002203}
2204
2205psa_status_t psa_hash_compare( psa_algorithm_t alg,
2206 const uint8_t *input, size_t input_length,
2207 const uint8_t *hash, size_t hash_length )
2208{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002209 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2210 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002211
2212 if( !PSA_ALG_IS_HASH( alg ) )
2213 return( PSA_ERROR_INVALID_ARGUMENT );
2214
Steven Cooreman1e582352021-02-18 17:24:37 +01002215 psa_status_t status = psa_driver_wrapper_hash_compute(
2216 alg, input, input_length,
2217 actual_hash, sizeof(actual_hash),
2218 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002219 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002220 return( status );
2221 if( actual_hash_length != hash_length )
2222 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002223 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002224 return( PSA_ERROR_INVALID_SIGNATURE );
2225 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002226}
2227
Gilles Peskineeb35d782019-01-22 17:56:16 +01002228psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2229 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002230{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002231 if( source_operation->id == 0 ||
2232 target_operation->id != 0 )
2233 {
2234 return( PSA_ERROR_BAD_STATE );
2235 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002236
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002237 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2238 target_operation );
2239 if( status != PSA_SUCCESS )
2240 psa_hash_abort( target_operation );
2241
2242 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002243}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244
2245
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002246/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002247/* MAC */
2248/****************************************************************/
2249
Steven Cooremane6804192021-03-19 18:28:56 +01002250psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002251{
Steven Cooremane6804192021-03-19 18:28:56 +01002252 /* Aborting a non-active operation is allowed */
2253 if( operation->id == 0 )
2254 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002255
Steven Cooremane6804192021-03-19 18:28:56 +01002256 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002257 operation->mac_size = 0;
2258 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002259 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002260
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002261 return( status );
2262}
2263
Ronald Cron2dff3b22021-06-17 16:33:22 +02002264static psa_status_t psa_mac_finalize_alg_and_key_validation(
2265 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002266 const psa_key_attributes_t *attributes,
2267 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002268{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002270 psa_key_type_t key_type = psa_get_key_type( attributes );
2271 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002272
Ronald Cron28ea0502021-06-17 16:10:24 +02002273 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002274 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002275
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002276 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002277 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002278 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002279 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002280
Steven Cooremand1a68f12021-05-10 11:13:41 +02002281 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002282 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002283
Ronald Cron79bdd822021-06-17 16:46:44 +02002284 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002285 {
2286 /* A very short MAC is too short for security since it can be
2287 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2288 * so we make this our minimum, even though 32 bits is still
2289 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002290 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002291 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002292
Ronald Cron79bdd822021-06-17 16:46:44 +02002293 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2294 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002295 {
2296 /* It's impossible to "truncate" to a larger length than the full length
2297 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002298 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002299 }
2300
Ronald Cron79bdd822021-06-17 16:46:44 +02002301 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002302}
2303
Gilles Peskinee59236f2018-01-27 23:32:46 +01002304static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2305 mbedtls_svc_key_id_t key,
2306 psa_algorithm_t alg,
2307 int is_sign )
2308{
2309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2310 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002311 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002312
2313 /* A context must be freshly initialized before it can be set up. */
2314 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002315 {
Dave Rodgman54648242021-06-24 11:49:45 +01002316 status = PSA_ERROR_BAD_STATE;
2317 goto exit;
2318 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002319
Gilles Peskine8c9def32018-02-08 10:02:12 +01002320 status = psa_get_and_lock_key_slot_with_policy(
2321 key,
2322 &slot,
2323 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2324 alg );
2325 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002326 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002327
2328 psa_key_attributes_t attributes = {
2329 .core = slot->attr
2330 };
2331
Ronald Cron79bdd822021-06-17 16:46:44 +02002332 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2333 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002334 if( status != PSA_SUCCESS )
2335 goto exit;
2336
2337 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002338 /* Dispatch the MAC setup call with validated input */
2339 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002340 {
Steven Cooremane6804192021-03-19 18:28:56 +01002341 status = psa_driver_wrapper_mac_sign_setup( operation,
2342 &attributes,
2343 slot->key.data,
2344 slot->key.bytes,
2345 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002346 }
2347 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002348 {
Steven Cooremane6804192021-03-19 18:28:56 +01002349 status = psa_driver_wrapper_mac_verify_setup( operation,
2350 &attributes,
2351 slot->key.data,
2352 slot->key.bytes,
2353 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002354 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002355
Gilles Peskinefbfac682018-07-08 20:51:54 +02002356exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002357 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002358 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002359
Ronald Cron5c522922020-11-14 16:35:34 +01002360 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002361
Ronald Cron5c522922020-11-14 16:35:34 +01002362 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002363}
2364
Gilles Peskine89167cb2018-07-08 20:12:23 +02002365psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002366 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002367 psa_algorithm_t alg )
2368{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002369 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002370}
2371
2372psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002373 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002374 psa_algorithm_t alg )
2375{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002376 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002377}
2378
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002379psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002380 const uint8_t *input,
2381 size_t input_length )
2382{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002383 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002384 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002385
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002386 /* Don't require hash implementations to behave correctly on a
2387 * zero-length input, which may have an invalid pointer. */
2388 if( input_length == 0 )
2389 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002390
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002391 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2392 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002393 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002394 psa_mac_abort( operation );
2395
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002396 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002397}
2398
Steven Cooremana5b860a2021-03-19 19:04:39 +01002399psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002400 uint8_t *mac,
2401 size_t mac_size,
2402 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002403{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002404 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2405 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002406
Steven Cooremana5b860a2021-03-19 19:04:39 +01002407 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002408 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002409 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002410 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002411 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002412
Steven Cooreman72f736a2021-05-07 14:14:37 +02002413 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002414 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002415 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002416 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002417 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002418
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002419 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2420 * once all the error checks are done. */
2421 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002422 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002423 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002424 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002425 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002426
2427 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002428 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002429 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002430 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002431 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002432
Steven Cooremana5b860a2021-03-19 19:04:39 +01002433 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002434 mac, operation->mac_size,
2435 mac_length );
2436
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002437exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002438 /* In case of success, set the potential excess room in the output buffer
2439 * to an invalid value, to avoid potentially leaking a longer MAC.
2440 * In case of error, set the output length and content to a safe default,
2441 * such that in case the caller misses an error check, the output would be
2442 * an unachievable MAC.
2443 */
2444 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002445 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002446 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002447 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002448 }
mohammad16036df908f2018-04-02 08:34:15 -07002449
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002450 if( mac_size > operation->mac_size )
2451 memset( &mac[operation->mac_size], '!',
2452 mac_size - operation->mac_size );
2453
Steven Cooremana5b860a2021-03-19 19:04:39 +01002454 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002455
Steven Cooremana5b860a2021-03-19 19:04:39 +01002456 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002457}
2458
Steven Cooremana5b860a2021-03-19 19:04:39 +01002459psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002460 const uint8_t *mac,
2461 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002462{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002463 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2464 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002465
Steven Cooremana5b860a2021-03-19 19:04:39 +01002466 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002467 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002468 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002469 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002470 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002471
Steven Cooreman72f736a2021-05-07 14:14:37 +02002472 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002473 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002474 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002475 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002476 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002477
2478 if( operation->mac_size != mac_length )
2479 {
2480 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002481 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002482 }
2483
Steven Cooremana5b860a2021-03-19 19:04:39 +01002484 status = psa_driver_wrapper_mac_verify_finish( operation,
2485 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002486
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002487exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002488 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002489
Steven Cooremana5b860a2021-03-19 19:04:39 +01002490 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002491}
2492
Ronald Croncd989b52021-06-18 14:23:33 +02002493static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2494 psa_algorithm_t alg,
2495 const uint8_t *input,
2496 size_t input_length,
2497 uint8_t *mac,
2498 size_t mac_size,
2499 size_t *mac_length,
2500 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002501{
2502 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002503 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2504 psa_key_slot_t *slot;
2505 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002506
Ronald Cron51131b52021-06-17 17:17:20 +02002507 status = psa_get_and_lock_key_slot_with_policy(
Ronald Croncd989b52021-06-18 14:23:33 +02002508 key, &slot,
2509 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2510 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002511 if( status != PSA_SUCCESS )
2512 goto exit;
2513
Ronald Cron51131b52021-06-17 17:17:20 +02002514 psa_key_attributes_t attributes = {
2515 .core = slot->attr
2516 };
2517
2518 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2519 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002520 if( status != PSA_SUCCESS )
2521 goto exit;
2522
Ronald Cron51131b52021-06-17 17:17:20 +02002523 if( mac_size < operation_mac_size )
2524 {
2525 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002526 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002527 }
2528
2529 status = psa_driver_wrapper_mac_compute(
2530 &attributes,
2531 slot->key.data, slot->key.bytes,
2532 alg,
2533 input, input_length,
2534 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002535
2536exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002537 /* In case of success, set the potential excess room in the output buffer
2538 * to an invalid value, to avoid potentially leaking a longer MAC.
2539 * In case of error, set the output length and content to a safe default,
2540 * such that in case the caller misses an error check, the output would be
2541 * an unachievable MAC.
2542 */
2543 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002544 {
Ronald Cron51131b52021-06-17 17:17:20 +02002545 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002546 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002547 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002548 if( mac_size > operation_mac_size )
2549 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002550
Ronald Cron51131b52021-06-17 17:17:20 +02002551 unlock_status = psa_unlock_key_slot( slot );
2552
2553 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002554}
2555
Ronald Croncd989b52021-06-18 14:23:33 +02002556psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2557 psa_algorithm_t alg,
2558 const uint8_t *input,
2559 size_t input_length,
2560 uint8_t *mac,
2561 size_t mac_size,
2562 size_t *mac_length)
2563{
2564 return( psa_mac_compute_internal( key, alg,
2565 input, input_length,
2566 mac, mac_size, mac_length, 1 ) );
2567}
2568
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002569psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2570 psa_algorithm_t alg,
2571 const uint8_t *input,
2572 size_t input_length,
2573 const uint8_t *mac,
2574 size_t mac_length)
2575{
2576 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002577 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2578 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002579
Ronald Crona587cbc2021-06-18 14:51:29 +02002580 status = psa_mac_compute_internal( key, alg,
2581 input, input_length,
2582 actual_mac, sizeof( actual_mac ),
2583 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002584 if( status != PSA_SUCCESS )
2585 goto exit;
2586
Ronald Crona587cbc2021-06-18 14:51:29 +02002587 if( mac_length != actual_mac_length )
2588 {
2589 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002590 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002591 }
2592 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
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 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002597
2598exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002599 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002600
2601 return ( status );
2602}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002603
Gilles Peskinee59236f2018-01-27 23:32:46 +01002604/****************************************************************/
2605/* Asymmetric cryptography */
2606/****************************************************************/
2607
gabor-mezei-armf0486182021-05-12 11:03:09 +02002608static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002609 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002610{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002611 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002612 {
2613 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2614 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002615
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002616 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2617 {
2618 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2619 return( PSA_ERROR_INVALID_ARGUMENT );
2620 }
2621 }
2622 else
2623 {
2624 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2625 return( PSA_ERROR_INVALID_ARGUMENT );
2626 }
2627
2628 return( PSA_SUCCESS );
2629}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002630
2631static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002632 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002633 psa_algorithm_t alg,
2634 const uint8_t * input,
2635 size_t input_length,
2636 uint8_t * signature,
2637 size_t signature_size,
2638 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002639{
2640 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2641 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2642 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002643
2644 *signature_length = 0;
2645
gabor-mezei-armf0486182021-05-12 11:03:09 +02002646 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002647 if( status != PSA_SUCCESS )
2648 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002649
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002650 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002651 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002652 * buffer can in principle be empty since it doesn't actually have
2653 * to be a hash.) */
2654 if( signature_size == 0 )
2655 return( PSA_ERROR_BUFFER_TOO_SMALL );
2656
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002657 status = psa_get_and_lock_key_slot_with_policy(
2658 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002659 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2660 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002661 alg );
2662
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002663 if( status != PSA_SUCCESS )
2664 goto exit;
2665
2666 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2667 {
2668 status = PSA_ERROR_INVALID_ARGUMENT;
2669 goto exit;
2670 }
2671
2672 psa_key_attributes_t attributes = {
2673 .core = slot->attr
2674 };
2675
gabor-mezei-armf0486182021-05-12 11:03:09 +02002676 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002677 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002678 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002679 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002680 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002681 signature, signature_size, signature_length );
2682 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002683 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002684 {
2685
2686 status = psa_driver_wrapper_sign_hash(
2687 &attributes, slot->key.data, slot->key.bytes,
2688 alg, input, input_length,
2689 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002690 }
2691
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002692
2693exit:
2694 /* Fill the unused part of the output buffer (the whole buffer on error,
2695 * the trailing part on success) with something that isn't a valid signature
2696 * (barring an attack on the signature and deliberately-crafted input),
2697 * in case the caller doesn't check the return status properly. */
2698 if( status == PSA_SUCCESS )
2699 memset( signature + *signature_length, '!',
2700 signature_size - *signature_length );
2701 else
2702 memset( signature, '!', signature_size );
2703 /* If signature_size is 0 then we have nothing to do. We must not call
2704 * memset because signature may be NULL in this case. */
2705
2706 unlock_status = psa_unlock_key_slot( slot );
2707
2708 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2709}
2710
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002711static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002712 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002713 psa_algorithm_t alg,
2714 const uint8_t * input,
2715 size_t input_length,
2716 const uint8_t * signature,
2717 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002718{
2719 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2720 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2721 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002722
gabor-mezei-armf0486182021-05-12 11:03:09 +02002723 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002724 if( status != PSA_SUCCESS )
2725 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002726
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002727 status = psa_get_and_lock_key_slot_with_policy(
2728 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002729 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2730 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002731 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002732
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002733 if( status != PSA_SUCCESS )
2734 return( status );
2735
2736 psa_key_attributes_t attributes = {
2737 .core = slot->attr
2738 };
2739
gabor-mezei-armf0486182021-05-12 11:03:09 +02002740 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002741 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002742 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002743 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002744 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002745 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002746 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002747 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002748 {
2749 status = psa_driver_wrapper_verify_hash(
2750 &attributes, slot->key.data, slot->key.bytes,
2751 alg, input, input_length,
2752 signature, signature_length );
2753 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002754
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002755 unlock_status = psa_unlock_key_slot( slot );
2756
2757 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002758
2759}
2760
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002761psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002762 const psa_key_attributes_t *attributes,
2763 const uint8_t *key_buffer,
2764 size_t key_buffer_size,
2765 psa_algorithm_t alg,
2766 const uint8_t *input,
2767 size_t input_length,
2768 uint8_t *signature,
2769 size_t signature_size,
2770 size_t *signature_length )
2771{
2772 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002773
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002774 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2775 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002776 size_t hash_length;
2777 uint8_t hash[PSA_HASH_MAX_SIZE];
2778
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002779 status = psa_driver_wrapper_hash_compute(
2780 PSA_ALG_SIGN_GET_HASH( alg ),
2781 input, input_length,
2782 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002783
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002784 if( status != PSA_SUCCESS )
2785 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002786
2787 return psa_driver_wrapper_sign_hash(
2788 attributes, key_buffer, key_buffer_size,
2789 alg, hash, hash_length,
2790 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002791 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002792
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002793 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002794}
2795
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002796psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2797 psa_algorithm_t alg,
2798 const uint8_t * input,
2799 size_t input_length,
2800 uint8_t * signature,
2801 size_t signature_size,
2802 size_t * signature_length )
2803{
2804 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002805 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002806 signature, signature_size, signature_length );
2807}
2808
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002809psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002810 const psa_key_attributes_t *attributes,
2811 const uint8_t *key_buffer,
2812 size_t key_buffer_size,
2813 psa_algorithm_t alg,
2814 const uint8_t *input,
2815 size_t input_length,
2816 const uint8_t *signature,
2817 size_t signature_length )
2818{
2819 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002820
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002821 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2822 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002823 size_t hash_length;
2824 uint8_t hash[PSA_HASH_MAX_SIZE];
2825
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002826 status = psa_driver_wrapper_hash_compute(
2827 PSA_ALG_SIGN_GET_HASH( alg ),
2828 input, input_length,
2829 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002830
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002831 if( status != PSA_SUCCESS )
2832 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002833
2834 return psa_driver_wrapper_verify_hash(
2835 attributes, key_buffer, key_buffer_size,
2836 alg, hash, hash_length,
2837 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002838 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002839
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002840 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002841}
2842
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002843psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2844 psa_algorithm_t alg,
2845 const uint8_t * input,
2846 size_t input_length,
2847 const uint8_t * signature,
2848 size_t signature_length )
2849{
2850 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002851 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002852 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002853}
2854
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002855psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002856 const psa_key_attributes_t *attributes,
2857 const uint8_t *key_buffer, size_t key_buffer_size,
2858 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2859 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002860{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002861 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002862 {
Ronald Cron4501c982021-03-19 20:09:32 +01002863 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2864 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002865 {
Ronald Cron4501c982021-03-19 20:09:32 +01002866#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2867 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2868 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002869 attributes,
2870 key_buffer, key_buffer_size,
2871 alg, hash, hash_length,
2872 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002873#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2874 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002875 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002876 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002877 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002878 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002879 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002880 }
2881 else
Ronald Cron4501c982021-03-19 20:09:32 +01002882 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2883 {
2884 if( PSA_ALG_IS_ECDSA( alg ) )
2885 {
2886#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2887 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2888 return( mbedtls_psa_ecdsa_sign_hash(
2889 attributes,
2890 key_buffer, key_buffer_size,
2891 alg, hash, hash_length,
2892 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002893#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2894 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002895 }
2896 else
2897 {
2898 return( PSA_ERROR_INVALID_ARGUMENT );
2899 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002900 }
Ronald Cron4501c982021-03-19 20:09:32 +01002901
2902 (void)key_buffer;
2903 (void)key_buffer_size;
2904 (void)hash;
2905 (void)hash_length;
2906 (void)signature;
2907 (void)signature_size;
2908 (void)signature_length;
2909
2910 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002911}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002912
2913psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2914 psa_algorithm_t alg,
2915 const uint8_t *hash,
2916 size_t hash_length,
2917 uint8_t *signature,
2918 size_t signature_size,
2919 size_t *signature_length )
2920{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002921 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002922 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002923 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002924}
2925
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002926psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002927 const psa_key_attributes_t *attributes,
2928 const uint8_t *key_buffer, size_t key_buffer_size,
2929 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2930 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002931{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002932 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002933 {
Ronald Cron4501c982021-03-19 20:09:32 +01002934 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2935 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002936 {
Ronald Cron4501c982021-03-19 20:09:32 +01002937#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2938 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2939 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002940 attributes,
2941 key_buffer, key_buffer_size,
2942 alg, hash, hash_length,
2943 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002944#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2945 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002946 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002947 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002948 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002949 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002950 }
itayzafrir5c753392018-05-08 11:18:38 +03002951 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002952 else
Ronald Cron4501c982021-03-19 20:09:32 +01002953 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002954 {
Ronald Cron4501c982021-03-19 20:09:32 +01002955 if( PSA_ALG_IS_ECDSA( alg ) )
2956 {
2957#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2958 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2959 return( mbedtls_psa_ecdsa_verify_hash(
2960 attributes,
2961 key_buffer, key_buffer_size,
2962 alg, hash, hash_length,
2963 signature, signature_length ) );
2964#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2965 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2966 }
2967 else
2968 {
2969 return( PSA_ERROR_INVALID_ARGUMENT );
2970 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002971 }
Ronald Cron4501c982021-03-19 20:09:32 +01002972
2973 (void)key_buffer;
2974 (void)key_buffer_size;
2975 (void)hash;
2976 (void)hash_length;
2977 (void)signature;
2978 (void)signature_length;
2979
2980 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002981}
2982
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002983psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2984 psa_algorithm_t alg,
2985 const uint8_t *hash,
2986 size_t hash_length,
2987 const uint8_t *signature,
2988 size_t signature_length )
2989{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002990 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002991 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002992 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002993}
2994
John Durkop0e005192020-10-31 22:06:54 -07002995#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002996static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2997 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002998{
2999 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3000 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3001 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003002
3003 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003004}
John Durkop0e005192020-10-31 22:06:54 -07003005#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003006
Ronald Croncf56a0a2020-08-04 09:51:30 +02003007psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003008 psa_algorithm_t alg,
3009 const uint8_t *input,
3010 size_t input_length,
3011 const uint8_t *salt,
3012 size_t salt_length,
3013 uint8_t *output,
3014 size_t output_size,
3015 size_t *output_length )
3016{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003017 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003018 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003019 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003020
Darryl Green5cc689a2018-07-24 15:34:10 +01003021 (void) input;
3022 (void) input_length;
3023 (void) salt;
3024 (void) output;
3025 (void) output_size;
3026
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003027 *output_length = 0;
3028
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003029 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3030 return( PSA_ERROR_INVALID_ARGUMENT );
3031
Ronald Cron5c522922020-11-14 16:35:34 +01003032 status = psa_get_and_lock_transparent_key_slot_with_policy(
3033 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003034 if( status != PSA_SUCCESS )
3035 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003036 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3037 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003038 {
3039 status = PSA_ERROR_INVALID_ARGUMENT;
3040 goto exit;
3041 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003042
John Durkop6ba40d12020-11-10 08:50:04 -08003043#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3044 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003045 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003046 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003047 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003048 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3049 slot->key.data,
3050 slot->key.bytes,
3051 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003052 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003053 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003054
3055 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003056 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003057 status = PSA_ERROR_BUFFER_TOO_SMALL;
3058 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003059 }
John Durkop0e005192020-10-31 22:06:54 -07003060#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003061 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3062 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003063 status = mbedtls_to_psa_error(
3064 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003065 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003066 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003067 input_length,
3068 input,
3069 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003070 }
3071 else
John Durkop0e005192020-10-31 22:06:54 -07003072#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3073#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003074 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3075 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003076 status = mbedtls_to_psa_error(
3077 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3078 if( status != PSA_SUCCESS )
3079 goto rsa_exit;
3080
Steven Cooreman4fed4552020-08-03 14:46:03 +02003081 status = mbedtls_to_psa_error(
3082 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003083 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003084 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003085 salt, salt_length,
3086 input_length,
3087 input,
3088 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003089 }
3090 else
John Durkop0e005192020-10-31 22:06:54 -07003091#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003092 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003093 status = PSA_ERROR_INVALID_ARGUMENT;
3094 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003095 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003096rsa_exit:
3097 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003098 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003099
Steven Cooremana2371e52020-07-28 14:30:39 +02003100 mbedtls_rsa_free( rsa );
3101 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003102 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003103 else
John Durkop9814fa22020-11-04 12:28:15 -08003104#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003105 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003106 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003107 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003109
3110exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003111 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003112
Ronald Cron5c522922020-11-14 16:35:34 +01003113 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003114}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115
Ronald Croncf56a0a2020-08-04 09:51:30 +02003116psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003117 psa_algorithm_t alg,
3118 const uint8_t *input,
3119 size_t input_length,
3120 const uint8_t *salt,
3121 size_t salt_length,
3122 uint8_t *output,
3123 size_t output_size,
3124 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003125{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003126 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003127 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003128 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003129
Darryl Green5cc689a2018-07-24 15:34:10 +01003130 (void) input;
3131 (void) input_length;
3132 (void) salt;
3133 (void) output;
3134 (void) output_size;
3135
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003136 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003137
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003138 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3139 return( PSA_ERROR_INVALID_ARGUMENT );
3140
Ronald Cron5c522922020-11-14 16:35:34 +01003141 status = psa_get_and_lock_transparent_key_slot_with_policy(
3142 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003143 if( status != PSA_SUCCESS )
3144 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003145 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003146 {
3147 status = PSA_ERROR_INVALID_ARGUMENT;
3148 goto exit;
3149 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003150
John Durkop6ba40d12020-11-10 08:50:04 -08003151#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3152 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003153 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003155 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003156 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3157 slot->key.data,
3158 slot->key.bytes,
3159 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003160 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003161 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162
Steven Cooremana2371e52020-07-28 14:30:39 +02003163 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003164 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003165 status = PSA_ERROR_INVALID_ARGUMENT;
3166 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003167 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003168
John Durkop0e005192020-10-31 22:06:54 -07003169#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003170 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003171 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003172 status = mbedtls_to_psa_error(
3173 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003174 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003175 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003176 output_length,
3177 input,
3178 output,
3179 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003180 }
3181 else
John Durkop0e005192020-10-31 22:06:54 -07003182#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3183#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003184 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003185 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003186 status = mbedtls_to_psa_error(
3187 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3188 if( status != PSA_SUCCESS )
3189 goto rsa_exit;
3190
Steven Cooreman4fed4552020-08-03 14:46:03 +02003191 status = mbedtls_to_psa_error(
3192 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003193 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003194 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003195 salt, salt_length,
3196 output_length,
3197 input,
3198 output,
3199 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003200 }
3201 else
John Durkop0e005192020-10-31 22:06:54 -07003202#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003203 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003204 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003206
Steven Cooreman4fed4552020-08-03 14:46:03 +02003207rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003208 mbedtls_rsa_free( rsa );
3209 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003211 else
John Durkop6ba40d12020-11-10 08:50:04 -08003212#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3213 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003215 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003216 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003217
3218exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003219 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003220
Ronald Cron5c522922020-11-14 16:35:34 +01003221 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003222}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003223
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003224
3225
mohammad1603503973b2018-03-12 15:59:30 +02003226/****************************************************************/
3227/* Symmetric cryptography */
3228/****************************************************************/
3229
Ronald Cronab99ac22020-10-01 16:38:28 +02003230static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3231 mbedtls_svc_key_id_t key,
3232 psa_algorithm_t alg,
3233 mbedtls_operation_t cipher_operation )
3234{
3235 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3236 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003237 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003238 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3239 PSA_KEY_USAGE_ENCRYPT :
3240 PSA_KEY_USAGE_DECRYPT );
3241
3242 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003243 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003244 {
Dave Rodgman54648242021-06-24 11:49:45 +01003245 status = PSA_ERROR_BAD_STATE;
3246 goto exit;
3247 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003248
Ronald Cronab99ac22020-10-01 16:38:28 +02003249 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003250 {
Dave Rodgman54648242021-06-24 11:49:45 +01003251 status = PSA_ERROR_INVALID_ARGUMENT;
3252 goto exit;
3253 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003254
Ronald Cronab99ac22020-10-01 16:38:28 +02003255 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3256 if( status != PSA_SUCCESS )
3257 goto exit;
3258
Ronald Cron49fafa92021-03-10 08:34:23 +01003259 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003260 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003261 * so we only set it (in the driver wrapper) after resources have been
3262 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003263 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003264 if( alg == PSA_ALG_ECB_NO_PADDING )
3265 operation->iv_required = 0;
3266 else
3267 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003268 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003269
Ronald Crona4af55f2020-12-14 14:36:06 +01003270 psa_key_attributes_t attributes = {
3271 .core = slot->attr
3272 };
3273
Ronald Cronab99ac22020-10-01 16:38:28 +02003274 /* Try doing the operation through a driver before using software fallback. */
3275 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003276 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3277 &attributes,
3278 slot->key.data,
3279 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003280 alg );
3281 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003282 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3283 &attributes,
3284 slot->key.data,
3285 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003286 alg );
3287
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003288exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003289 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003290 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003291
Ronald Cron5c522922020-11-14 16:35:34 +01003292 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003293
Ronald Cron5c522922020-11-14 16:35:34 +01003294 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003295}
3296
Gilles Peskinefe119512018-07-08 21:39:34 +02003297psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003298 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003299 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003300{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003301 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003302}
3303
Gilles Peskinefe119512018-07-08 21:39:34 +02003304psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003305 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003306 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003307{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003308 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003309}
3310
Gilles Peskinefe119512018-07-08 21:39:34 +02003311psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003312 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003313 size_t iv_size,
3314 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003315{
Ronald Cron6d051732020-10-01 14:10:20 +02003316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003317
Ronald Cron5618a392021-03-26 09:52:26 +01003318 *iv_length = 0;
3319
Ronald Cron49fafa92021-03-10 08:34:23 +01003320 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003321 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003322 status = PSA_ERROR_BAD_STATE;
3323 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003324 }
3325
Steven Cooreman7df02922020-09-09 15:28:49 +02003326 if( operation->iv_set || ! operation->iv_required )
3327 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003328 status = PSA_ERROR_BAD_STATE;
3329 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003330 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003331
Ronald Cron5618a392021-03-26 09:52:26 +01003332 if( iv_size < operation->default_iv_length )
3333 {
3334 status = PSA_ERROR_BUFFER_TOO_SMALL;
3335 goto exit;
3336 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003337
Ronald Cron5618a392021-03-26 09:52:26 +01003338 status = psa_generate_random( iv, operation->default_iv_length );
3339 if( status != PSA_SUCCESS )
3340 goto exit;
3341
3342 status = psa_driver_wrapper_cipher_set_iv( operation,
3343 iv,
3344 operation->default_iv_length );
3345
3346exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003347 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003348 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003349 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003350 *iv_length = operation->default_iv_length;
3351 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003352 else
Moran Peker395db872018-05-31 14:07:14 +03003353 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003354
itayzafrir534bd7c2018-08-02 13:56:32 +03003355 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003356}
3357
Gilles Peskinefe119512018-07-08 21:39:34 +02003358psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003359 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003360 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003361{
Ronald Cron6d051732020-10-01 14:10:20 +02003362 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003363
Ronald Cron49fafa92021-03-10 08:34:23 +01003364 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003365 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003366 status = PSA_ERROR_BAD_STATE;
3367 goto exit;
3368 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003369
Steven Cooreman7df02922020-09-09 15:28:49 +02003370 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003371 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003372 status = PSA_ERROR_BAD_STATE;
3373 goto exit;
3374 }
Ronald Crona0d68172021-03-26 10:15:08 +01003375
3376 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003377 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003378 status = PSA_ERROR_INVALID_ARGUMENT;
3379 goto exit;
3380 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003381
Ronald Crondd24c9b2020-12-15 14:10:01 +01003382 status = psa_driver_wrapper_cipher_set_iv( operation,
3383 iv,
3384 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003385
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003386exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003387 if( status == PSA_SUCCESS )
3388 operation->iv_set = 1;
3389 else
mohammad1603503973b2018-03-12 15:59:30 +02003390 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003391 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003392}
3393
Gilles Peskinee553c652018-06-04 16:22:46 +02003394psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3395 const uint8_t *input,
3396 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003397 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003398 size_t output_size,
3399 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003400{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003401 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003402
Ronald Cron49fafa92021-03-10 08:34:23 +01003403 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003404 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003405 status = PSA_ERROR_BAD_STATE;
3406 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003407 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003408
Steven Cooreman7df02922020-09-09 15:28:49 +02003409 if( operation->iv_required && ! operation->iv_set )
3410 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003411 status = PSA_ERROR_BAD_STATE;
3412 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003413 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003414
Ronald Crondd24c9b2020-12-15 14:10:01 +01003415 status = psa_driver_wrapper_cipher_update( operation,
3416 input,
3417 input_length,
3418 output,
3419 output_size,
3420 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003421
3422exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003423 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003424 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003425
itayzafrir534bd7c2018-08-02 13:56:32 +03003426 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003427}
3428
Gilles Peskinee553c652018-06-04 16:22:46 +02003429psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3430 uint8_t *output,
3431 size_t output_size,
3432 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003433{
David Saadab4ecc272019-02-14 13:48:10 +02003434 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003435
Ronald Cron49fafa92021-03-10 08:34:23 +01003436 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003437 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003438 status = PSA_ERROR_BAD_STATE;
3439 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003440 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003441
Steven Cooreman7df02922020-09-09 15:28:49 +02003442 if( operation->iv_required && ! operation->iv_set )
3443 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003444 status = PSA_ERROR_BAD_STATE;
3445 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003446 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003447
Ronald Crondd24c9b2020-12-15 14:10:01 +01003448 status = psa_driver_wrapper_cipher_finish( operation,
3449 output,
3450 output_size,
3451 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003452
3453exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003454 if( status == PSA_SUCCESS )
3455 return( psa_cipher_abort( operation ) );
3456 else
3457 {
3458 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003459 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003460
Steven Cooremanef8575e2020-09-11 11:44:50 +02003461 return( status );
3462 }
mohammad1603503973b2018-03-12 15:59:30 +02003463}
3464
Gilles Peskinee553c652018-06-04 16:22:46 +02003465psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3466{
Ronald Cron49fafa92021-03-10 08:34:23 +01003467 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003468 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003469 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003470 * in use. It's ok to call abort on such an object, and there's
3471 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003472 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003473 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003474
Ronald Crondd24c9b2020-12-15 14:10:01 +01003475 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003476
Ronald Cron49fafa92021-03-10 08:34:23 +01003477 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003478 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003479 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003480
Moran Peker395db872018-05-31 14:07:14 +03003481 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003482}
3483
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003484psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3485 psa_algorithm_t alg,
3486 const uint8_t *input,
3487 size_t input_length,
3488 uint8_t *output,
3489 size_t output_size,
3490 size_t *output_length )
3491{
3492 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003493 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3494 psa_key_slot_t *slot;
3495 psa_key_type_t key_type;
3496 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003497
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003498 *output_length = 0;
3499
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003500 if( ! PSA_ALG_IS_CIPHER( alg ) )
3501 return( PSA_ERROR_INVALID_ARGUMENT );
3502
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003503 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3504 PSA_KEY_USAGE_ENCRYPT,
3505 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003506 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003507 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003508
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003509 psa_key_attributes_t attributes = {
3510 .core = slot->attr
3511 };
3512
3513 key_type = slot->attr.type;
3514 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3515
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003516 if( output_size < PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg,
3517 input_length ) )
3518 {
3519 status = PSA_ERROR_BUFFER_TOO_SMALL;
3520 goto exit;
3521 }
3522
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003523 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003524 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003525 if( output_size < iv_length )
3526 {
3527 status = PSA_ERROR_BUFFER_TOO_SMALL;
3528 goto exit;
3529 }
3530
3531 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003532 if( status != PSA_SUCCESS )
3533 goto exit;
3534 }
3535
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003536 status = psa_driver_wrapper_cipher_encrypt(
3537 &attributes, slot->key.data, slot->key.bytes,
3538 alg, input, input_length,
3539 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003540
3541exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003542 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003543
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003544 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003545}
3546
3547psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3548 psa_algorithm_t alg,
3549 const uint8_t *input,
3550 size_t input_length,
3551 uint8_t *output,
3552 size_t output_size,
3553 size_t *output_length )
3554{
3555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003556 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3557 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003558
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003559 *output_length = 0;
3560
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003561 if( ! PSA_ALG_IS_CIPHER( alg ) )
3562 return( PSA_ERROR_INVALID_ARGUMENT );
3563
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003564 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3565 PSA_KEY_USAGE_DECRYPT,
3566 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003567 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003568 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003569
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003570 psa_key_attributes_t attributes = {
3571 .core = slot->attr
3572 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003573
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003574 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3575 {
3576 status = PSA_ERROR_INVALID_ARGUMENT;
3577 goto exit;
3578 }
3579
3580 if( output_size < PSA_CIPHER_DECRYPT_OUTPUT_SIZE( slot->attr.type, alg,
3581 input_length ) )
3582 {
3583 status = PSA_ERROR_BUFFER_TOO_SMALL;
3584 goto exit;
3585 }
3586
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003587 status = psa_driver_wrapper_cipher_decrypt(
3588 &attributes, slot->key.data, slot->key.bytes,
3589 alg, input, input_length,
3590 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003591
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003592exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003593 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003594
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003595 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003596}
3597
3598
mohammad16035955c982018-04-26 00:53:03 +03003599/****************************************************************/
3600/* AEAD */
3601/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003602
Ronald Croncf56a0a2020-08-04 09:51:30 +02003603psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003604 psa_algorithm_t alg,
3605 const uint8_t *nonce,
3606 size_t nonce_length,
3607 const uint8_t *additional_data,
3608 size_t additional_data_length,
3609 const uint8_t *plaintext,
3610 size_t plaintext_length,
3611 uint8_t *ciphertext,
3612 size_t ciphertext_size,
3613 size_t *ciphertext_length )
3614{
Ronald Cron215633c2021-03-16 17:15:37 +01003615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3616 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003617
mohammad1603f08a5502018-06-03 15:05:47 +03003618 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003619
Steven Cooremanea7ab132021-03-17 16:28:00 +01003620 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3621 return( PSA_ERROR_NOT_SUPPORTED );
3622
Ronald Cron9a986162021-03-26 12:40:07 +01003623 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003624 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003625 if( status != PSA_SUCCESS )
3626 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003627
Ronald Cron215633c2021-03-16 17:15:37 +01003628 psa_key_attributes_t attributes = {
3629 .core = slot->attr
3630 };
mohammad16035955c982018-04-26 00:53:03 +03003631
Ronald Cronde822812021-03-17 16:08:20 +01003632 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003633 &attributes, slot->key.data, slot->key.bytes,
3634 alg,
3635 nonce, nonce_length,
3636 additional_data, additional_data_length,
3637 plaintext, plaintext_length,
3638 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003639
Gilles Peskineedf9a652018-08-17 18:11:56 +02003640 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3641 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003642
Ronald Cron9f310172021-03-16 16:36:37 +01003643 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003644
mohammad16035955c982018-04-26 00:53:03 +03003645 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003646}
3647
Ronald Croncf56a0a2020-08-04 09:51:30 +02003648psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003649 psa_algorithm_t alg,
3650 const uint8_t *nonce,
3651 size_t nonce_length,
3652 const uint8_t *additional_data,
3653 size_t additional_data_length,
3654 const uint8_t *ciphertext,
3655 size_t ciphertext_length,
3656 uint8_t *plaintext,
3657 size_t plaintext_size,
3658 size_t *plaintext_length )
3659{
Ronald Cron215633c2021-03-16 17:15:37 +01003660 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3661 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003662
Gilles Peskineee652a32018-06-01 19:23:52 +02003663 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003664
Steven Cooremanea7ab132021-03-17 16:28:00 +01003665 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3666 return( PSA_ERROR_NOT_SUPPORTED );
3667
Ronald Cron9a986162021-03-26 12:40:07 +01003668 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003669 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003670 if( status != PSA_SUCCESS )
3671 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003672
Ronald Cron215633c2021-03-16 17:15:37 +01003673 psa_key_attributes_t attributes = {
3674 .core = slot->attr
3675 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003676
Ronald Cronde822812021-03-17 16:08:20 +01003677 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003678 &attributes, slot->key.data, slot->key.bytes,
3679 alg,
3680 nonce, nonce_length,
3681 additional_data, additional_data_length,
3682 ciphertext, ciphertext_length,
3683 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003684
Gilles Peskineedf9a652018-08-17 18:11:56 +02003685 if( status != PSA_SUCCESS && plaintext_size != 0 )
3686 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003687
Ronald Cron215633c2021-03-16 17:15:37 +01003688 psa_unlock_key_slot( slot );
3689
Gilles Peskineedf9a652018-08-17 18:11:56 +02003690 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003691}
3692
Gilles Peskinee59236f2018-01-27 23:32:46 +01003693/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003694/* Generators */
3695/****************************************************************/
3696
John Durkop07cc04a2020-11-16 22:08:34 -08003697#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3698 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3699 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3700#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003701#endif /* At least one builtin KDF */
3702
3703#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3704 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3705 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3706static psa_status_t psa_key_derivation_start_hmac(
3707 psa_mac_operation_t *operation,
3708 psa_algorithm_t hash_alg,
3709 const uint8_t *hmac_key,
3710 size_t hmac_key_length )
3711{
3712 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3713 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3714 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3715 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3716 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3717
Steven Cooreman72f736a2021-05-07 14:14:37 +02003718 operation->is_sign = 1;
3719 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3720
Steven Cooreman094a77e2021-05-06 17:58:36 +02003721 status = psa_driver_wrapper_mac_sign_setup( operation,
3722 &attributes,
3723 hmac_key, hmac_key_length,
3724 PSA_ALG_HMAC( hash_alg ) );
3725
3726 psa_reset_key_attributes( &attributes );
3727 return( status );
3728}
3729#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003730
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003731#define HKDF_STATE_INIT 0 /* no input yet */
3732#define HKDF_STATE_STARTED 1 /* got salt */
3733#define HKDF_STATE_KEYED 2 /* got key */
3734#define HKDF_STATE_OUTPUT 3 /* output started */
3735
Gilles Peskinecbe66502019-05-16 16:59:18 +02003736static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003737 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003738{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003739 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3740 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003741 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003742 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003743}
3744
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003745psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003746{
3747 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003748 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003749 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003750 {
3751 /* The object has (apparently) been initialized but it is not
3752 * in use. It's ok to call abort on such an object, and there's
3753 * nothing to do. */
3754 }
3755 else
John Durkopd0321952020-10-29 21:37:36 -07003756#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003757 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003758 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003759 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003760 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003761 }
John Durkop07cc04a2020-11-16 22:08:34 -08003762 else
3763#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3764#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3765 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3766 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003767 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003768 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003769 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003770 if( operation->ctx.tls12_prf.secret != NULL )
3771 {
3772 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3773 operation->ctx.tls12_prf.secret_length );
3774 mbedtls_free( operation->ctx.tls12_prf.secret );
3775 }
3776
Janos Follath6a1d2622019-06-11 10:37:28 +01003777 if( operation->ctx.tls12_prf.seed != NULL )
3778 {
3779 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3780 operation->ctx.tls12_prf.seed_length );
3781 mbedtls_free( operation->ctx.tls12_prf.seed );
3782 }
3783
3784 if( operation->ctx.tls12_prf.label != NULL )
3785 {
3786 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3787 operation->ctx.tls12_prf.label_length );
3788 mbedtls_free( operation->ctx.tls12_prf.label );
3789 }
3790
Steven Cooremana6df6042021-04-29 19:32:25 +02003791 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003792
3793 /* We leave the fields Ai and output_block to be erased safely by the
3794 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003795 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003796 else
John Durkop07cc04a2020-11-16 22:08:34 -08003797#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3798 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003799 {
3800 status = PSA_ERROR_BAD_STATE;
3801 }
Janos Follath083036a2019-06-11 10:22:26 +01003802 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003803 return( status );
3804}
3805
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003806psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003807 size_t *capacity)
3808{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003809 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003810 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003811 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003812 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003813 }
3814
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003815 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003816 return( PSA_SUCCESS );
3817}
3818
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003819psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003820 size_t capacity )
3821{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003822 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003823 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003824 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003825 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003826 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003827 return( PSA_SUCCESS );
3828}
3829
John Durkopd0321952020-10-29 21:37:36 -07003830#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003831/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003832 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003833static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003834 psa_algorithm_t hash_alg,
3835 uint8_t *output,
3836 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003837{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003838 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003839 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003840 psa_status_t status;
3841
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003842 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3843 return( PSA_ERROR_BAD_STATE );
3844 hkdf->state = HKDF_STATE_OUTPUT;
3845
Gilles Peskinebef7f142018-07-12 17:22:21 +02003846 while( output_length != 0 )
3847 {
3848 /* Copy what remains of the current block */
3849 uint8_t n = hash_length - hkdf->offset_in_block;
3850 if( n > output_length )
3851 n = (uint8_t) output_length;
3852 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3853 output += n;
3854 output_length -= n;
3855 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003856 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003857 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003858 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003859 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003860 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003861 * object was corrupted or if this function is called directly
3862 * inside the library. */
3863 if( hkdf->block_number == 0xff )
3864 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003865
3866 /* We need a new block */
3867 ++hkdf->block_number;
3868 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003869
Steven Cooreman094a77e2021-05-06 17:58:36 +02003870 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3871 hash_alg,
3872 hkdf->prk,
3873 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003874 if( status != PSA_SUCCESS )
3875 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003876
Gilles Peskinebef7f142018-07-12 17:22:21 +02003877 if( hkdf->block_number != 1 )
3878 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003879 status = psa_mac_update( &hkdf->hmac,
3880 hkdf->output_block,
3881 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003882 if( status != PSA_SUCCESS )
3883 return( status );
3884 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003885 status = psa_mac_update( &hkdf->hmac,
3886 hkdf->info,
3887 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003888 if( status != PSA_SUCCESS )
3889 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003890 status = psa_mac_update( &hkdf->hmac,
3891 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003892 if( status != PSA_SUCCESS )
3893 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003894 status = psa_mac_sign_finish( &hkdf->hmac,
3895 hkdf->output_block,
3896 sizeof( hkdf->output_block ),
3897 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003898 if( status != PSA_SUCCESS )
3899 return( status );
3900 }
3901
3902 return( PSA_SUCCESS );
3903}
John Durkop07cc04a2020-11-16 22:08:34 -08003904#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003905
John Durkop07cc04a2020-11-16 22:08:34 -08003906#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3907 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003908static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3909 psa_tls12_prf_key_derivation_t *tls12_prf,
3910 psa_algorithm_t alg )
3911{
3912 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003913 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003914 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3915 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003916 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003917
Janos Follath7742fee2019-06-17 12:58:10 +01003918 /* We can't be wanting more output after block 0xff, otherwise
3919 * the capacity check in psa_key_derivation_output_bytes() would have
3920 * prevented this call. It could happen only if the operation
3921 * object was corrupted or if this function is called directly
3922 * inside the library. */
3923 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003924 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003925
3926 /* We need a new block */
3927 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003928 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003929
3930 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3931 *
3932 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3933 *
3934 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3935 * HMAC_hash(secret, A(2) + seed) +
3936 * HMAC_hash(secret, A(3) + seed) + ...
3937 *
3938 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003939 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003940 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003941 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003942 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003943 * is currently extracted as `output_block` and where i is
3944 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003945 */
3946
Steven Cooreman094a77e2021-05-06 17:58:36 +02003947 status = psa_key_derivation_start_hmac( &hmac,
3948 hash_alg,
3949 tls12_prf->secret,
3950 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003951 if( status != PSA_SUCCESS )
3952 goto cleanup;
3953
3954 /* Calculate A(i) where i = tls12_prf->block_number. */
3955 if( tls12_prf->block_number == 1 )
3956 {
3957 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3958 * the variable seed and in this instance means it in the context of the
3959 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003960 status = psa_mac_update( &hmac,
3961 tls12_prf->label,
3962 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003963 if( status != PSA_SUCCESS )
3964 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003965 status = psa_mac_update( &hmac,
3966 tls12_prf->seed,
3967 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003968 if( status != PSA_SUCCESS )
3969 goto cleanup;
3970 }
3971 else
3972 {
3973 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003974 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003975 if( status != PSA_SUCCESS )
3976 goto cleanup;
3977 }
3978
Steven Cooremana6df6042021-04-29 19:32:25 +02003979 status = psa_mac_sign_finish( &hmac,
3980 tls12_prf->Ai, hash_length,
3981 &hmac_output_length );
3982 if( hmac_output_length != hash_length )
3983 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003984 if( status != PSA_SUCCESS )
3985 goto cleanup;
3986
3987 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003988 status = psa_key_derivation_start_hmac( &hmac,
3989 hash_alg,
3990 tls12_prf->secret,
3991 tls12_prf->secret_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_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003995 if( status != PSA_SUCCESS )
3996 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003997 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003998 if( status != PSA_SUCCESS )
3999 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004000 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004001 if( status != PSA_SUCCESS )
4002 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004003 status = psa_mac_sign_finish( &hmac,
4004 tls12_prf->output_block, hash_length,
4005 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004006 if( status != PSA_SUCCESS )
4007 goto cleanup;
4008
Janos Follath7742fee2019-06-17 12:58:10 +01004009
4010cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004011 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004012 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4013 status = cleanup_status;
4014
4015 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004016}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004017
Janos Follath844eb0e2019-06-19 12:10:49 +01004018static psa_status_t psa_key_derivation_tls12_prf_read(
4019 psa_tls12_prf_key_derivation_t *tls12_prf,
4020 psa_algorithm_t alg,
4021 uint8_t *output,
4022 size_t output_length )
4023{
4024 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004025 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004026 psa_status_t status;
4027 uint8_t offset, length;
4028
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004029 switch( tls12_prf->state )
4030 {
4031 case PSA_TLS12_PRF_STATE_LABEL_SET:
4032 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4033 break;
4034 case PSA_TLS12_PRF_STATE_OUTPUT:
4035 break;
4036 default:
4037 return( PSA_ERROR_BAD_STATE );
4038 }
4039
Janos Follath844eb0e2019-06-19 12:10:49 +01004040 while( output_length != 0 )
4041 {
4042 /* Check if we have fully processed the current block. */
4043 if( tls12_prf->left_in_block == 0 )
4044 {
4045 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4046 alg );
4047 if( status != PSA_SUCCESS )
4048 return( status );
4049
4050 continue;
4051 }
4052
4053 if( tls12_prf->left_in_block > output_length )
4054 length = (uint8_t) output_length;
4055 else
4056 length = tls12_prf->left_in_block;
4057
4058 offset = hash_length - tls12_prf->left_in_block;
4059 memcpy( output, tls12_prf->output_block + offset, length );
4060 output += length;
4061 output_length -= length;
4062 tls12_prf->left_in_block -= length;
4063 }
4064
4065 return( PSA_SUCCESS );
4066}
John Durkop07cc04a2020-11-16 22:08:34 -08004067#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4068 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004069
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004070psa_status_t psa_key_derivation_output_bytes(
4071 psa_key_derivation_operation_t *operation,
4072 uint8_t *output,
4073 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004074{
4075 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004076 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004077
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004078 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004079 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004080 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004081 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004082 }
4083
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004084 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004085 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004086 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004087 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004088 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004089 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004090 goto exit;
4091 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004092 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004093 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004094 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004095 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004096 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4097 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004098 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004099 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004100 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004101 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004102 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004103
John Durkopd0321952020-10-29 21:37:36 -07004104#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004105 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004106 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004107 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004108 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004109 output, output_length );
4110 }
Janos Follathadbec812019-06-14 11:05:39 +01004111 else
John Durkop07cc04a2020-11-16 22:08:34 -08004112#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4113#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4114 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004115 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004116 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004117 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004118 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004119 kdf_alg, output,
4120 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004121 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004122 else
John Durkop07cc04a2020-11-16 22:08:34 -08004123#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4124 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004125 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004126 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004127 return( PSA_ERROR_BAD_STATE );
4128 }
4129
4130exit:
4131 if( status != PSA_SUCCESS )
4132 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004133 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004134 * This allows us to differentiate between exhausted operations and
4135 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4136 * operations. */
4137 psa_algorithm_t alg = operation->alg;
4138 psa_key_derivation_abort( operation );
4139 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004140 memset( output, '!', output_length );
4141 }
4142 return( status );
4143}
4144
David Brown7807bf72021-02-09 16:28:23 -07004145#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004146static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4147{
4148 if( data_size >= 8 )
4149 mbedtls_des_key_set_parity( data );
4150 if( data_size >= 16 )
4151 mbedtls_des_key_set_parity( data + 8 );
4152 if( data_size >= 24 )
4153 mbedtls_des_key_set_parity( data + 16 );
4154}
David Brown7807bf72021-02-09 16:28:23 -07004155#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004156
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004157static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004158 psa_key_slot_t *slot,
4159 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004160 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004161{
4162 uint8_t *data = NULL;
4163 size_t bytes = PSA_BITS_TO_BYTES( bits );
4164 psa_status_t status;
4165
Gilles Peskine8e338702019-07-30 20:06:31 +02004166 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004167 return( PSA_ERROR_INVALID_ARGUMENT );
4168 if( bits % 8 != 0 )
4169 return( PSA_ERROR_INVALID_ARGUMENT );
4170 data = mbedtls_calloc( 1, bytes );
4171 if( data == NULL )
4172 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4173
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004174 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004175 if( status != PSA_SUCCESS )
4176 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004177#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004178 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004179 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004180#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004181
4182 status = psa_allocate_buffer_to_slot( slot, bytes );
4183 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004184 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004185
Ronald Cronbf33c932020-11-28 18:06:53 +01004186 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004187 psa_key_attributes_t attributes = {
4188 .core = slot->attr
4189 };
4190
Ronald Cronbf33c932020-11-28 18:06:53 +01004191 status = psa_driver_wrapper_import_key( &attributes,
4192 data, bytes,
4193 slot->key.data,
4194 slot->key.bytes,
4195 &slot->key.bytes, &bits );
4196 if( bits != slot->attr.bits )
4197 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004198
4199exit:
4200 mbedtls_free( data );
4201 return( status );
4202}
4203
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004204psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004205 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004206 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004207{
4208 psa_status_t status;
4209 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004210 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004211
Ronald Cron81709fc2020-11-14 12:10:32 +01004212 *key = MBEDTLS_SVC_KEY_ID_INIT;
4213
Gilles Peskine0f84d622019-09-12 19:03:13 +02004214 /* Reject any attempt to create a zero-length key so that we don't
4215 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4216 if( psa_get_key_bits( attributes ) == 0 )
4217 return( PSA_ERROR_INVALID_ARGUMENT );
4218
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004219 if( ! operation->can_output_key )
4220 return( PSA_ERROR_NOT_PERMITTED );
4221
Ronald Cron81709fc2020-11-14 12:10:32 +01004222 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4223 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004224#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4225 if( driver != NULL )
4226 {
4227 /* Deriving a key in a secure element is not implemented yet. */
4228 status = PSA_ERROR_NOT_SUPPORTED;
4229 }
4230#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004231 if( status == PSA_SUCCESS )
4232 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004233 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004234 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004235 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004236 }
4237 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004238 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004239 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004240 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004241
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004242 return( status );
4243}
4244
Gilles Peskineeab56e42018-07-12 17:12:33 +02004245
4246
4247/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004248/* Key derivation */
4249/****************************************************************/
4250
Steven Cooreman932ffb72021-02-15 12:14:32 +01004251#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004252static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004253 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004254 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004255{
John Durkop07cc04a2020-11-16 22:08:34 -08004256 int is_kdf_alg_supported;
4257
Janos Follath5fe19732019-06-20 15:09:30 +01004258 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4259 * initialisers for this union leave some bytes unspecified.) */
4260 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4261
Gilles Peskine969c5d62019-01-16 15:53:06 +01004262 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004263#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004264 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4265 is_kdf_alg_supported = 1;
4266 else
4267#endif
4268#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4269 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4270 is_kdf_alg_supported = 1;
4271 else
4272#endif
4273#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4274 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4275 is_kdf_alg_supported = 1;
4276 else
4277#endif
4278 is_kdf_alg_supported = 0;
4279
4280 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004281 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004282 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004283 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004284 if( hash_size == 0 )
4285 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004286 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4287 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004288 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004289 {
4290 return( PSA_ERROR_NOT_SUPPORTED );
4291 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004292 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004293 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004294 }
John Durkop07cc04a2020-11-16 22:08:34 -08004295
4296 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004297}
John Durkop07cc04a2020-11-16 22:08:34 -08004298#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004299
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004300psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004301 psa_algorithm_t alg )
4302{
4303 psa_status_t status;
4304
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004305 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004306 return( PSA_ERROR_BAD_STATE );
4307
Gilles Peskine6843c292019-01-18 16:44:49 +01004308 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4309 return( PSA_ERROR_INVALID_ARGUMENT );
4310 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004311 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004312#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004313 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004314 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004315#else
4316 return( PSA_ERROR_NOT_SUPPORTED );
4317#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004318 }
4319 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4320 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004321#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004322 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004323#else
4324 return( PSA_ERROR_NOT_SUPPORTED );
4325#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004326 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004327 else
4328 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004329
4330 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004331 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004332 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004333}
4334
John Durkopd0321952020-10-29 21:37:36 -07004335#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004336static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004337 psa_algorithm_t hash_alg,
4338 psa_key_derivation_step_t step,
4339 const uint8_t *data,
4340 size_t data_length )
4341{
4342 psa_status_t status;
4343 switch( step )
4344 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004345 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004346 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004347 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004348 else
4349 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004350 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4351 hash_alg,
4352 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004353 if( status != PSA_SUCCESS )
4354 return( status );
4355 hkdf->state = HKDF_STATE_STARTED;
4356 return( PSA_SUCCESS );
4357 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004358 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004359 /* If no salt was provided, use an empty salt. */
4360 if( hkdf->state == HKDF_STATE_INIT )
4361 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004362 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4363 hash_alg,
4364 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004365 if( status != PSA_SUCCESS )
4366 return( status );
4367 hkdf->state = HKDF_STATE_STARTED;
4368 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004369 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004370 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004371 status = psa_mac_update( &hkdf->hmac,
4372 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004373 if( status != PSA_SUCCESS )
4374 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004375 status = psa_mac_sign_finish( &hkdf->hmac,
4376 hkdf->prk,
4377 sizeof( hkdf->prk ),
4378 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004379 if( status != PSA_SUCCESS )
4380 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004381 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004382 hkdf->block_number = 0;
4383 hkdf->state = HKDF_STATE_KEYED;
4384 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004385 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004386 if( hkdf->state == HKDF_STATE_OUTPUT )
4387 return( PSA_ERROR_BAD_STATE );
4388 if( hkdf->info_set )
4389 return( PSA_ERROR_BAD_STATE );
4390 hkdf->info_length = data_length;
4391 if( data_length != 0 )
4392 {
4393 hkdf->info = mbedtls_calloc( 1, data_length );
4394 if( hkdf->info == NULL )
4395 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4396 memcpy( hkdf->info, data, data_length );
4397 }
4398 hkdf->info_set = 1;
4399 return( PSA_SUCCESS );
4400 default:
4401 return( PSA_ERROR_INVALID_ARGUMENT );
4402 }
4403}
John Durkop07cc04a2020-11-16 22:08:34 -08004404#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004405
John Durkop07cc04a2020-11-16 22:08:34 -08004406#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4407 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004408static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4409 const uint8_t *data,
4410 size_t data_length )
4411{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004412 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004413 return( PSA_ERROR_BAD_STATE );
4414
Janos Follathd6dce9f2019-07-04 09:11:38 +01004415 if( data_length != 0 )
4416 {
4417 prf->seed = mbedtls_calloc( 1, data_length );
4418 if( prf->seed == NULL )
4419 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004420
Janos Follathd6dce9f2019-07-04 09:11:38 +01004421 memcpy( prf->seed, data, data_length );
4422 prf->seed_length = data_length;
4423 }
Janos Follathf08e2652019-06-13 09:05:41 +01004424
Gilles Peskine43f958b2020-12-13 14:55:14 +01004425 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004426
4427 return( PSA_SUCCESS );
4428}
4429
Janos Follath81550542019-06-13 14:26:34 +01004430static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004431 const uint8_t *data,
4432 size_t data_length )
4433{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004434 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004435 return( PSA_ERROR_BAD_STATE );
4436
Steven Cooremana6df6042021-04-29 19:32:25 +02004437 if( data_length != 0 )
4438 {
4439 prf->secret = mbedtls_calloc( 1, data_length );
4440 if( prf->secret == NULL )
4441 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4442
4443 memcpy( prf->secret, data, data_length );
4444 prf->secret_length = data_length;
4445 }
Janos Follath81550542019-06-13 14:26:34 +01004446
Gilles Peskine43f958b2020-12-13 14:55:14 +01004447 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004448
4449 return( PSA_SUCCESS );
4450}
4451
Janos Follath63028dd2019-06-13 09:15:47 +01004452static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4453 const uint8_t *data,
4454 size_t data_length )
4455{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004456 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004457 return( PSA_ERROR_BAD_STATE );
4458
Janos Follathd6dce9f2019-07-04 09:11:38 +01004459 if( data_length != 0 )
4460 {
4461 prf->label = mbedtls_calloc( 1, data_length );
4462 if( prf->label == NULL )
4463 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004464
Janos Follathd6dce9f2019-07-04 09:11:38 +01004465 memcpy( prf->label, data, data_length );
4466 prf->label_length = data_length;
4467 }
Janos Follath63028dd2019-06-13 09:15:47 +01004468
Gilles Peskine43f958b2020-12-13 14:55:14 +01004469 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004470
4471 return( PSA_SUCCESS );
4472}
4473
Janos Follathb03233e2019-06-11 15:30:30 +01004474static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004475 psa_key_derivation_step_t step,
4476 const uint8_t *data,
4477 size_t data_length )
4478{
Janos Follathb03233e2019-06-11 15:30:30 +01004479 switch( step )
4480 {
Janos Follathf08e2652019-06-13 09:05:41 +01004481 case PSA_KEY_DERIVATION_INPUT_SEED:
4482 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004483 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004484 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004485 case PSA_KEY_DERIVATION_INPUT_LABEL:
4486 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004487 default:
4488 return( PSA_ERROR_INVALID_ARGUMENT );
4489 }
4490}
John Durkop07cc04a2020-11-16 22:08:34 -08004491#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4492 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4493
4494#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4495static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4496 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004497 const uint8_t *data,
4498 size_t data_length )
4499{
4500 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004501 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004502 uint8_t *cur = pms;
4503
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004504 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004505 return( PSA_ERROR_INVALID_ARGUMENT );
4506
4507 /* Quoting RFC 4279, Section 2:
4508 *
4509 * The premaster secret is formed as follows: if the PSK is N octets
4510 * long, concatenate a uint16 with the value N, N zero octets, a second
4511 * uint16 with the value N, and the PSK itself.
4512 */
4513
4514 *cur++ = ( data_length >> 8 ) & 0xff;
4515 *cur++ = ( data_length >> 0 ) & 0xff;
4516 memset( cur, 0, data_length );
4517 cur += data_length;
4518 *cur++ = pms[0];
4519 *cur++ = pms[1];
4520 memcpy( cur, data, data_length );
4521 cur += data_length;
4522
Steven Cooremana6df6042021-04-29 19:32:25 +02004523 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004524
4525 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4526 return( status );
4527}
Janos Follath6660f0e2019-06-17 08:44:03 +01004528
4529static psa_status_t psa_tls12_prf_psk_to_ms_input(
4530 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004531 psa_key_derivation_step_t step,
4532 const uint8_t *data,
4533 size_t data_length )
4534{
4535 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004536 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004537 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004538 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004539 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004540
Steven Cooremana6df6042021-04-29 19:32:25 +02004541 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004542}
John Durkop07cc04a2020-11-16 22:08:34 -08004543#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004544
Gilles Peskineb8965192019-09-24 16:21:10 +02004545/** Check whether the given key type is acceptable for the given
4546 * input step of a key derivation.
4547 *
4548 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4549 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4550 * Both secret and non-secret inputs can alternatively have the type
4551 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4552 * that the input was passed as a buffer rather than via a key object.
4553 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004554static int psa_key_derivation_check_input_type(
4555 psa_key_derivation_step_t step,
4556 psa_key_type_t key_type )
4557{
4558 switch( step )
4559 {
4560 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004561 if( key_type == PSA_KEY_TYPE_DERIVE )
4562 return( PSA_SUCCESS );
4563 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004564 return( PSA_SUCCESS );
4565 break;
4566 case PSA_KEY_DERIVATION_INPUT_LABEL:
4567 case PSA_KEY_DERIVATION_INPUT_SALT:
4568 case PSA_KEY_DERIVATION_INPUT_INFO:
4569 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004570 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4571 return( PSA_SUCCESS );
4572 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004573 return( PSA_SUCCESS );
4574 break;
4575 }
4576 return( PSA_ERROR_INVALID_ARGUMENT );
4577}
4578
Janos Follathb80a94e2019-06-12 15:54:46 +01004579static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004580 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004581 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004582 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004583 const uint8_t *data,
4584 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004585{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004586 psa_status_t status;
4587 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4588
4589 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004590 if( status != PSA_SUCCESS )
4591 goto exit;
4592
John Durkopd0321952020-10-29 21:37:36 -07004593#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004594 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004595 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004596 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004597 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004598 step, data, data_length );
4599 }
John Durkop07cc04a2020-11-16 22:08:34 -08004600 else
4601#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4602#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4603 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004604 {
Janos Follathb03233e2019-06-11 15:30:30 +01004605 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004606 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004607 }
John Durkop07cc04a2020-11-16 22:08:34 -08004608 else
4609#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4610#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4611 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004612 {
4613 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004614 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004615 }
4616 else
John Durkop07cc04a2020-11-16 22:08:34 -08004617#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004618 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004619 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004620 (void) data;
4621 (void) data_length;
4622 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004623 return( PSA_ERROR_BAD_STATE );
4624 }
4625
Gilles Peskine224b0d62019-09-23 18:13:17 +02004626exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004627 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004628 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004629 return( status );
4630}
4631
Janos Follath51f4a0f2019-06-14 11:35:55 +01004632psa_status_t psa_key_derivation_input_bytes(
4633 psa_key_derivation_operation_t *operation,
4634 psa_key_derivation_step_t step,
4635 const uint8_t *data,
4636 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004637{
Gilles Peskineb8965192019-09-24 16:21:10 +02004638 return( psa_key_derivation_input_internal( operation, step,
4639 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004640 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004641}
4642
Janos Follath51f4a0f2019-06-14 11:35:55 +01004643psa_status_t psa_key_derivation_input_key(
4644 psa_key_derivation_operation_t *operation,
4645 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004646 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004647{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004648 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004649 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004650 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004651
Ronald Cron5c522922020-11-14 16:35:34 +01004652 status = psa_get_and_lock_transparent_key_slot_with_policy(
4653 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004654 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004655 {
4656 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004657 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004658 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004659
4660 /* Passing a key object as a SECRET input unlocks the permission
4661 * to output to a key object. */
4662 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4663 operation->can_output_key = 1;
4664
Ronald Cronf95a2b12020-10-22 15:24:49 +02004665 status = psa_key_derivation_input_internal( operation,
4666 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004667 slot->key.data,
4668 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004669
Ronald Cron5c522922020-11-14 16:35:34 +01004670 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004671
Ronald Cron5c522922020-11-14 16:35:34 +01004672 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004673}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004674
4675
4676
4677/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004678/* Key agreement */
4679/****************************************************************/
4680
John Durkop6ba40d12020-11-10 08:50:04 -08004681#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004682static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4683 size_t peer_key_length,
4684 const mbedtls_ecp_keypair *our_key,
4685 uint8_t *shared_secret,
4686 size_t shared_secret_size,
4687 size_t *shared_secret_length )
4688{
Steven Cooremand4867872020-08-05 16:31:39 +02004689 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004690 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004691 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004692 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004693 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004694 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004695
Ronald Cron90857082020-11-25 14:58:33 +01004696 status = mbedtls_psa_ecp_load_representation(
4697 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004698 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004699 peer_key,
4700 peer_key_length,
4701 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004702 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004703 goto exit;
4704
Jaeden Amero97271b32019-01-10 19:38:51 +00004705 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004706 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004707 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004708 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004709 status = mbedtls_to_psa_error(
4710 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4711 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004712 goto exit;
4713
Jaeden Amero97271b32019-01-10 19:38:51 +00004714 status = mbedtls_to_psa_error(
4715 mbedtls_ecdh_calc_secret( &ecdh,
4716 shared_secret_length,
4717 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004718 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004719 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004720 if( status != PSA_SUCCESS )
4721 goto exit;
4722 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4723 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004724
4725exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004726 if( status != PSA_SUCCESS )
4727 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004728 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004729 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004730 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004731
Jaeden Amero97271b32019-01-10 19:38:51 +00004732 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004733}
John Durkop6ba40d12020-11-10 08:50:04 -08004734#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004735
Gilles Peskine01d718c2018-09-18 12:01:02 +02004736#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4737
Gilles Peskine0216fe12019-04-11 21:23:21 +02004738static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4739 psa_key_slot_t *private_key,
4740 const uint8_t *peer_key,
4741 size_t peer_key_length,
4742 uint8_t *shared_secret,
4743 size_t shared_secret_size,
4744 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004745{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004746 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004747 {
John Durkop6ba40d12020-11-10 08:50:04 -08004748#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004749 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004750 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004751 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004752 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004753 psa_status_t status = mbedtls_psa_ecp_load_representation(
4754 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004755 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004756 private_key->key.data,
4757 private_key->key.bytes,
4758 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004759 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004760 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004761 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004762 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004763 shared_secret, shared_secret_size,
4764 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004765 mbedtls_ecp_keypair_free( ecp );
4766 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004767 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004768#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004769 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004770 (void) private_key;
4771 (void) peer_key;
4772 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004773 (void) shared_secret;
4774 (void) shared_secret_size;
4775 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004776 return( PSA_ERROR_NOT_SUPPORTED );
4777 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004778}
4779
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004780/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004781 * to potentially free embedded data structures and wipe confidential data.
4782 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004783static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004784 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004785 psa_key_slot_t *private_key,
4786 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004787 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004788{
4789 psa_status_t status;
4790 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4791 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004792 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004793
4794 /* Step 1: run the secret agreement algorithm to generate the shared
4795 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004796 status = psa_key_agreement_raw_internal( ka_alg,
4797 private_key,
4798 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004799 shared_secret,
4800 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004801 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004802 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004803 goto exit;
4804
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004805 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004806 * the shared secret. A shared secret is permitted wherever a key
4807 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004808 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004809 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004810 shared_secret,
4811 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004812exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004813 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004814 return( status );
4815}
4816
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004817psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004818 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004819 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004820 const uint8_t *peer_key,
4821 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004822{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004823 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004824 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004825 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004826
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004827 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004828 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004829 status = psa_get_and_lock_transparent_key_slot_with_policy(
4830 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004831 if( status != PSA_SUCCESS )
4832 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004833 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004834 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004835 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004836 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004837 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004838 else
4839 {
4840 /* If a private key has been added as SECRET, we allow the derived
4841 * key material to be used as a key in PSA Crypto. */
4842 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4843 operation->can_output_key = 1;
4844 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004845
Ronald Cron5c522922020-11-14 16:35:34 +01004846 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004847
Ronald Cron5c522922020-11-14 16:35:34 +01004848 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004849}
4850
Gilles Peskinebe697d82019-05-16 18:00:41 +02004851psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004852 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004853 const uint8_t *peer_key,
4854 size_t peer_key_length,
4855 uint8_t *output,
4856 size_t output_size,
4857 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004858{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004859 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004860 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004861 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004862
4863 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4864 {
4865 status = PSA_ERROR_INVALID_ARGUMENT;
4866 goto exit;
4867 }
Ronald Cron5c522922020-11-14 16:35:34 +01004868 status = psa_get_and_lock_transparent_key_slot_with_policy(
4869 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004870 if( status != PSA_SUCCESS )
4871 goto exit;
4872
4873 status = psa_key_agreement_raw_internal( alg, slot,
4874 peer_key, peer_key_length,
4875 output, output_size,
4876 output_length );
4877
4878exit:
4879 if( status != PSA_SUCCESS )
4880 {
4881 /* If an error happens and is not handled properly, the output
4882 * may be used as a key to protect sensitive data. Arrange for such
4883 * a key to be random, which is likely to result in decryption or
4884 * verification errors. This is better than filling the buffer with
4885 * some constant data such as zeros, which would result in the data
4886 * being protected with a reproducible, easily knowable key.
4887 */
4888 psa_generate_random( output, output_size );
4889 *output_length = output_size;
4890 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004891
Ronald Cron5c522922020-11-14 16:35:34 +01004892 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004893
Ronald Cron5c522922020-11-14 16:35:34 +01004894 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004895}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004896
4897
Gilles Peskine30524eb2020-11-13 17:02:26 +01004898
Gilles Peskine86a440b2018-11-12 18:39:40 +01004899/****************************************************************/
4900/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004901/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004902
Gilles Peskine30524eb2020-11-13 17:02:26 +01004903/** Initialize the PSA random generator.
4904 */
4905static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4906{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004907#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4908 memset( rng, 0, sizeof( *rng ) );
4909#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4910
Gilles Peskine30524eb2020-11-13 17:02:26 +01004911 /* Set default configuration if
4912 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4913 if( rng->entropy_init == NULL )
4914 rng->entropy_init = mbedtls_entropy_init;
4915 if( rng->entropy_free == NULL )
4916 rng->entropy_free = mbedtls_entropy_free;
4917
4918 rng->entropy_init( &rng->entropy );
4919#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4920 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4921 /* The PSA entropy injection feature depends on using NV seed as an entropy
4922 * source. Add NV seed as an entropy source for PSA entropy injection. */
4923 mbedtls_entropy_add_source( &rng->entropy,
4924 mbedtls_nv_seed_poll, NULL,
4925 MBEDTLS_ENTROPY_BLOCK_SIZE,
4926 MBEDTLS_ENTROPY_SOURCE_STRONG );
4927#endif
4928
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004929 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004930#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004931}
4932
4933/** Deinitialize the PSA random generator.
4934 */
4935static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4936{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004937#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4938 memset( rng, 0, sizeof( *rng ) );
4939#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004940 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004941 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004942#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004943}
4944
4945/** Seed the PSA random generator.
4946 */
4947static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4948{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004949#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4950 /* Do nothing: the external RNG seeds itself. */
4951 (void) rng;
4952 return( PSA_SUCCESS );
4953#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004954 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004955 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4956 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004957 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004958#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004959}
4960
Gilles Peskinee59236f2018-01-27 23:32:46 +01004961psa_status_t psa_generate_random( uint8_t *output,
4962 size_t output_size )
4963{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004964 GUARD_MODULE_INITIALIZED;
4965
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004966#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4967
4968 size_t output_length = 0;
4969 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4970 output, output_size,
4971 &output_length );
4972 if( status != PSA_SUCCESS )
4973 return( status );
4974 /* Breaking up a request into smaller chunks is currently not supported
4975 * for the extrernal RNG interface. */
4976 if( output_length != output_size )
4977 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4978 return( PSA_SUCCESS );
4979
4980#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4981
Gilles Peskine71ddab92021-01-04 21:01:07 +01004982 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004983 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004984 size_t request_size =
4985 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4986 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4987 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004988 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4989 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004990 if( ret != 0 )
4991 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004992 output_size -= request_size;
4993 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004994 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004995 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004996#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004997}
4998
Gilles Peskine8814fc42020-12-14 15:33:44 +01004999/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005000 *
5001 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5002 * `psa_generate_random(...)`. The state parameter is ignored since the
5003 * PSA API doesn't support passing an explicit state.
5004 *
5005 * In the non-external case, psa_generate_random() calls an
5006 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5007 * and semantics as mbedtls_psa_get_random(). As an optimization,
5008 * instead of doing this back-and-forth between the PSA API and the
5009 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5010 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005011 */
5012#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5013int mbedtls_psa_get_random( void *p_rng,
5014 unsigned char *output,
5015 size_t output_size )
5016{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005017 /* This function takes a pointer to the RNG state because that's what
5018 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5019 * its own state internally and doesn't let the caller access that state.
5020 * So we just ignore the state parameter, and in practice we'll pass
5021 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005022 (void) p_rng;
5023 psa_status_t status = psa_generate_random( output, output_size );
5024 if( status == PSA_SUCCESS )
5025 return( 0 );
5026 else
5027 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5028}
5029#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5030
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005031#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005032#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005033
Gilles Peskine7228da22019-07-15 11:06:15 +02005034psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005035 size_t seed_size )
5036{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005037 if( global_data.initialized )
5038 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005039
5040 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5041 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5042 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5043 return( PSA_ERROR_INVALID_ARGUMENT );
5044
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005045 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005046}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005047#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005048
Ronald Cron3772afe2021-02-08 16:10:05 +01005049/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005050 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005051 * \param type The key type
5052 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005053 *
5054 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005055 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005056 * \retval #PSA_ERROR_INVALID_ARGUMENT
5057 * The size in bits of the key is not valid.
5058 * \retval #PSA_ERROR_NOT_SUPPORTED
5059 * The type and/or the size in bits of the key or the combination of
5060 * the two is not supported.
5061 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005062static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5063 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005064{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005065 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005066
Gilles Peskinee59236f2018-01-27 23:32:46 +01005067 if( key_type_is_raw_bytes( type ) )
5068 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005069 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005070 if( status != PSA_SUCCESS )
5071 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005072 }
5073 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005074#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005075 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5076 {
5077 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5078 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005079
Ronald Cron01b2aba2020-10-05 09:42:02 +02005080 /* Accept only byte-aligned keys, for the same reasons as
5081 * in psa_import_rsa_key(). */
5082 if( bits % 8 != 0 )
5083 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005084 }
5085 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005086#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005087
Ronald Cron5c4d3862020-12-07 11:07:24 +01005088#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005089 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5090 {
Ronald Crond81ab562021-02-16 09:01:16 +01005091 /* To avoid empty block, return successfully here. */
5092 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005093 }
5094 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005095#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005096 {
5097 return( PSA_ERROR_NOT_SUPPORTED );
5098 }
5099
5100 return( PSA_SUCCESS );
5101}
5102
Ronald Cron55ed0592020-10-05 10:30:40 +02005103psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005104 const psa_key_attributes_t *attributes,
5105 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005106{
5107 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005108 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005109
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005110 if( ( attributes->domain_parameters == NULL ) &&
5111 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005112 return( PSA_ERROR_INVALID_ARGUMENT );
5113
Ronald Cron01b2aba2020-10-05 09:42:02 +02005114 if( key_type_is_raw_bytes( type ) )
5115 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005116 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005117 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005118 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005119
David Brown12ca5032021-02-11 11:02:00 -07005120#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005121 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005122 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005123#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005124 }
5125 else
5126
Jaeden Amero424fa932021-05-14 08:34:32 +01005127#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5128 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005129 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005130 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005131 return( mbedtls_psa_rsa_generate_key( attributes,
5132 key_buffer,
5133 key_buffer_size,
5134 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005135 }
5136 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005137#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5138 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005139
John Durkop9814fa22020-11-04 12:28:15 -08005140#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005141 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005142 {
Ronald Cron7023db52020-11-20 18:17:42 +01005143 return( mbedtls_psa_ecp_generate_key( attributes,
5144 key_buffer,
5145 key_buffer_size,
5146 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005147 }
5148 else
John Durkop9814fa22020-11-04 12:28:15 -08005149#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005150 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005151 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005152 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005153 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005154
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005155 return( PSA_SUCCESS );
5156}
Darryl Green0c6575a2018-11-07 16:05:30 +00005157
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005158psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005159 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005160{
5161 psa_status_t status;
5162 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005163 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005164 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005165
Ronald Cron81709fc2020-11-14 12:10:32 +01005166 *key = MBEDTLS_SVC_KEY_ID_INIT;
5167
Gilles Peskine0f84d622019-09-12 19:03:13 +02005168 /* Reject any attempt to create a zero-length key so that we don't
5169 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5170 if( psa_get_key_bits( attributes ) == 0 )
5171 return( PSA_ERROR_INVALID_ARGUMENT );
5172
Ronald Cron81709fc2020-11-14 12:10:32 +01005173 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5174 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005175 if( status != PSA_SUCCESS )
5176 goto exit;
5177
Ronald Cron977c2472020-10-13 08:32:21 +02005178 /* In the case of a transparent key or an opaque key stored in local
5179 * storage (thus not in the case of generating a key in a secure element
5180 * or cryptoprocessor with storage), we have to allocate a buffer to
5181 * hold the generated key material. */
5182 if( slot->key.data == NULL )
5183 {
5184 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5185 PSA_KEY_LOCATION_LOCAL_STORAGE )
5186 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005187 status = psa_validate_key_type_and_size_for_key_generation(
5188 attributes->core.type, attributes->core.bits );
5189 if( status != PSA_SUCCESS )
5190 goto exit;
5191
5192 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5193 attributes->core.type,
5194 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005195 }
5196 else
5197 {
5198 status = psa_driver_wrapper_get_key_buffer_size(
5199 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005200 if( status != PSA_SUCCESS )
5201 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005202 }
Ronald Cron977c2472020-10-13 08:32:21 +02005203
5204 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5205 if( status != PSA_SUCCESS )
5206 goto exit;
5207 }
5208
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005209 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005210 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005211
Ronald Cron2b56bc82020-10-05 10:02:26 +02005212 if( status != PSA_SUCCESS )
5213 psa_remove_key_data_from_memory( slot );
5214
Gilles Peskine11792082019-08-06 18:36:36 +02005215exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005216 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005217 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005218 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005219 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005220
Darryl Green0c6575a2018-11-07 16:05:30 +00005221 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005222}
5223
Gilles Peskinee59236f2018-01-27 23:32:46 +01005224/****************************************************************/
5225/* Module setup */
5226/****************************************************************/
5227
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005228#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005229psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5230 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5231 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5232{
5233 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5234 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005235 global_data.rng.entropy_init = entropy_init;
5236 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005237 return( PSA_SUCCESS );
5238}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005239#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005240
Gilles Peskinee59236f2018-01-27 23:32:46 +01005241void mbedtls_psa_crypto_free( void )
5242{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005243 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005244 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5245 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005246 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005247 }
5248 /* Wipe all remaining data, including configuration.
5249 * In particular, this sets all state indicator to the value
5250 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005251 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005253 /* Unregister all secure element drivers, so that we restart from
5254 * a pristine state. */
5255 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005256#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005257}
5258
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005259#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5260/** Recover a transaction that was interrupted by a power failure.
5261 *
5262 * This function is called during initialization, before psa_crypto_init()
5263 * returns. If this function returns a failure status, the initialization
5264 * fails.
5265 */
5266static psa_status_t psa_crypto_recover_transaction(
5267 const psa_crypto_transaction_t *transaction )
5268{
5269 switch( transaction->unknown.type )
5270 {
5271 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5272 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005273 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005274 * is implemented.
5275 * https://github.com/ARMmbed/mbed-crypto/issues/218
5276 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005277 default:
5278 /* We found an unsupported transaction in the storage.
5279 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005280 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005281 }
5282}
5283#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5284
Gilles Peskinee59236f2018-01-27 23:32:46 +01005285psa_status_t psa_crypto_init( void )
5286{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005287 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005288
Gilles Peskinec6b69072018-11-20 21:42:52 +01005289 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005290 if( global_data.initialized != 0 )
5291 return( PSA_SUCCESS );
5292
Gilles Peskine30524eb2020-11-13 17:02:26 +01005293 /* Initialize and seed the random generator. */
5294 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005295 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005296 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005297 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005298 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005299 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005300
Gilles Peskine66fb1262018-12-10 16:29:04 +01005301 status = psa_initialize_key_slots( );
5302 if( status != PSA_SUCCESS )
5303 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005304
Gilles Peskined9348f22019-10-01 15:22:29 +02005305#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5306 status = psa_init_all_se_drivers( );
5307 if( status != PSA_SUCCESS )
5308 goto exit;
5309#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5310
Gilles Peskine4b734222019-07-24 15:56:31 +02005311#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005312 status = psa_crypto_load_transaction( );
5313 if( status == PSA_SUCCESS )
5314 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005315 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5316 if( status != PSA_SUCCESS )
5317 goto exit;
5318 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005319 }
5320 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5321 {
5322 /* There's no transaction to complete. It's all good. */
5323 status = PSA_SUCCESS;
5324 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005325#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005326
Gilles Peskinec6b69072018-11-20 21:42:52 +01005327 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005328 global_data.initialized = 1;
5329
5330exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005331 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005332 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005333 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005334}
5335
5336#endif /* MBEDTLS_PSA_CRYPTO_C */